fix: add and adjust various transaction typings (#107)

Author: rigwild

__tests__/resources/transactions.test.ts

@@ -11,7 +11,7 @@ describe("API - 2.0 - Resources - Transactions", () => {
 	});
 
 	it("should call \"create\" method", async () => {
-		const response = await resource.create([]);
+		const response = await resource.create({ transactions: [] });
 
 		expect(response.status).toBe(200);
 	});

src/connection.ts

@@ -14,7 +14,8 @@ export class Connection {
 	}
 
 	public api<T extends AvailableResourcesName>(name: T) {
-		const selectedResourceClass = Resources[name];
+		// Convert to lower case to be backward-compatible
+		const selectedResourceClass = Resources[name.toLowerCase() as AvailableResourcesName];
 		return new selectedResourceClass(this) as AvailableResource<T>;
 	}
 
@@ -35,10 +36,6 @@ export class Connection {
 	private async sendRequest<T>(method: string, url: string, opts?: Record<string, any>): Promise<IResponse<T>> {
 		opts = { ...this.opts, ...(opts || {}) };
 
-		if (opts.body && typeof opts !== "string") {
-			opts.body = JSON.stringify(opts.body);
-		}
-
 		// Do not retry unless explicitly stated.
 		if (!opts.retry) {
 			opts.retry = { retries: 0 };
@@ -49,7 +46,7 @@ export class Connection {
 		}
 
 		try {
-			const response = await ky(`${this.host}/${url}`, { ...opts, method });
+			const response = await ky(`${this.host}/${url}`, { ...opts, method, json: opts.body });
 
 			return {
 				body: await response.json(),

src/interfaces.ts

@@ -4,7 +4,7 @@ export interface IResponse<T> {
 	status: number;
 }
 
-export type DataResponse<T> = { data: T };
+export type DataResponse<T> = { data: T; errors: any };
 export interface PaginableResponse {
 	meta: {
 		count: number;

src/resources/index.ts

@@ -12,17 +12,17 @@ import { Wallets } from "./wallets";
 
 // tslint:disable-next-line: variable-name
 export const Resources = {
-	Blocks,
-	Bridgechains,
-	Businesses,
-	Delegates,
-	Locks,
-	Node,
-	Peers,
-	Rounds,
-	Transactions,
-	Votes,
-	Wallets,
+	blocks: Blocks,
+	bridgechains: Bridgechains,
+	businesses: Businesses,
+	delegates: Delegates,
+	locks: Locks,
+	node: Node,
+	peers: Peers,
+	rounds: Rounds,
+	transactions: Transactions,
+	votes: Votes,
+	wallets: Wallets,
 };
 
 export type AvailableResourcesName = keyof typeof Resources;

src/resources/transactions.ts

@@ -31,7 +31,9 @@ export class Transactions extends Resource {
 	 *
 	 * @param payload The list of transactions to create.
 	 */
-	public async create(payload: object[]): Promise<ApiResponse<CreateTransactionApiResponse> & { errors?: any }> {
+	public async create(
+		payload: { transactions: object[] } & Record<string, any>,
+	): Promise<ApiResponse<CreateTransactionApiResponse> & { errors?: any }> {
 		return this.sendPost("transactions", payload);
 	}
 

src/resourcesTypes/transactions.ts

@@ -11,7 +11,7 @@ export interface Transaction {
 	sender: string;
 	senderPublicKey: string;
 	recipient: string;
-	asset?: Record<string, any>;
+	asset?: TransactionAssets;
 	signature: string;
 	signSignature?: string;
 	vendorField?: string;
@@ -24,6 +24,35 @@ export interface Transaction {
 	nonce: string;
 }
 
+export type TransactionAssets = {
+	ipfs?: string;
+	votes?: string[];
+	delegate?: {
+		username: string;
+	};
+	signature?: {
+		publicKey: string;
+	};
+	multiSignature?: {
+		publicKeys: string[];
+		min: string;
+	};
+	lock?: {
+		secretHash: string;
+		expiration: {
+			type: number;
+			value: number;
+		};
+	};
+	claim?: {
+		lockTransactionId: string;
+		unlockSecret: string;
+	};
+	refund?: {
+		lockTransactionId: string;
+	};
+} & Record<string, any>;
+
 export interface CreateTransactionApiResponse {
 	accept: string[];
 	broadcast: string[];
@@ -94,11 +123,16 @@ export interface SearchTransactionsApiBody extends ApiBody {
 	blockId?: string;
 	type?: number;
 	version?: number;
+	network?: number;
 	senderPublicKey?: string;
 	senderId?: string;
 	recipientId?: string;
 	ownerId?: string;
 	vendorFieldHex?: string;
+	asset?: TransactionAssets;
+	signature?: string;
+	signatures?: string[];
+	MultiSignatureAddress?: string;
 	timestamp?: {
 		from?: number;
 		to?: number;