3.0.0: Refactor Transaction class (#854)

.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2.1
 orbs:
   node: circleci/[email protected]
   slack: circleci/[email protected]
-  browser-tools: circleci/[email protected].3
+  browser-tools: circleci/[email protected].6
   gh-pages: sugarshin/[email protected]
 
 parameters:
@@ -89,7 +89,8 @@ jobs:
               $(lsb_release -cs) stable" | $SUDO tee /etc/apt/sources.list.d/docker.list > /dev/null
             $SUDO apt update
             $SUDO apt -y install docker-ce docker-ce-cli containerd.io
-      - browser-tools/install-browser-tools
+      - browser-tools/install-browser-tools:
+          replace-existing-chrome: true
       - run:
           name: << parameters.browser >> test
           command: |

examples/accounts.ts

@@ -19,7 +19,7 @@ async function main() {
   const mnemonic =
     'creek phrase island true then hope employ veteran rapid hurdle above liberty tissue connect alcohol timber idle ten frog bulb embody crunch taxi abstract month';
   const recoveredAccount = algosdk.mnemonicToSecretKey(mnemonic);
-  console.log('Recovered mnemonic account: ', recoveredAccount.addr);
+  console.log('Recovered mnemonic account: ', recoveredAccount.addr.toString());
   // example: ACCOUNT_RECOVER_MNEMONIC
 
   const funder = accounts[0];
@@ -31,14 +31,14 @@ async function main() {
   signerAccounts.push(algosdk.generateAccount());
 
   // multiSigParams is used when creating the address and when signing transactions
-  const multiSigParams = {
+  const multiSigParams: algosdk.MultisigMetadata = {
     version: 1,
     threshold: 2,
     addrs: signerAccounts.map((a) => a.addr),
   };
   const multisigAddr = algosdk.multisigAddress(multiSigParams);
 
-  console.log('Created MultiSig Address: ', multisigAddr);
+  console.log('Created MultiSig Address: ', multisigAddr.toString());
   // example: MULTISIG_CREATE
 
   const fundMsigTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
@@ -80,7 +80,7 @@ async function main() {
   // example: ACCOUNT_GENERATE
   const generatedAccount = algosdk.generateAccount();
   const passphrase = algosdk.secretKeyToMnemonic(generatedAccount.sk);
-  console.log(`My address: ${generatedAccount.addr}`);
+  console.log(`My address: ${generatedAccount.addr.toString()}`);
   console.log(`My passphrase: ${passphrase}`);
   // example: ACCOUNT_GENERATE
 
@@ -117,7 +117,7 @@ async function main() {
     rekeyTo: acct1.addr,
   });
   await client.sendRawTransaction(rekeyBack.signTxn(acct2.privateKey)).do();
-  await algosdk.waitForConfirmation(client, rekeyBack.txID().toString(), 3);
+  await algosdk.waitForConfirmation(client, rekeyBack.txID(), 3);
 }
 
 main();

examples/asa.ts

@@ -114,8 +114,8 @@ async function main() {
     sender: manager.addr,
     suggestedParams,
     assetIndex,
-    // assetFrozen: false would unfreeze the account's asset holding
-    assetFrozen: true,
+    // frozen: false would unfreeze the account's asset holding
+    frozen: true,
     // freezeTarget is the account that is being frozen or unfrozen
     freezeTarget: receiver.addr,
   });

examples/atomics.ts

@@ -51,13 +51,12 @@ async function main() {
   // example: ATOMIC_GROUP_SEND
 
   // example: CONST_MIN_FEE
-  const minFee = algosdk.ALGORAND_MIN_TX_FEE;
-  console.log(minFee);
+  // This SDK does not expose a constant for the minimum fee
   // example: CONST_MIN_FEE
 
   // example: TRANSACTION_FEE_OVERRIDE
   const sp = await client.getTransactionParams().do();
-  sp.fee = 2 * minFee;
+  sp.fee = BigInt(2) * sp.minFee;
   sp.flatFee = true;
   // example: TRANSACTION_FEE_OVERRIDE
 

examples/codec.ts

@@ -14,8 +14,7 @@ async function main() {
 
   // example: CODEC_ADDRESS
   const address = '4H5UNRBJ2Q6JENAXQ6HNTGKLKINP4J4VTQBEPK5F3I6RDICMZBPGNH6KD4';
-  const pk = algosdk.decodeAddress(address);
-  const addr = algosdk.encodeAddress(pk.publicKey);
+  const addr = algosdk.Address.fromString(address);
   console.log(address, addr);
   // example: CODEC_ADDRESS
 

examples/kmd.ts

@@ -56,7 +56,7 @@ async function main() {
 
   // example: KMD_IMPORT_ACCOUNT
   const newAccount = algosdk.generateAccount();
-  console.log('Account: ', newAccount.addr);
+  console.log('Account: ', newAccount.addr.toString());
   const importedAccount = await kmdClient.importKey(
     wallethandle,
     newAccount.sk

examples/participation.ts

@@ -11,18 +11,23 @@ async function main() {
   // Parent addr
   const addr = 'MWAPNXBDFFD2V5KWXAHWKBO7FO4JN36VR4CIBDKDDE7WAUAGZIXM3QPJW4';
   // VRF public key
-  const selectionKey = 'LrpLhvzr+QpN/bivh6IPpOaKGbGzTTB5lJtVfixmmgk=';
+  const selectionKey = algosdk.base64ToBytes(
+    'LrpLhvzr+QpN/bivh6IPpOaKGbGzTTB5lJtVfixmmgk='
+  );
   // Voting pub key
-  const voteKey = 'G/lqTV6MKspW6J8wH2d8ZliZ5XZVZsruqSBJMwLwlmo=';
+  const voteKey = algosdk.base64ToBytes(
+    'G/lqTV6MKspW6J8wH2d8ZliZ5XZVZsruqSBJMwLwlmo='
+  );
   // State proof key
-  const stateProofKey =
-    'RpUpNWfZMjZ1zOOjv3MF2tjO714jsBt0GKnNsw0ihJ4HSZwci+d9zvUi3i67LwFUJgjQ5Dz4zZgHgGduElnmSA==';
+  const stateProofKey = algosdk.base64ToBytes(
+    'RpUpNWfZMjZ1zOOjv3MF2tjO714jsBt0GKnNsw0ihJ4HSZwci+d9zvUi3i67LwFUJgjQ5Dz4zZgHgGduElnmSA=='
+  );
 
-  // sets up keys for 100000 rounds
-  const numRounds = 1e5;
+  // sets up keys for 100,000 rounds
+  const numRounds = 100_000;
 
   // dilution default is sqrt num rounds
-  const keyDilution = numRounds ** 0.5;
+  const keyDilution = Math.floor(Math.sqrt(numRounds));
 
   // create transaction
   const onlineKeyreg =
@@ -32,7 +37,7 @@ async function main() {
       selectionKey,
       stateProofKey,
       voteFirst: params.firstValid,
-      voteLast: params.firstValid + numRounds,
+      voteLast: params.firstValid + BigInt(numRounds),
       voteKeyDilution: keyDilution,
       suggestedParams: params,
     });

examples/utils.ts

@@ -45,7 +45,7 @@ export function getLocalAlgodClient() {
 }
 
 export interface SandboxAccount {
-  addr: string;
+  addr: algosdk.Address;
   privateKey: Uint8Array;
   signer: algosdk.TransactionSigner;
 }
@@ -81,8 +81,8 @@ export async function getLocalAccounts(): Promise<SandboxAccount[]> {
   kmdClient.releaseWalletHandle(handle);
 
   return keys.map((k) => {
-    const addr = algosdk.encodeAddress(k.private_key.slice(32));
-    const acct = { sk: k.private_key, addr } as algosdk.Account;
+    const addr = new algosdk.Address(k.private_key.slice(32));
+    const acct: algosdk.Account = { sk: k.private_key, addr };
     const signer = algosdk.makeBasicAccountTransactionSigner(acct);
 
     return {

src/account.ts

@@ -1,12 +1,12 @@
 import * as nacl from './nacl/naclWrappers.js';
-import * as address from './encoding/address.js';
+import { Address } from './encoding/address.js';
 import Account from './types/account.js';
 
 /**
  * generateAccount returns a new Algorand address and its corresponding secret key
  */
 export default function generateAccount(): Account {
   const keys = nacl.keyPair();
-  const encodedPk = address.encodeAddress(keys.publicKey);
-  return { addr: encodedPk, sk: keys.secretKey };
+  const addr = new Address(keys.publicKey);
+  return { addr, sk: keys.secretKey };
 }

src/boxStorage.ts

@@ -1,20 +1,18 @@
-import { EncodedBoxReference } from './types/index.js';
+import { EncodedBoxReference } from './types/transactions/index.js';
 import { BoxReference } from './types/transactions/base.js';
 
 function translateBoxReference(
   reference: BoxReference,
-  foreignApps: number[],
-  appIndex: number
+  foreignApps: bigint[],
+  appIndex: bigint
 ): EncodedBoxReference {
-  const referenceId = reference.appIndex;
+  const referenceId = BigInt(reference.appIndex);
   const referenceName = reference.name;
-  const isOwnReference = referenceId === 0 || referenceId === appIndex;
-  let index = 0;
+  const isOwnReference = referenceId === BigInt(0) || referenceId === appIndex;
+
+  // Foreign apps start from index 1; index 0 is its own app ID.
+  const index = foreignApps.indexOf(referenceId) + 1;
 
-  if (foreignApps != null) {
-    // Foreign apps start from index 1; index 0 is its own app ID.
-    index = foreignApps.indexOf(referenceId) + 1;
-  }
   // Check if the app referenced is itself after checking the foreign apps array.
   // If index is zero, then the app ID was not found in the foreign apps array
   // or the foreign apps array was null.
@@ -23,20 +21,29 @@ function translateBoxReference(
     // its own foreign apps array.
     throw new Error(`Box ref with appId ${referenceId} not in foreign-apps`);
   }
-  return { i: index, n: referenceName };
+
+  const encodedReference: EncodedBoxReference = {};
+  if (index !== 0) {
+    encodedReference.i = index;
+  }
+  if (referenceName.length) {
+    encodedReference.n = referenceName;
+  }
+  return encodedReference;
 }
 
 /**
  * translateBoxReferences translates an array of BoxReferences with app IDs
  * into an array of EncodedBoxReferences with foreign indices.
  */
 export function translateBoxReferences(
-  references: BoxReference[] | undefined,
-  foreignApps: number[],
-  appIndex: number
+  references: ReadonlyArray<BoxReference>,
+  foreignApps: ReadonlyArray<number | bigint>,
+  appIndex: number | bigint
 ): EncodedBoxReference[] {
-  if (references == null) return [];
+  const appIndexBigInt = BigInt(appIndex);
+  const foreignAppsBigInt = foreignApps.map(BigInt);
   return references.map((bx) =>
-    translateBoxReference(bx, foreignApps, appIndex)
+    translateBoxReference(bx, foreignAppsBigInt, appIndexBigInt)
   );
 }