3.0.0: Improve object encoding and decoding

.gitignore

@@ -11,6 +11,7 @@ dist/esm/*
 .vscode/*
 !.vscode/settings.json
 !.vscode/extensions.json
+!.vscode/launch.json
 
 # npm
 node_modules/

.test-env

@@ -1,6 +1,6 @@
 # Configs for testing repo download:
 SDK_TESTING_URL="https://github.com/algorand/algorand-sdk-testing"
-SDK_TESTING_BRANCH="V2"
+SDK_TESTING_BRANCH="fix-mock-response-txn-encoding-types"
 SDK_TESTING_HARNESS="test-harness"
 
 INSTALL_ONLY=0

.vscode/launch.json

@@ -0,0 +1,27 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug unit tests",
+      "type": "node",
+      "request": "launch",
+      "program": "${workspaceRoot}/tests/mocha.js",
+      "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/tsx",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "env": {
+        "NODE_ENV": "testing",
+        "MOCHA_TIMEOUT": "0"
+      },
+      "skipFiles": [
+        // Node.js internal core modules
+        "<node_internals>/**",
+        // Ignore all dependencies (optional)
+        "${workspaceFolder}/node_modules/**"
+      ]
+    }
+  ]
+}

examples/debug.ts

@@ -43,7 +43,7 @@ async function main() {
     txns: signedTxns,
   });
 
-  console.log('Dryrun:', dryrunRequest.get_obj_for_encoding());
+  console.log('Dryrun:', dryrunRequest);
   // example: DEBUG_DRYRUN_DUMP
 
   // example: DEBUG_DRYRUN_SUBMIT

examples/participation.ts

@@ -42,7 +42,7 @@ async function main() {
       suggestedParams: params,
     });
 
-  console.log(onlineKeyreg.get_obj_for_encoding());
+  console.log(onlineKeyreg);
   // example: TRANSACTION_KEYREG_ONLINE_CREATE
 
   // example: TRANSACTION_KEYREG_OFFLINE_CREATE
@@ -55,7 +55,7 @@ async function main() {
       suggestedParams,
       nonParticipation: true,
     });
-  console.log(offlineKeyReg.get_obj_for_encoding());
+  console.log(offlineKeyReg);
   // example: TRANSACTION_KEYREG_OFFLINE_CREATE
 }
 

package.json

@@ -48,7 +48,7 @@
     "url": "git://github.com/algorand/js-algorand-sdk.git"
   },
   "dependencies": {
-    "algo-msgpack-with-bigint": "^2.1.1",
+    "algorand-msgpack": "^1.0.1",
     "hi-base32": "^0.5.1",
     "js-sha256": "^0.9.0",
     "js-sha3": "^0.8.0",

src/boxStorage.ts

@@ -1,11 +1,10 @@
-import { EncodedBoxReference } from './types/transactions/index.js';
 import { BoxReference } from './types/transactions/base.js';
 
-function translateBoxReference(
+function boxReferenceToEncodingData(
   reference: BoxReference,
   foreignApps: bigint[],
   appIndex: bigint
-): EncodedBoxReference {
+): Map<string, unknown> {
   const referenceId = BigInt(reference.appIndex);
   const referenceName = reference.name;
   const isOwnReference = referenceId === BigInt(0) || referenceId === appIndex;
@@ -22,28 +21,24 @@ function translateBoxReference(
     throw new Error(`Box ref with appId ${referenceId} not in foreign-apps`);
   }
 
-  const encodedReference: EncodedBoxReference = {};
-  if (index !== 0) {
-    encodedReference.i = index;
-  }
-  if (referenceName.length) {
-    encodedReference.n = referenceName;
-  }
-  return encodedReference;
+  return new Map<string, number | Uint8Array>([
+    ['i', index],
+    ['n', referenceName],
+  ]);
 }
 
 /**
  * translateBoxReferences translates an array of BoxReferences with app IDs
  * into an array of EncodedBoxReferences with foreign indices.
  */
-export function translateBoxReferences(
+export function boxReferencesToEncodingData(
   references: ReadonlyArray<BoxReference>,
   foreignApps: ReadonlyArray<number | bigint>,
   appIndex: number | bigint
-): EncodedBoxReference[] {
+): Array<Map<string, unknown>> {
   const appIndexBigInt = BigInt(appIndex);
   const foreignAppsBigInt = foreignApps.map(BigInt);
   return references.map((bx) =>
-    translateBoxReference(bx, foreignAppsBigInt, appIndexBigInt)
+    boxReferenceToEncodingData(bx, foreignAppsBigInt, appIndexBigInt)
   );
 }

src/client/index.ts

@@ -1,6 +1,5 @@
 // Generics
 export { default as JSONRequest } from './v2/jsonrequest.js';
-export { default as BaseModel } from './v2/basemodel.js';
 export { default as ServiceClient } from './v2/serviceClient.js';
 export * from './baseHTTPClient.js';
 export * from './urlTokenBaseHTTPClient.js';

src/client/v2/algod/accountApplicationInformation.ts

@@ -24,6 +24,8 @@ export default class AccountApplicationInformation extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): AccountApplicationResponse {
-    return AccountApplicationResponse.from_obj_for_encoding(body);
+    return AccountApplicationResponse.fromEncodingData(
+      AccountApplicationResponse.encodingSchema.fromPreparedJSON(body)
+    );
   }
 }

src/client/v2/algod/accountAssetInformation.ts

@@ -24,6 +24,8 @@ export default class AccountAssetInformation extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): AccountAssetResponse {
-    return AccountAssetResponse.from_obj_for_encoding(body);
+    return AccountAssetResponse.fromEncodingData(
+      AccountAssetResponse.encodingSchema.fromPreparedJSON(body)
+    );
   }
 }

src/client/v2/algod/accountInformation.ts

@@ -39,6 +39,8 @@ export default class AccountInformation extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): Account {
-    return Account.from_obj_for_encoding(body);
+    return Account.fromEncodingData(
+      Account.encodingSchema.fromPreparedJSON(body)
+    );
   }
 }

src/client/v2/algod/algod.ts

@@ -37,7 +37,7 @@ import SetBlockOffsetTimestamp from './setBlockOffsetTimestamp.js';
 import GetBlockOffsetTimestamp from './getBlockOffsetTimestamp.js';
 import Disassemble from './disassemble.js';
 import SimulateRawTransactions from './simulateTransaction.js';
-import { EncodedSignedTransaction } from '../../../types/transactions/index.js';
+import { SignedTransaction } from '../../../signedTransaction.js';
 import * as encoding from '../../../encoding/encoding.js';
 import Ready from './ready.js';
 import UnsetSyncRound from './unsetSyncRound.js';
@@ -614,13 +614,13 @@ export class AlgodClient extends ServiceClient {
    * @category POST
    */
   simulateRawTransactions(stxOrStxs: Uint8Array | Uint8Array[]) {
-    const txnObjects: EncodedSignedTransaction[] = [];
+    const txnObjects: SignedTransaction[] = [];
     if (Array.isArray(stxOrStxs)) {
       for (const stxn of stxOrStxs) {
-        txnObjects.push(encoding.decode(stxn) as EncodedSignedTransaction);
+        txnObjects.push(encoding.decodeMsgpack(stxn, SignedTransaction));
       }
     } else {
-      txnObjects.push(encoding.decode(stxOrStxs) as EncodedSignedTransaction);
+      txnObjects.push(encoding.decodeMsgpack(stxOrStxs, SignedTransaction));
     }
     const request = new modelsv2.SimulateRequest({
       txnGroups: [

src/client/v2/algod/block.ts

@@ -21,8 +21,6 @@ export default class Block extends JSONRequest<BlockResponse, Uint8Array> {
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Uint8Array): BlockResponse {
-    return BlockResponse.from_obj_for_encoding(
-      encoding.decode(body) as Record<string, any>
-    );
+    return encoding.decodeMsgpack(body, BlockResponse);
   }
 }

src/client/v2/algod/compile.ts

@@ -60,6 +60,8 @@ export default class Compile extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): CompileResponse {
-    return CompileResponse.from_obj_for_encoding(body);
+    return CompileResponse.fromEncodingData(
+      CompileResponse.encodingSchema.fromPreparedJSON(body)
+    );
   }
 }

src/client/v2/algod/disassemble.ts

@@ -55,6 +55,8 @@ export default class Disassemble extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): DisassembleResponse {
-    return DisassembleResponse.from_obj_for_encoding(body);
+    return DisassembleResponse.fromEncodingData(
+      DisassembleResponse.encodingSchema.fromPreparedJSON(body)
+    );
   }
 }

src/client/v2/algod/dryrun.ts

@@ -14,7 +14,7 @@ export default class Dryrun extends JSONRequest<
 
   constructor(c: HTTPClient, dr: modelsv2.DryrunRequest) {
     super(c);
-    this.blob = encoding.encode(dr.get_obj_for_encoding(true, true)!);
+    this.blob = encoding.encodeMsgpack(dr);
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -40,6 +40,8 @@ export default class Dryrun extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): DryrunResponse {
-    return DryrunResponse.from_obj_for_encoding(body);
+    return DryrunResponse.fromEncodingData(
+      DryrunResponse.encodingSchema.fromPreparedJSON(body)
+    );
   }
 }

src/client/v2/algod/getApplicationBoxByName.ts

@@ -42,6 +42,6 @@ export default class GetApplicationBoxByName extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): Box {
-    return Box.from_obj_for_encoding(body);
+    return Box.fromEncodingData(Box.encodingSchema.fromPreparedJSON(body));
   }
 }

src/client/v2/algod/getApplicationBoxes.ts

@@ -57,6 +57,8 @@ export default class GetApplicationBoxes extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): BoxesResponse {
-    return BoxesResponse.from_obj_for_encoding(body);
+    return BoxesResponse.fromEncodingData(
+      BoxesResponse.encodingSchema.fromPreparedJSON(body)
+    );
   }
 }

src/client/v2/algod/getApplicationByID.ts

@@ -19,6 +19,8 @@ export default class GetApplicationByID extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): Application {
-    return Application.from_obj_for_encoding(body);
+    return Application.fromEncodingData(
+      Application.encodingSchema.fromPreparedJSON(body)
+    );
   }
 }

src/client/v2/algod/getAssetByID.ts

@@ -19,6 +19,6 @@ export default class GetAssetByID extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): Asset {
-    return Asset.from_obj_for_encoding(body);
+    return Asset.fromEncodingData(Asset.encodingSchema.fromPreparedJSON(body));
   }
 }

src/client/v2/algod/getBlockHash.ts

@@ -19,6 +19,8 @@ export default class GetBlockHash extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): BlockHashResponse {
-    return BlockHashResponse.from_obj_for_encoding(body);
+    return BlockHashResponse.fromEncodingData(
+      BlockHashResponse.encodingSchema.fromPreparedJSON(body)
+    );
   }
 }

src/client/v2/algod/getBlockOffsetTimestamp.ts

@@ -12,6 +12,8 @@ export default class GetBlockOffsetTimestamp extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): GetBlockTimeStampOffsetResponse {
-    return GetBlockTimeStampOffsetResponse.from_obj_for_encoding(body);
+    return GetBlockTimeStampOffsetResponse.fromEncodingData(
+      GetBlockTimeStampOffsetResponse.encodingSchema.fromPreparedJSON(body)
+    );
   }
 }

src/client/v2/algod/getSyncRound.ts

@@ -12,6 +12,8 @@ export default class GetSyncRound extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): GetSyncRoundResponse {
-    return GetSyncRoundResponse.from_obj_for_encoding(body);
+    return GetSyncRoundResponse.fromEncodingData(
+      GetSyncRoundResponse.encodingSchema.fromPreparedJSON(body)
+    );
   }
 }

src/client/v2/algod/getTransactionGroupLedgerStateDeltasForRound.ts

@@ -23,8 +23,10 @@ export default class GetTransactionGroupLedgerStateDeltasForRound extends JSONRe
   prepare(
     body: Record<string, any>
   ): TransactionGroupLedgerStateDeltasForRoundResponse {
-    return TransactionGroupLedgerStateDeltasForRoundResponse.from_obj_for_encoding(
-      body
+    return TransactionGroupLedgerStateDeltasForRoundResponse.fromEncodingData(
+      TransactionGroupLedgerStateDeltasForRoundResponse.encodingSchema.fromPreparedJSON(
+        body
+      )
     );
   }
 }

src/client/v2/algod/getTransactionProof.ts

@@ -42,6 +42,8 @@ export default class GetTransactionProof extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): TransactionProofResponse {
-    return TransactionProofResponse.from_obj_for_encoding(body);
+    return TransactionProofResponse.fromEncodingData(
+      TransactionProofResponse.encodingSchema.fromPreparedJSON(body)
+    );
   }
 }

src/client/v2/algod/lightBlockHeaderProof.ts

@@ -19,6 +19,6 @@ export default class LightBlockHeaderProof extends JSONRequest<
 
   // eslint-disable-next-line class-methods-use-this
   prepare(body: Record<string, any>): LBHP {
-    return LBHP.from_obj_for_encoding(body);
+    return LBHP.fromEncodingData(LBHP.encodingSchema.fromPreparedJSON(body));
   }
 }