Merge develop into PR (#736)

* ABI: Refactor ABI encoding test to round-trip (#701) * bump version and add to changelog * update README.md for new version * Packaging: Improve source map and browser usage for external bundlers (#707) * bump version and add to changelog * update README.md for new version * v2: Make breaking changes from v1 to v2.0.0 (#717) * bump version and add to changelog * update README.md for new version * remove enhancement section of recent changelog * Enhancement: Add foreign array objects to ATC `addMethodCall` (#725) * Add foreign array objects to ATC addmethodcall * Copy array value so that inputs are not modified Co-authored-by: Michael Diamant <[email protected]> Co-authored-by: Lucky Baar <[email protected]> Co-authored-by: Jason Paulos <[email protected]> Co-authored-by: Jack Smith <[email protected]> Co-authored-by: Barbara Poon <[email protected]>
algorand · Jan 18, 2023 · fc830dd · fc830dd
1 parent c34d0e5
commit fc830dd
Show file tree

Hide file tree

Showing 53 changed files with 1,451 additions and 6,090 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -48,8 +48,9 @@ module.exports = {
   ],
   ignorePatterns: [
     'dist/',
+    'docs/',
     'tests/cucumber/features/',
-    'tests/cucumber/build/',
+    'tests/cucumber/browser/build/',
     'tests/browser/bundle.*',
   ],
 };
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,53 @@
+# 2.0.0
+
+## What's Changed
+
+### Breaking changes
+
+- Remove v1 algod API (`client.algod`) due to API end-of-life (2022-12-01). Instead, use v2 algod API (`client.v2.algod.algod`).
+- Remove `cost` field in `DryrunTxnResult` in favor of 2 fields: `budget-added` and `budget-consumed`. `cost` can be derived by `budget-consumed - budget-added`.
+- Remove logicsig templates (`logicTemplates`), `logic/langspec.json`, `logic.logic` depending on `langspec.json`.
+- Regenerate algod models so every constructor requires an object to be passed in. Previously, only constructors with more than 4 argument specified this.
+- Remove unused generated types: `CatchpointAbortResponse`, `CatchpointStartResponse`.
+- Remove following methods in favor of the methods with `WithSuggestedParams` suffix:
+  - `makePaymentTxn`, `makeKeyRegistrationTxn`, `makeAssetCreateTxn`, `makeAssetConfigTxn`, `makeAssetDestroyTxn`, `makeAssetFreezeTxn`, `makeAssetTransferTxn`.
+- Remove `makeLogicSig` in favor of either using `LogicSigAccount` (preferred) or directly invoking `LogicSig` constructor.
+- Remove `EncodedMultisigBlob` in favor of `EncodedSignedTransaction.
+
+**Full Changelog**: https://github.com/algorand/js-algorand-sdk/compare/v1.24.1...v2.0.0
+
+# v1.24.1
+
+## What's Changed
+
+### Enhancements
+
+- Packaging: Improve source map and browser usage for external bundlers by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/707
+
+**Full Changelog**: https://github.com/algorand/js-algorand-sdk/compare/v1.24.0...v1.24.1
+
+# v1.24.0
+
+## What's Changed
+
+### Bugfixes
+
+- Bug-Fix: encode ABI string with non-ASCII characters by @ahangsu in https://github.com/algorand/js-algorand-sdk/pull/700
+
+### Enhancements
+
+- Tests: Migrate v1 algod dependencies to v2 in cucumber tests by @algochoi in https://github.com/algorand/js-algorand-sdk/pull/693
+- REST API: Add KV counts to NodeStatusResponse by @michaeldiamant in https://github.com/algorand/js-algorand-sdk/pull/696
+- Fix: createMultisigTransaction name in comments by @nullun in https://github.com/algorand/js-algorand-sdk/pull/694
+- Enhancement: allowing zero-length static array by @ahangsu in https://github.com/algorand/js-algorand-sdk/pull/698
+- ABI: Refactor ABI encoding test to round-trip by @michaeldiamant in https://github.com/algorand/js-algorand-sdk/pull/701
+
+## New Contributors
+
+- @nullun made their first contribution in https://github.com/algorand/js-algorand-sdk/pull/694
+
+**Full Changelog**: https://github.com/algorand/js-algorand-sdk/compare/v1.23.2...v1.24.0
+
 # v1.23.2
 
 ## What's Changed

diff --git a/README.md b/README.md
@@ -22,8 +22,8 @@ Include a minified browser bundle directly in your HTML like so:
 
 ```html
 <script
-  src="https://unpkg.com/algosdk@v1.23.2/dist/browser/algosdk.min.js"
-  integrity="sha384-1gIB0FiLMNmJ7adAfBOdH20Mnw0DZarB9D3PTozUAhKn/uT9CpHdaSbBIpmZTgrU"
+  src="https://unpkg.com/algosdk@v2.0.0/dist/browser/algosdk.min.js"
+  integrity="sha384-NBHc5NXk7w78aVp9uPMo1JmBan6l4MHxzhiKXgYT8wtBoeIMHEuu5OECfGHYTLh7"
   crossorigin="anonymous"
 ></script>
 ```
@@ -32,8 +32,8 @@ or
 
 ```html
 <script
-  src="https://cdn.jsdelivr.net/npm/algosdk@v1.23.2/dist/browser/algosdk.min.js"
-  integrity="sha384-1gIB0FiLMNmJ7adAfBOdH20Mnw0DZarB9D3PTozUAhKn/uT9CpHdaSbBIpmZTgrU"
+  src="https://cdn.jsdelivr.net/npm/algosdk@v2.0.0/dist/browser/algosdk.min.js"
+  integrity="sha384-NBHc5NXk7w78aVp9uPMo1JmBan6l4MHxzhiKXgYT8wtBoeIMHEuu5OECfGHYTLh7"
   crossorigin="anonymous"
 ></script>
 ```

diff --git a/examples/app_transaction_examples.js b/examples/app_transaction_examples.js
@@ -5,7 +5,7 @@
 // makeApplicationCreateTxnFromObject, makeApplicationOptInTxnFromObject, etc.
 // counterparts in your code for readability.
 
-const algosdk = require('..');
+const algosdk = require('../src');
 const utils = require('./utils');
 
 const { ALGOD_INSTANCE, SENDER, RECEIVER } = utils.retrieveBaseConfig();

diff --git a/examples/asset_accept_example.js b/examples/asset_accept_example.js
@@ -1,6 +1,6 @@
 // Example: accepting assets
 
-const algosdk = require('..');
+const algosdk = require('../src');
 
 async function main() {
   const account = algosdk.generateAccount();

diff --git a/examples/asset_create_example.js b/examples/asset_create_example.js
@@ -1,6 +1,6 @@
 // Example: creating an asset
 
-const algosdk = require('..');
+const algosdk = require('../src');
 const utils = require('./utils');
 
 const { SENDER } = utils.retrieveBaseConfig();

diff --git a/examples/asset_destroy_example.js b/examples/asset_destroy_example.js
@@ -1,6 +1,6 @@
 // Example: destroying an asset
 
-const algosdk = require('..');
+const algosdk = require('../src');
 
 async function main() {
   const {

diff --git a/examples/asset_freeze_example.js b/examples/asset_freeze_example.js
@@ -1,6 +1,6 @@
 // Example: freezing or unfreezing an account
 
-const algosdk = require('..');
+const algosdk = require('../src');
 
 async function main() {
   const {

diff --git a/examples/asset_revoke_example.js b/examples/asset_revoke_example.js
@@ -1,6 +1,6 @@
 // Example: revoking assets
 
-const algosdk = require('..');
+const algosdk = require('../src');
 
 async function main() {
   const {

diff --git a/examples/asset_send_example.js b/examples/asset_send_example.js
@@ -1,6 +1,6 @@
 // Example: sending assets
 
-const algosdk = require('..');
+const algosdk = require('../src');
 
 async function main() {
   const {

diff --git a/examples/asset_update_example.js b/examples/asset_update_example.js
@@ -1,6 +1,6 @@
 // Example: updating asset configuration
 
-const algosdk = require('..');
+const algosdk = require('../src');
 
 async function main() {
   const {

diff --git a/examples/generate_sender_receiver.js b/examples/generate_sender_receiver.js
@@ -5,7 +5,7 @@
  * for some of the other examples.
  */
 
-const algosdk = require('..');
+const algosdk = require('../src');
 const { fmt } = require('./utils');
 
 // generate accounts

diff --git a/examples/logic_sig_example.js b/examples/logic_sig_example.js
@@ -1,6 +1,6 @@
 // Example: creating a LogicSig transaction signed by a program that never approves the transfer.
 
-const algosdk = require('..');
+const algosdk = require('../src');
 const utils = require('./utils');
 
 const { ALGOD_INSTANCE, RECEIVER } = utils.retrieveBaseConfig();
@@ -24,7 +24,7 @@ async function main() {
   );
 
   // create a logic signature
-  const lsig = algosdk.makeLogicSig(programBytes);
+  const lsig = new algosdk.LogicSigAccount(programBytes);
   const sender = lsig.address();
 
   // retrieve a receiver

diff --git a/examples/multisig_example.js b/examples/multisig_example.js
@@ -1,6 +1,6 @@
 // Example: manipulating multisig transactions
 
-const algosdk = require('..');
+const algosdk = require('../src');
 const utils = require('./utils');
 
 const { ALGOD_INSTANCE, SENDER, RECEIVER } = utils.retrieveBaseConfig();

diff --git a/examples/notefield_example.js b/examples/notefield_example.js
@@ -5,7 +5,7 @@
  * want in the "note" field.
  */
 
-const algosdk = require('..');
+const algosdk = require('../src');
 const utils = require('./utils');
 
 const { ALGOD_INSTANCE, SENDER, RECEIVER } = utils.retrieveBaseConfig();

diff --git a/examples/rekey_example.js b/examples/rekey_example.js
@@ -1,6 +1,6 @@
 // Example: rekeying
 
-const algosdk = require('..');
+const algosdk = require('../src');
 const utils = require('./utils');
 
 const { ALGOD_INSTANCE, SENDER } = utils.retrieveBaseConfig();

diff --git a/examples/transaction_group_example.js b/examples/transaction_group_example.js
@@ -1,6 +1,6 @@
 // Example: working with transaction groups
 
-const algosdk = require('..');
+const algosdk = require('../src');
 const utils = require('./utils');
 
 const { ALGOD_INSTANCE, SENDER, RECEIVER } = utils.retrieveBaseConfig();

diff --git a/examples/typescript_example.ts b/examples/typescript_example.ts
@@ -1,6 +1,6 @@
 // Example: with TypeScript
 
-import algosdk from '../index';
+import algosdk from '../src';
 import utils from './utils';
 
 const { SENDER, RECEIVER } = utils.retrieveBaseConfig();

diff --git a/index.ts b/index.ts