Typed indexer responses (#857)

Author: jasonpaulos

examples/indexer.ts

@@ -39,7 +39,7 @@ async function main() {
   // example: INDEXER_SEARCH_MIN_AMOUNT
 
   // example: INDEXER_PAGINATE_RESULTS
-  let nextToken = '';
+  let nextToken: string | undefined = '';
 
   // nextToken will be undefined if we reached the last page
   while (nextToken !== undefined) {
@@ -51,7 +51,7 @@ async function main() {
       .nextToken(nextToken)
       .do();
 
-    nextToken = response['next-token'];
+    nextToken = response.nextToken;
     const txns = response.transactions;
     if (txns.length > 0)
       console.log(`Transaction IDs: ${response.transactions.map((t) => t.id)}`);

examples/utils.ts

@@ -54,7 +54,7 @@ export async function indexerWaitForRound(
   round: number | bigint,
   maxAttempts: number
 ) {
-  let indexerRound = 0;
+  let indexerRound = BigInt(0);
   let attempts = 0;
 
   for (;;) {

src/client/v2/algod/compile.ts

@@ -55,7 +55,7 @@ export default class Compile extends JSONRequest<
       query: this.query,
       requestHeaders: txHeaders,
     });
-    return res.body;
+    return this.prepare(res.body);
   }
 
   // eslint-disable-next-line class-methods-use-this

src/client/v2/algod/getBlockTxids.ts

@@ -1,7 +1,11 @@
 import JSONRequest from '../jsonrequest.js';
 import { HTTPClient } from '../../client.js';
+import { BlockTxidsResponse } from './models/types.js';
 
-export default class GetBlockTxids extends JSONRequest {
+export default class GetBlockTxids extends JSONRequest<
+  BlockTxidsResponse,
+  Record<string, any>
+> {
   round: number;
 
   constructor(c: HTTPClient, roundNumber: number) {
@@ -14,4 +18,11 @@ export default class GetBlockTxids extends JSONRequest {
   path() {
     return `/v2/blocks/${this.round}/txids`;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(body: Record<string, any>): BlockTxidsResponse {
+    return BlockTxidsResponse.fromEncodingData(
+      BlockTxidsResponse.encodingSchema.fromPreparedJSON(body)
+    );
+  }
 }

src/client/v2/algod/suggestedParams.ts

@@ -17,6 +17,11 @@ export interface SuggestedParamsFromAlgod extends SuggestedParams {
   lastValid: bigint;
   genesisID: string;
   genesisHash: Uint8Array;
+
+  /**
+   * ConsensusVersion indicates the consensus protocol version as of the last round.
+   */
+  consensusVersion: string;
 }
 
 /**
@@ -40,6 +45,7 @@ export default class SuggestedParamsRequest extends JSONRequest<
       genesisID: body['genesis-id'],
       genesisHash: base64ToBytes(body['genesis-hash']),
       minFee: BigInt(body['min-fee']),
+      consensusVersion: body['consensus-version'],
     };
   }
   /* eslint-enable class-methods-use-this */

src/client/v2/indexer/lookupAccountAppLocalStates.ts

@@ -1,8 +1,12 @@
 import JSONRequest from '../jsonrequest.js';
 import { HTTPClient } from '../../client.js';
 import { Address } from '../../../encoding/address.js';
+import { ApplicationLocalStatesResponse } from './models/types.js';
 
-export default class LookupAccountAppLocalStates extends JSONRequest {
+export default class LookupAccountAppLocalStates extends JSONRequest<
+  ApplicationLocalStatesResponse,
+  Record<string, any>
+> {
   private account: string | Address;
 
   /**
@@ -135,4 +139,11 @@ export default class LookupAccountAppLocalStates extends JSONRequest {
     this.query['application-id'] = index;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(body: Record<string, any>): ApplicationLocalStatesResponse {
+    return ApplicationLocalStatesResponse.fromEncodingData(
+      ApplicationLocalStatesResponse.encodingSchema.fromPreparedJSON(body)
+    );
+  }
 }

src/client/v2/indexer/lookupAccountAssets.ts

@@ -1,8 +1,12 @@
 import JSONRequest from '../jsonrequest.js';
 import { HTTPClient } from '../../client.js';
 import { Address } from '../../../encoding/address.js';
+import { AssetHoldingsResponse } from './models/types.js';
 
-export default class LookupAccountAssets extends JSONRequest {
+export default class LookupAccountAssets extends JSONRequest<
+  AssetHoldingsResponse,
+  Record<string, any>
+> {
   private account: string;
 
   /**
@@ -136,4 +140,11 @@ export default class LookupAccountAssets extends JSONRequest {
     this.query['asset-id'] = index;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(body: Record<string, any>): AssetHoldingsResponse {
+    return AssetHoldingsResponse.fromEncodingData(
+      AssetHoldingsResponse.encodingSchema.fromPreparedJSON(body)
+    );
+  }
 }

src/client/v2/indexer/lookupAccountByID.ts

@@ -1,8 +1,12 @@
 import JSONRequest from '../jsonrequest.js';
 import { HTTPClient } from '../../client.js';
 import { Address } from '../../../encoding/address.js';
+import { AccountResponse } from './models/types.js';
 
-export default class LookupAccountByID extends JSONRequest {
+export default class LookupAccountByID extends JSONRequest<
+  AccountResponse,
+  Record<string, any>
+> {
   private account: string;
 
   /**
@@ -104,4 +108,11 @@ export default class LookupAccountByID extends JSONRequest {
     this.query.exclude = exclude;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(body: Record<string, any>): AccountResponse {
+    return AccountResponse.fromEncodingData(
+      AccountResponse.encodingSchema.fromPreparedJSON(body)
+    );
+  }
 }

src/client/v2/indexer/lookupAccountCreatedApplications.ts

@@ -1,8 +1,12 @@
 import JSONRequest from '../jsonrequest.js';
 import { HTTPClient } from '../../client.js';
 import { Address } from '../../../encoding/address.js';
+import { ApplicationsResponse } from './models/types.js';
 
-export default class LookupAccountCreatedApplications extends JSONRequest {
+export default class LookupAccountCreatedApplications extends JSONRequest<
+  ApplicationsResponse,
+  Record<string, any>
+> {
   private account: string;
 
   /**
@@ -136,4 +140,11 @@ export default class LookupAccountCreatedApplications extends JSONRequest {
     this.query['application-id'] = index;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(body: Record<string, any>): ApplicationsResponse {
+    return ApplicationsResponse.fromEncodingData(
+      ApplicationsResponse.encodingSchema.fromPreparedJSON(body)
+    );
+  }
 }

src/client/v2/indexer/lookupAccountCreatedAssets.ts

@@ -1,8 +1,12 @@
 import JSONRequest from '../jsonrequest.js';
 import { HTTPClient } from '../../client.js';
 import { Address } from '../../../encoding/address.js';
+import { AssetsResponse } from './models/types.js';
 
-export default class LookupAccountCreatedAssets extends JSONRequest {
+export default class LookupAccountCreatedAssets extends JSONRequest<
+  AssetsResponse,
+  Record<string, any>
+> {
   private account: string;
 
   /**
@@ -137,4 +141,11 @@ export default class LookupAccountCreatedAssets extends JSONRequest {
     this.query['asset-id'] = index;
     return this;
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  prepare(body: Record<string, any>): AssetsResponse {
+    return AssetsResponse.fromEncodingData(
+      AssetsResponse.encodingSchema.fromPreparedJSON(body)
+    );
+  }
 }