3.0.0: Sync changes to develop (#884)

.eslintrc.js

@@ -16,16 +16,6 @@ module.exports = {
   },
   plugins: ['@typescript-eslint', 'eslint-plugin-tsdoc'],
   rules: {
-    'no-restricted-globals': [
-      'error',
-      {
-        // This is to ensure that we use the 'buffer' package in the browser. In Node it doesn't
-        // make a difference.
-        name: 'Buffer',
-        message:
-          "Explictly import Buffer with `import { Buffer } from 'buffer'`",
-      },
-    ],
     'no-constant-condition': ['error', { checkLoops: false }],
     'no-restricted-syntax': ['error', 'LabeledStatement', 'WithStatement'],
     'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
@@ -68,4 +58,13 @@ module.exports = {
     'tests/cucumber/browser/build/',
     'tests/browser/bundle.*',
   ],
+  settings: {
+    'import/resolver': {
+      typescript: {
+        extensionAlias: {
+          '.js': ['.ts', '.d.ts', '.js'],
+        },
+      },
+    },
+  },
 };

.gitattributes

@@ -0,0 +1,2 @@
+src/client/v2/algod/models/types.ts linguist-generated=true
+src/client/v2/indexer/models/types.ts linguist-generated=true

.gitignore

@@ -1,3 +1,8 @@
+dist/*
+!dist/esm
+dist/esm/*
+!dist/esm/package.json
+
 .DS_Store
 
 .idea/
@@ -6,6 +11,7 @@
 .vscode/*
 !.vscode/settings.json
 !.vscode/extensions.json
+!.vscode/launch.json
 
 # npm
 node_modules/
@@ -23,7 +29,6 @@ tests/cucumber/browser/build
 tests/browser/bundle.*
 
 # Builds
-dist/
 docs/
 built/
 

.prettierrc.json

@@ -1,3 +1,4 @@
 {
-  "singleQuote": true
+  "singleQuote": true,
+  "trailingComma": "es5"
 }

.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/**"
+      ]
+    }
+  ]
+}

Makefile

@@ -2,10 +2,10 @@ UNIT_TAGS :=  "$(subst :, or ,$(shell awk '{print $2}' tests/cucumber/unit.tags
 INTEGRATIONS_TAGS := "$(subst :, or ,$(shell awk '{print $2}' tests/cucumber/integration.tags | paste -s -d: -))"
 
 unit:
-	node_modules/.bin/cucumber-js --tags $(UNIT_TAGS) tests/cucumber/features --require-module ts-node/register --require tests/cucumber/steps/index.js
-	
+	node_modules/.bin/cucumber-js --tags $(UNIT_TAGS) tests/cucumber/features --require-module tsx/cjs --require tests/cucumber/steps/index.js
+
 integration:
-	node_modules/.bin/cucumber-js --tags $(INTEGRATIONS_TAGS) tests/cucumber/features --require-module ts-node/register --require tests/cucumber/steps/index.js
+	node_modules/.bin/cucumber-js --tags $(INTEGRATIONS_TAGS) tests/cucumber/features --require-module tsx/cjs --require tests/cucumber/steps/index.js
 
 # The following assumes that all cucumber steps are defined in `./tests/cucumber/steps/steps.js` and begin past line 135 of that file.
 # Please note any deviations of the above before presuming correctness.

README.md

@@ -4,6 +4,10 @@
 
 AlgoSDK is the official JavaScript library for communicating with the Algorand network. It's designed for modern browsers and Node.js.
 
+## New Major Version 3
+
+Existing codebases using v2 of this library will be incompatible with v3. The v3 release introduces breaking changes to the API, and a migration guide is available [here](v2_TO_v3_MIGRATION_GUIDE.md).
+
 ## Installation
 
 ### [Node.js](https://nodejs.org/en/download/)

dist/esm/package.json

@@ -0,0 +1 @@
+{"type": "module"}

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,30 +31,30 @@ 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({
-    from: funder.addr,
-    to: multisigAddr,
+    sender: funder.addr,
+    receiver: multisigAddr,
     amount: 1_000_000,
     suggestedParams,
   });
 
   await client.sendRawTransaction(fundMsigTxn.signTxn(funder.privateKey)).do();
-  await algosdk.waitForConfirmation(client, fundMsigTxn.txID().toString(), 3);
+  await algosdk.waitForConfirmation(client, fundMsigTxn.txID(), 3);
 
   // example: MULTISIG_SIGN
   const msigTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: multisigAddr,
-    to: funder.addr,
+    sender: multisigAddr,
+    receiver: funder.addr,
     amount: 100,
     suggestedParams,
   });
@@ -74,46 +74,50 @@ async function main() {
   ).blob;
 
   await client.sendRawTransaction(msigWithSecondSig).do();
-  await algosdk.waitForConfirmation(client, msigTxn.txID().toString(), 3);
+  await algosdk.waitForConfirmation(client, msigTxn.txID(), 3);
   // example: MULTISIG_SIGN
 
   // 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
 
   // example: ACCOUNT_REKEY
   // rekey the original account to the new signer via a payment transaction
   // Note any transaction type can be used to rekey an account
   const rekeyTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: acct1.addr,
-    to: acct1.addr,
+    sender: acct1.addr,
+    receiver: acct1.addr,
     amount: 0,
     suggestedParams,
     rekeyTo: acct2.addr, // set the rekeyTo field to the new signer
   });
 
   await client.sendRawTransaction(rekeyTxn.signTxn(acct1.privateKey)).do();
-  await algosdk.waitForConfirmation(client, rekeyTxn.txID().toString(), 3);
+  await algosdk.waitForConfirmation(client, rekeyTxn.txID(), 3);
 
   const acctInfo = await client.accountInformation(acct1.addr).do();
 
-  console.log(`Account Info: ${acctInfo} Auth Addr: ${acctInfo['auth-addr']}`);
+  console.log(
+    `Account Info: ${algosdk.stringifyJSON(acctInfo)} Auth Addr: ${
+      acctInfo['auth-addr']
+    }`
+  );
   // example: ACCOUNT_REKEY
 
   // the transaction is from originalAccount, but signed with newSigner private key
 
   const rekeyBack = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: acct1.addr,
-    to: acct1.addr,
+    sender: acct1.addr,
+    receiver: acct1.addr,
     amount: 0,
     suggestedParams,
     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();