v3.0.0

What's Changed

⚠️ WARNING: This release is a new major version with breaking changes from the v2.X.X series. For help migrating from v2 releases, see the file v2_TO_v3_MIGRATION_GUIDE.md.

v2 End of Life

With the release of v3 of this SDK, v2 is now in maintenance mode. No new features will be added to v2, and only security fixes or critical errors will be addressed. At the end of March 2025, no further updates will be made to the v2 package.

Breaking Changes

Convert algod responses to typed by @Eric-Warehime in #776
Align transaction fields to transaction reference spec by @algochoi in #804
TEAL Source Map: Improve SourceMap and support columns by @jasonpaulos in #834
Remove IntDecoding as a REST option & support native bigint types in models by @jasonpaulos in #852
Refactor Transaction class by @jasonpaulos in #854
Improve object encoding and decoding by @jasonpaulos in #862
Correctly model blocks by @jasonpaulos in #875
Fix stateproof txn representation by @jasonpaulos in #876
Typed indexer responses by @jasonpaulos in #857
Support special case raw binary strings by @jasonpaulos in #878
REST API TEAL bytes fix by @jasonpaulos in #881
Fix remaining REST untyped responses by @jasonpaulos in #882

Enhancements

Remove buffer usage in favor or Uint8Array and Dataview by @algochoi in #800
Remove Buffer Usage by @algochoi in #801
Add address bytes length check in encodeAddress by @algochoi in #809
Native esm bundle by @PhearZero in #836
Add ability to pass through fetch options by @jasonpaulos in #883
REST API: Allow bigints for client args by @jasonpaulos in #893

Bugfixes

Fix: Don't delete dist folder when creating release PR by @jasonpaulos in #890
Release PR Generation: Use prerelease tag in changelog generation by @jasonpaulos in #892

Other

Type and formatting changes by @jasonpaulos in #853
3.0.0: Sync changes to develop by @jasonpaulos in #884

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v2.9.0...v3.0.0

v2.9.0

What's Changed

Enhancements

feat: add ARC22 and ARC28 interfaces for ABI contracts and methods by @joe-p in #856
Algod: Regenerate models to include new simulate option by @jasonpaulos in #880
API: Deprecate txn maker functions that will be removed in v3 by @jasonpaulos in #886

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v2.8.0...v2.9.0

v2.8.0

What's Changed

Bugfixes

Fix: Update chromedriver deps, make install conditional in CI, and fix indexer sync error in cucumber tests by @jasonpaulos in #859
fix: allow either boolean value for nonParticipation offline keyregs by @joe-p in #866

Enhancements

API: Regenerate algod and indexer models by @jasonpaulos in #845
Spec: Regenerate code from specification file f633b019 by @gmalouf in #870

New Contributors

@gmalouf made their first contribution in #870

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v2.7.0...v2.8.0

v2.7.0

What's Changed

Enhancements

fix: remove cross-fetch by @PhearZero in #833

New Contributors

@PhearZero made their first contribution in #833

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v2.6.0...v2.7.0

v2.6.0

What's Changed

Bugfixes

signer: Only merge multisigs if there are more than 1 by @acfunk in #822

New Features

Simulate: Application State Change and Hash of Executed Bytecode by @ahangsu in #818

Enhancements

node: Update to node 18, drop support for node 16 by @jasonpaulos in #827
api: Regenerate client. by @winder in #826

New Contributors

@acfunk made their first contribution in #822

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v2.5.0...v2.6.0

v2.5.0

What's Changed

Bugfixes

bug-fix: include currency-greater-than param for 0 value by @shiqizng in #807

New Features

Simulation: Execution trace (PC/Stack/Scratch) support by @ahangsu in #803

Enhancements

fetch: Add Cloudflare Workers support (cross-fetch v4) by @spencercap in #794
logging: Add rn warning and logging by @Eric-Warehime in #798
CICD: Update Chromedriver version and CI orb by @algochoi in #802
CICD: Update chromedriver in package.json to 116+ by @algochoi in #811

New Contributors

@spencercap made their first contribution in #794

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v2.4.0...v2.5.0

v2.4.0

What's Changed

Bugfixes

docs: fix error message by @barnjamin in #780

New Features

Algod: Simulation run with extra budget per transaction group by @ahangsu in #784

Enhancements

DevOps: Update CODEOWNERS to only refer to the devops group by @onetechnical in #783
Client: Don't send auth header when token is empty by @Eric-Warehime in #782
algod: Add state delta APIs by @Eric-Warehime in #785
deps: Remove coveralls, mocha lcov by @Eric-Warehime in #787
algod: Add json query arg to delta endpoints by @Eric-Warehime in #793

Other

Bump semver-regex from 3.1.2 to 3.1.4 by @dependabot in #580

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v2.3.0...v2.4.0

v2.3.0

What's Changed

Bugfixes

Docs: Repair the links in the docs to developer.algorand.org by @bbroder-algo in #755
Fix: Allow nonParticipation flag to be a boolean by @barnjamin in #757
BugFix: Min fee sp fix by @barnjamin in #760

New Features

Simulation: Lift log limits option in SimulateRequest by @ahangsu in #768

Enhancements

Docs: Examples by @barnjamin in #754
API: Support updated simulate endpoint by @jasonpaulos in #764
algod: Add blockOffsetTimestamp, syncRound APIs to algod client by @Eric-Warehime in #769
node: Drop support for node v14, npm audit fix by @Eric-Warehime in #773
client: Export token header types by @Eric-Warehime in #772
DevOps: Add CODEOWNERS to restrict workflow editing by @onetechnical in #775
Docs: Update README & FAQ by @jasonpaulos in #774

New Contributors

@bbroder-algo made their first contribution in #755

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v2.2.0...v2.3.0

v2.2.0

What's Changed

Bugfixes

bugfix: Satisfy typescript constraints by @aorumbayev in #741
algod: Minor improvements to simulation support by @jasonpaulos in #749

Enhancements

CICD: Update ssh fingerprint for gh-pages by @algobarb in #745
Docs: add examples to be pulled in for docs by @joe-p in #747
algod: Simulate Endpoint by @algochoi in #743

New Contributors

@aorumbayev made their first contribution in #741

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v2.1.0...v2.2.0

v2.1.0

What's Changed

Enhancements

Enhancement: Add foreign array objects to ATC addMethodCall by @algochoi in #725
API: verifyTealSign utility function by @M-Picco in #735
Packaging: Don't use global Buffer object by @jasonpaulos in #733
algod REST API: Add support for algod /v2/teal/disassemble by @michaeldiamant in #702

New Contributors

@M-Picco made their first contribution in #735

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v2.0.0...v2.1.0

v2.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 #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 #700

Enhancements

Tests: Migrate v1 algod dependencies to v2 in cucumber tests by @algochoi in #693
REST API: Add KV counts to NodeStatusResponse by @michaeldiamant in #696
Fix: createMultisigTransaction name in comments by @nullun in #694
Enhancement: allowing zero-length static array by @ahangsu in #698
ABI: Refactor ABI encoding test to round-trip by @michaeldiamant in #701

New Contributors

@nullun made their first contribution in #694

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v1.23.2...v1.24.0

v1.23.2

What's Changed

Bugfixes

SDK: Dryrun and transaction decoding fix for boxes by @jasonpaulos in #690

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v1.23.1...v1.23.2

v1.23.1

Bugfixes

fix: mergeMultisigTransactions logic error by @AlgoDoggo in #675
CI: Remove unneeded dependency & update package-lock by @jasonpaulos in #684

New Features

Boxes: Add support for Boxes by @algochoi in #604

Enhancements

Enhancement: Code generation improvements by @jasonpaulos in #663
Network: Replace superagent with fetch for HTTP requests by @jasonpaulos in #676
API: Fix docs typo by @PabloLION in #677
CI: Upgrade node.js from v12 to v14 by @michaeldiamant in #680

New Contributors

@PabloLION made their first contribution in #677

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v1.22.0...v1.23.1

v1.22.0

What's Changed

Bugfixes

Bug-Fix: Fix typo in documentation for searchAccounts currencyGreaterThan by @fionnachan in #572

Enhancements

REST API: Add algod block hash endpoint, add indexer block header-only param. by @winder in #665

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v1.21.0...v1.22.0

v1.21.0

What's Changed

Enhancements

Enhancement: Removing more unused steps by @tzaffi in #637
Enhancement: Add deprecation tag to algod v1 client by @algochoi in #642
enhancement: add unit test for ParticipationUpdates field by @shiqizng in #652

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v1.20.0...v1.21.0

v1.20.0

What's Changed

Bugfixes

Bug-Fix: Pass verbosity to the harness and sandbox by @tzaffi in #630

Enhancements

Enhancement: Use sandbox for SDK Testing and remove Indexer v1 steps by @algochoi in #623
Tidy: Ignore algorand-sdk-testing test-harness dir by @michaeldiamant in #634
Enhancement: Deprecating use of langspec by @ahangsu in #632
enhancement: Initial stateproofs support by @Eric-Warehime in #629

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v1.19.1...v1.20.0

v1.20.0-beta.1

What's Changed

Bugfixes

Bug-Fix: Pass verbosity to the harness and sandbox by @tzaffi in #630

Enhancements

Enhancement: Use sandbox for SDK Testing and remove Indexer v1 steps by @algochoi in #623
Tidy: Ignore algorand-sdk-testing test-harness dir by @michaeldiamant in #634
Enhancement: Deprecating use of langspec by @ahangsu in #632
enhancement: Initial stateproofs support by @Eric-Warehime in #629

New Contributors

@ahangsu made their first contribution in #632

Full Changelog: https://github.com/algorand/js-algorand-sdk/compare/v1.19.1...v1.20.0-beta.1

v1.19.1

Enhancements

API: Support attaching signatures to standard and multisig transactions by @jdtzmn in #595
AVM: Consolidate TEAL and AVM versions by @michaeldiamant in #609
Testing: Use Dev mode network for cucumber tests by @algochoi in #614

v1.19.0

What's Changed

Bugfixes

tech-debt: Remove unused/unmaintained templates by @Eric-Warehime in #607

New Features

Dev Tools: Source map decoder by @barnjamin in #590
Enhancement: Upgrade typedoc and plugins by @fionnachan in #605

Enhancements

Github-Actions: Adding PR title and label checks by @algojack in #600
docs: tealSign by @AlgoDoggo in #610

v1.18.1

What's Changed

Properly set maxWidth in trace by @joe-p in #593
fix: safe intDecoding by @AlgoDoggo in #599
Remove code that relies on node's path module by @bmdelacruz in #598

New Contributors

@AlgoDoggo made their first contribution in #599
@bmdelacruz made their first contribution in #598

v1.18.0

What's Changed

Add method to abi results by @barnjamin in #578
Add getMethodByName function to Contract and Interface by @barnjamin in #583

v1.17.0

What's Changed

Allow Uint8Arrays public keys for kmd signing by @vividn in #549
Update generated files by @Eric-Warehime in #569
Build: Add SDK code generation workflow by @Eric-Warehime in #570
Update codegen.yml by @Eric-Warehime in #574
Generate updated client API code by @algoidurovic in #566

New Contributors

@vividn made their first contribution in #549
@Eric-Warehime made their first contribution in #569
@algoidurovic made their first contribution in #566

v1.16.0

Added

Dryrun stack printer
Document more Indexer methods

Fixed

Corrected type of KMD keys
Include foreign app addr in dryrun requests

v1.15.0

Added

Support unlimited assets REST API changes. (#527)

Fixed

Fix app creation createDryrun error (#539)
Fix cucumber tests for asset lookup step (#540)
Fix searchForApplications filter by creator parameter type. (#546)

v1.15.0-beta.1

Added

Support unlimited assets REST API changes. (#527)

Fixed

Fix app creation createDryrun error (#539)
Fix cucumber tests for asset lookup step (#540)

v1.14.0

Added

Add stateproof keyreg field (#463)

Changed

Implement C2C tests (#498)
Moving from travis to circleci (#507)
Add installation instructions for vite users (#512)
Update langspec for TEAL 6 (#518)
Docs for lookupAssetByID and lookupAccountTransactions (#516)
Make FromObject parameter IntelliSense human readable (#528)
Bump url-parse from 1.5.1 to 1.5.8 (#529)

Fixed

Use HTTP request format arg to determine response type (#532)
Update chromedriver (#535)

v1.14.0-beta.1

Added

Add stateproof keyreg field (#463)

Changed

Implement C2C tests (#498)
Moving from travis to circleci (#507)
Add installation instructions for vite users (#512)
Update langspec for TEAL 6 (#518)

1.13.1

Added:

Add app creator to dryrun request (#499)

Changed:

Adding note to use bigint (#501)

Fixed:

Fix JSON decoding (#502)

1.13.0

Added:

Create dryrun (#478)
Support ABI reference types and other improvements (#482)
Improve HTTP error messages (#485)
Enabling a custom client for Algod and Indexer (#477)
Export sdk subclasses to typedoc (#479)
ABI Support for JS library (#454)
ABI interaction support (#466)
Wait for confirmation function (#469)
Add freezeAccount encoding in display method (#460)
Regenerate code from specification file (#456)

Changed:

Document Indexer methods (#491)
Document Algodv2 methods (#486)
Update chromedriver (#492)

Fixed:

Fix wait for confirmation function (#480)
Fix type for foreignAssets (#472)

1.13.0-beta.2

Added

Support ABI reference types and other improvements (#482)
Improve HTTP error messages (#485)
Enabling a custom client for Algod and Indexer (#477)
Export sdk subclasses to typedoc (#479)

Fixed

Fix wait for confirmation function (#480)

1.13.0-beta.1

Added

ABI Support for JS library (#454)
ABI interaction support (#466)
Wait for confirmation function (#469)
Add freezeAccount encoding in display method (#460)
Regenerate code from specification file (#456)

Fixed

Fix type for foreignAssets (#472)

1.12.0

Added

Support AVM 1.0
Support deserializing nonparticipating and offline keyreg
Support deserializing nonparticipating transaction

Fixed

Key registration transaction with nonParticipation=true

1.11.1

Fixed

Properly decode transaction extra pages field (#419)

1.11.0

Added

Signing support for rekeying to LogicSig/MultiSig account

1.10.1

Added

Add missing fields msig and lsig to EncodedSignedTransaction type
Add the missing type SignedTransaction, which helped fix the any return value for Transaction.from_obj_for_encoding
More internal types are now exported
Support the new base64 asset fields in algod models
Add ability to install the package from a git URL with npm

Fixed

Remove BigInt literals from package
Support encoding transactions with a first round of zero
Fix msgpack encoding of dryrun objects

1.10.0

Added

Support for dynamic opcode accounting, backward jumps, loops, callsub, retsub
Ability to pool fees
Ability to pay for extra pages

Changed

Add link to docs in readme
Update examples on getting suggestedParams
Grammatical fixes

Fixed

Fix asset creation transaction types that should be optional
Remove synthetic default imports
Use DryrunRequest instead of DryrunSource in constructor

1.9.1

Changed

Changed our browser bundle from webpack's window type to UMD, which fixes issues when using the library from React (#352).

1.9.0

Added

TypeScript support (#302, #314, #315, #317, #313, #319, #323, #318, #331, #325, #337).
Allow BigInts to be used to construct Transactions (#263).
decodeAddress now verifies the address checksum (#269).
Add support for nonparticipating key registration transactions (#271).
Allow LogicSigs to sign transactions with a different AuthAddr (#268).
Support for decoding BigInts from API calls (#260).
Add helper functions to encode and decode integers (#281).
Support new features from indexer v2.3.2 (#296).
Support TEAL 3 programs (#294).

Fixed

Properly validate assetMetadataHash and lease (#253, #280).
Fix the Algodv2.versionsCheck().do() method (#258).
Fix an issue using mergeMultisigTransactions in React (#259).
Fix the inability to specify rekey addresses in several makeTransaction functions (#267).
Stop the Transaction constructor from modifying input arrays (#279).
Allow signLogicSigTransaction to accept Transaction objects (#290).

Changed

Update examples to use v2 endpoints (#289).
Improve error trace reporting (#291).
Establish consistent code style (#299).
Remove dist folder from repo (#326).

1.8.1

Added

Added toString and print methods to Transaction (#243).
Added functions to create Transactions from objects (#246).

Fixed

Fixed issues using the library with webpack, including switching dependencies from keccak to js-sha3 (#247).

1.8.0

Added

Add encodeAddress and decodeAddress to convert between the binary and text form of Algorand addresses (#216).
Add encodeUnsignedTransaction, decodeUnsignedTransaction, decodeSignedTransaction to convert between binary transactions and transaction objects (#218).
Add optional rekeyTo parameter to transaction builder functions (#221).
Support testing on Chrome and Firefox in addition to Node (#228 and #235).

Fixed

Update keccak to 3.0.1, which fixes a build error that would occur every time the package was installed (#151).
Allow assignGroupID to accept raw transaction objects and instances of the Transaction class (#236).
Allow signTransaction to accept instances of the Transaction class (#233).
Improve type checking and documentation (#233 and #231).

Changed

Switch to using algo-msgpack-with-bigint, which is a fork of @msgpack/msgpack with support for encoding and decoding BigInts (#229).
Update dependencies (#237).

1.7.2

Fixed

Fixed msgpack endpoints returning undefined in browsers (#210 and #215).
Removed use of class properties (#213).

Changed

Remove unneeded dependency js-yaml and changed mock-http-server to a dev dependency (#214 and #212).

1.7.1

Fixed

Fixed set Accept on GET calls

Changed

Change algosdk.signMultisigTransaction to accept either a built Transaction or a dict of constructor args

1.7.0

Added

Support for Application Call Transactions, also known as Stateful TEAL
Support for TEAL Compile and Dryrun
Support for Rekeying Transactions

Fixed

An encoding failure due to an empty field will now indicate which field was empty
Browserify can now handle newly exported modelsv2 package

1.6.2

Fixed

Fixed bug where submitting an array of transactions to v2 client's sendRawTransaction would cause an error.

1.6.1

Fixed

Fixed bug where Indexer and algod V2 clients were omitted from module exports.

1.6.0 Added

Clients for Indexer and algod V2

1.5.0 Added

additional Algorand Smart Contracts (ASC)
- support for Dynamic Fee contract
- support for Limit Order contract
- support for Periodic Payment contract
support for Suggested Params

1.4.1 Added

Added asset decimals field.

1.4.0 Added

Added support for Algorand Standardized Assets (ASA)
Added support for Algorand Smart Contracts (ASC)
- Added support for Hashed Time Lock Contract (HTLC)
- Added support for Split contract
Added support for Group Transactions
Added support for leases

1.3.1

Changed

msgpack lib was replaced with the official https://github.com/msgpack/msgpack-javascript

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

v3.0.0

What's Changed

v2 End of Life

Breaking Changes

Enhancements

Bugfixes

Other

v2.9.0

What's Changed

Enhancements

v2.8.0

What's Changed

Bugfixes

Enhancements

New Contributors

v2.7.0

What's Changed

Enhancements

New Contributors

v2.6.0

What's Changed

Bugfixes

New Features

Enhancements

New Contributors

v2.5.0

What's Changed

Bugfixes

New Features

Enhancements

New Contributors

v2.4.0

What's Changed

Bugfixes

New Features

Enhancements

Other

v2.3.0

What's Changed

Bugfixes

New Features

Enhancements

New Contributors

v2.2.0

What's Changed

Bugfixes

Enhancements

New Contributors

v2.1.0

What's Changed

Enhancements

New Contributors

v2.0.0

What's Changed

Breaking changes

v1.24.1

What's Changed

Enhancements

v1.24.0

What's Changed

Bugfixes

Enhancements

New Contributors

v1.23.2

What's Changed

Bugfixes

v1.23.1

Bugfixes

New Features

Enhancements

New Contributors

v1.22.0

What's Changed

Bugfixes