From ab55345f7bca0647d32aa4efbdce9351834c691d Mon Sep 17 00:00:00 2001 From: onetechnical Date: Thu, 12 Sep 2024 14:03:07 +0000 Subject: [PATCH 1/3] bump up version to v3.0.0 --- CHANGELOG.md | 18 ++++++++++++++++++ README.md | 8 ++++---- package-lock.json | 4 ++-- package.json | 2 +- 4 files changed, 25 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8bde12443..c4f632d39 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,21 @@ +# v3.0.0 + + + +## What's Changed + +### Bugfixes + +- Fix: Don't delete `dist` folder when creating release PR by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/890 +- Release PR Generation: Use prerelease tag in changelog generation by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/892 + +### Enhancements + +- 3.0.0: Sync changes to develop by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/884 +- REST API: Allow bigints for client args by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/893 + +**Full Changelog**: https://github.com/algorand/js-algorand-sdk/compare/v2.9.0...v3.0.0 + # v2.9.0 diff --git a/README.md b/README.md index a95f68533..66c66ab5c 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,8 @@ Include a minified browser bundle directly in your HTML like so: ```html ``` @@ -34,8 +34,8 @@ or ```html ``` diff --git a/package-lock.json b/package-lock.json index a91f2a894..560544963 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "algosdk", - "version": "2.9.0", + "version": "3.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "algosdk", - "version": "2.9.0", + "version": "3.0.0", "license": "MIT", "dependencies": { "algorand-msgpack": "^1.1.0", diff --git a/package.json b/package.json index 7c6ba92cf..8ea2e7c09 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "algosdk", - "version": "2.9.0", + "version": "3.0.0", "description": "The official JavaScript SDK for Algorand", "main": "dist/cjs/index.js", "module": "dist/esm/index.js", From 237f3a7cc806aaaf025681365dea131e1ec7ef52 Mon Sep 17 00:00:00 2001 From: John Lee Date: Thu, 12 Sep 2024 11:39:06 -0400 Subject: [PATCH 2/3] Update changelog to include full v3.0.0 release notes. --- CHANGELOG.md | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c4f632d39..97227f08c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,18 +1,44 @@ # 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`. + +### Breaking Changes + +- Convert algod responses to typed by @Eric-Warehime in https://github.com/algorand/js-algorand-sdk/pull/776 +- Align transaction fields to transaction reference spec by @algochoi in https://github.com/algorand/js-algorand-sdk/pull/804 +- TEAL Source Map: Improve SourceMap and support columns by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/834 +- Remove `IntDecoding` as a REST option & support native bigint types in models by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/852 +- Refactor `Transaction` class by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/854 +- Improve object encoding and decoding by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/862 +- Correctly model blocks by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/875 +- Fix stateproof txn representation by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/876 +- Typed indexer responses by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/857 +- Support special case raw binary strings by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/878 +- REST API TEAL bytes fix by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/881 +- Fix remaining REST untyped responses by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/882 + +### Enhancements + +- Remove buffer usage in favor or Uint8Array and Dataview by @algochoi in https://github.com/algorand/js-algorand-sdk/pull/800 +- Remove `Buffer` Usage by @algochoi in https://github.com/algorand/js-algorand-sdk/pull/801 +- Add address bytes length check in encodeAddress by @algochoi in https://github.com/algorand/js-algorand-sdk/pull/809 +- Native esm bundle by @PhearZero in https://github.com/algorand/js-algorand-sdk/pull/836 +- Add ability to pass through fetch options by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/883 +- REST API: Allow bigints for client args by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/893 + ### Bugfixes - Fix: Don't delete `dist` folder when creating release PR by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/890 - Release PR Generation: Use prerelease tag in changelog generation by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/892 -### Enhancements +### Other +- Type and formatting changes by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/853 - 3.0.0: Sync changes to develop by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/884 -- REST API: Allow bigints for client args by @jasonpaulos in https://github.com/algorand/js-algorand-sdk/pull/893 **Full Changelog**: https://github.com/algorand/js-algorand-sdk/compare/v2.9.0...v3.0.0 From 6973ff583b243ddb0632e91f4c0383021430a789 Mon Sep 17 00:00:00 2001 From: John Lee Date: Thu, 12 Sep 2024 13:01:16 -0400 Subject: [PATCH 3/3] Add additional note about v2 end of life --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 97227f08c..80715847c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ > ⚠️ **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 https://github.com/algorand/js-algorand-sdk/pull/776