From 8fcc28b77aa54e9edb314468c9a6923fd14bc7d4 Mon Sep 17 00:00:00 2001 From: bobinstein Date: Fri, 6 Dec 2024 12:56:12 -0500 Subject: [PATCH] docs: sdk release notes --- docs/src/guides/sdk-release-notes.md | 123 +++++++++++++++++++++++++++ 1 file changed, 123 insertions(+) diff --git a/docs/src/guides/sdk-release-notes.md b/docs/src/guides/sdk-release-notes.md index 7eaf86ee..c88e31a9 100644 --- a/docs/src/guides/sdk-release-notes.md +++ b/docs/src/guides/sdk-release-notes.md @@ -4,6 +4,129 @@ Welcome to the documentation page for the ar.io SDK release notes. Here, you will find detailed information about each version of the ar.io SDK, including the enhancements, bug fixes, and any other changes introduced in every release. This page serves as a comprehensive resource to keep you informed about the latest developments and updates in the ar.io SDK. For those interested in exploring the source code, each release's code is readily accessible at our GitHub repository: ar.io SDK [change logs](https://github.com/ar-io/ar-io-sdk/blob/main/CHANGELOG.md). Stay updated with the continuous improvements and advancements in the ar.io SDK by referring to this page for all release-related information. +# [2.6.0](https://github.com/ar-io/ar-io-sdk/compare/v2.5.5...v2.6.0) (2024-12-05) + + +### Bug Fixes + +* **lua id:** bump lua id for ANT 9 ([9e8e7e8](https://github.com/ar-io/ar-io-sdk/commit/9e8e7e83deb7aef9fc6d94f294d6087840ade3e0)) +* use `Keywords` for setKeywords ([99cccd4](https://github.com/ar-io/ar-io-sdk/commit/99cccd499de0254f07e43ae68f4214b2775fa7b8)) + + +### Features + +* **get demand factor settings:** init new IO method PE-6894 ([ad2eb36](https://github.com/ar-io/ar-io-sdk/commit/ad2eb366328439fa1693de10c7c2ced12623385f)) +* init get gateway registry settings PE-6895 ([bb7b6b4](https://github.com/ar-io/ar-io-sdk/commit/bb7b6b4581f2b5e39c800749f0d7e2414fb9dd1c)) + +# [2.6.0-alpha.4](https://github.com/ar-io/ar-io-sdk/compare/v2.6.0-alpha.3...v2.6.0-alpha.4) (2024-12-05) + + +### Features + +* **get demand factor settings:** init new IO method PE-6894 ([ad2eb36](https://github.com/ar-io/ar-io-sdk/commit/ad2eb366328439fa1693de10c7c2ced12623385f)) + +# [2.6.0-alpha.3](https://github.com/ar-io/ar-io-sdk/compare/v2.6.0-alpha.2...v2.6.0-alpha.3) (2024-12-05) + + +### Bug Fixes + +* **lua id:** bump lua id for ANT 9 ([9e8e7e8](https://github.com/ar-io/ar-io-sdk/commit/9e8e7e83deb7aef9fc6d94f294d6087840ade3e0)) + +# [2.6.0-alpha.2](https://github.com/ar-io/ar-io-sdk/compare/v2.6.0-alpha.1...v2.6.0-alpha.2) (2024-12-02) + + +### Bug Fixes + +* **io:** update gateway delegates api, add to README ([65aa6a8](https://github.com/ar-io/ar-io-sdk/commit/65aa6a8e280a6d0b6044caf9ba88f47a61d08022)) + +## [2.5.5](https://github.com/ar-io/ar-io-sdk/compare/v2.5.4...v2.5.5) (2024-11-28) + + +### Bug Fixes + +* **io:** update gateway delegates api, add to README ([65aa6a8](https://github.com/ar-io/ar-io-sdk/commit/65aa6a8e280a6d0b6044caf9ba88f47a61d08022)) + +## [2.5.4](https://github.com/ar-io/ar-io-sdk/compare/v2.5.3...v2.5.4) (2024-11-28) + + +### Bug Fixes + +* **primary:** support primary name in token cost API ([b4edf47](https://github.com/ar-io/ar-io-sdk/commit/b4edf4768ed6d22325bb3328d9724703fa17c89a)) + +## [2.5.3](https://github.com/ar-io/ar-io-sdk/compare/v2.5.2...v2.5.3) (2024-11-27) + + +### Bug Fixes + +* **ant lua id:** update ant lua id ([54ff68b](https://github.com/ar-io/ar-io-sdk/commit/54ff68b03842f8382bbdfd28902f033857f25a39)) +* **ant:** update write handler types removes evolve handler name ([d9f5de4](https://github.com/ar-io/ar-io-sdk/commit/d9f5de438bd303078d1ccaa33198a9de4e36405d)) +* **handler names:** add primary name handlers ([5192c09](https://github.com/ar-io/ar-io-sdk/commit/5192c093ca75b5c6e05d446d3b711406849a9a9a)) + +## [2.5.2](https://github.com/ar-io/ar-io-sdk/compare/v2.5.1...v2.5.2) (2024-11-25) + + +### Bug Fixes + +* **io:** fix tag for `requestPrimaryName` API ([bdaeaaf](https://github.com/ar-io/ar-io-sdk/commit/bdaeaafb8b07383711751e334dd7f679617e8a01)) +* **io:** updated types and fixed apis for primary name requests ([a297628](https://github.com/ar-io/ar-io-sdk/commit/a2976282247403b533ac129eaf76bd35c7af56cc)) + +## [2.5.1](https://github.com/ar-io/ar-io-sdk/compare/v2.5.0...v2.5.1) (2024-11-22) + +### Bug Fixes + +* **primary names:** update type for getPrimaryNameRequest ([bdd3a9f](https://github.com/ar-io/ar-io-sdk/commit/bdd3a9f63f90688453208804c242622b1f583ec7)) + +# [2.5.0](https://github.com/ar-io/ar-io-sdk/compare/v2.4.0...v2.5.0) (2024-11-22) + + +### Bug Fixes + +* **ant:** revert breaking change on records for ANT ([58db878](https://github.com/ar-io/ar-io-sdk/commit/58db8780797cbdde59729431d5a70d71bf9e166b)) +* **arns:** update reserved names to pagaination api ([dacf0c5](https://github.com/ar-io/ar-io-sdk/commit/dacf0c52ac4f77d50e8baf914e520f4c2a8df717)) +* **cjs:** remove ant validation from cjs test ([50b8290](https://github.com/ar-io/ar-io-sdk/commit/50b8290c8d0ecea690fbe317ff4f7703f12cdba6)) +* **errors:** we should be checking the result.Error as well as tags ([7ffe131](https://github.com/ar-io/ar-io-sdk/commit/7ffe131f22bf5aad978ea82e7e81d05ab750b728)) +* **eslint:** remove unnecessary rule config ([03a0552](https://github.com/ar-io/ar-io-sdk/commit/03a05520ab236af7ab7e500990e92157b5adb68f)) +* **getHandlers:** remove redundant check ([b0c9548](https://github.com/ar-io/ar-io-sdk/commit/b0c9548d6c569d43385636ad942e2999b3f99225)) +* **handlers:** update handler name list ([251695e](https://github.com/ar-io/ar-io-sdk/commit/251695ef31304f8b96be230b0cc6a932b33f0f1e)) +* **id and test:** add test for old ant and add lua source id for new code ([77601b2](https://github.com/ar-io/ar-io-sdk/commit/77601b2fc9117a2a4b9ff1226fa3f329e8a74e1d)) +* **io:** add `getDelegations` to `AoIORead` ([7c30c9b](https://github.com/ar-io/ar-io-sdk/commit/7c30c9b6dda8014575ba4f34f59fc4844c0ffe7a)) +* **io:** use helper for computing timestamp ([ffe6ff3](https://github.com/ar-io/ar-io-sdk/commit/ffe6ff3105fe0add3d13d505170237b06750b279)) +* **lint:** ignore underscore vars ([2c84d3d](https://github.com/ar-io/ar-io-sdk/commit/2c84d3d9f11cfcdfd6d487b65566e674be0704cc)) +* **lint:** update lint rule for ignore args ([136e44a](https://github.com/ar-io/ar-io-sdk/commit/136e44af9cb851ee54cac336e32614689a4809e6)) +* **lint:** update linter to allow nullable string ([b985139](https://github.com/ar-io/ar-io-sdk/commit/b985139a40bed20c49eb9f25c016153ac6cfba6c)) +* **lua id:** rollback lua id ([89b8392](https://github.com/ar-io/ar-io-sdk/commit/89b83925778a3a9528f8a61c2c542cadb7bac0f8)) +* **primary:** add additional ANT handlers for primary names ([c98b136](https://github.com/ar-io/ar-io-sdk/commit/c98b13632fe05e960b166098fb3c8a060a017746)) +* **readme:** make api headers h4 ([395f7fb](https://github.com/ar-io/ar-io-sdk/commit/395f7fb01927cc0a247b521d0f992eef00278348)) +* **readme:** update readme with new apis on ant class ([bce76d2](https://github.com/ar-io/ar-io-sdk/commit/bce76d2c4315ad8ab31e604ac23680c04d7f7141)) +* **readme:** use real outputs in example ([1529f79](https://github.com/ar-io/ar-io-sdk/commit/1529f795824a7b8352a47d2ee4f8a9048ba4fb91)) +* **setLogo:** call param txId instead of logo ([cda5e1d](https://github.com/ar-io/ar-io-sdk/commit/cda5e1d892d84a2160f72874833f518024aebf5d)) +* **source id:** name the source id tags the same on evolve and spawn ([058c829](https://github.com/ar-io/ar-io-sdk/commit/058c82909ed424c1ae6fd07b8abb955bea5053ba)) +* **spawn:** add lua source id to spawn ([8850ed2](https://github.com/ar-io/ar-io-sdk/commit/8850ed2eb83a4a52e2e41ce8ef47628ba612a43b)) +* **test:** remove old test for validate ([14a77dc](https://github.com/ar-io/ar-io-sdk/commit/14a77dc61425c3c85ce11815adf719473d35c2e6)) +* **tests:** add test for old ant ([0489cb6](https://github.com/ar-io/ar-io-sdk/commit/0489cb6924b68c19b8791cc47e0f7c1589be842f)) +* **tests:** add unit tests for util and move parsing of records to uitl ([2d08c9a](https://github.com/ar-io/ar-io-sdk/commit/2d08c9a18f1916db3d64be5af494fb4013b347c5)) +* **tests:** update ANT in tests to use v8 ant ([1eff8a9](https://github.com/ar-io/ar-io-sdk/commit/1eff8a97ab7179fb1d4e0ff68924480f360ee52c)) +* **types:** modify AoDelegation type ([18bb755](https://github.com/ar-io/ar-io-sdk/commit/18bb755c8a688060ea19ae9711888d0d53f1041f)) +* **types:** restructure type construction ([2ef04db](https://github.com/ar-io/ar-io-sdk/commit/2ef04db418874feadfc010e79efec5b3d7866dd7)) +* **validation util:** remove validation util ([d803e59](https://github.com/ar-io/ar-io-sdk/commit/d803e5996ee847fc30414e00a8cc2c8ac04de1be)) +* **validator:** add comments and reformat into a more clear loop for creating the validation config ([ea3e70c](https://github.com/ar-io/ar-io-sdk/commit/ea3e70c0b5eac258736f0e9088f3c4cdf1f7d767)) +* **vaults:** add API for gateway vaults ([923b2cd](https://github.com/ar-io/ar-io-sdk/commit/923b2cd4d604d5a3e5d773390feda278d41dbd00)) + + +### Features + +* **delegations:** add getter for staked and vaulted delegations PE-7093 ([7182942](https://github.com/ar-io/ar-io-sdk/commit/7182942ca737f86e94dc35423c71cd2bc6412f1d)) +* **delegations:** add SDK function to retrieve an address's delegations PE-7093 ([07c9107](https://github.com/ar-io/ar-io-sdk/commit/07c910786d4fd4d95b463a9eb28121149e66eb8a)) +* **getRecords:** update getRecords to return as flat array of objects ([b9808c1](https://github.com/ar-io/ar-io-sdk/commit/b9808c117cd55a1ce92eb338a07fc07395a867fd)) +* **io:** add `getAllowedDelegates` to IO ([7d143e0](https://github.com/ar-io/ar-io-sdk/commit/7d143e0e5b5d92fb647d1b91ad4c6b13ad0da04f)) +* **PE-6910:** support primary name APIs ([6ace606](https://github.com/ar-io/ar-io-sdk/commit/6ace6060f8b98e93229f4612cd976c463609ed92)) +* **PE-6910:** support primary name APIs ([82a5b44](https://github.com/ar-io/ar-io-sdk/commit/82a5b4414807447fe0ebb340f0085b5731cab0e3)) +* **redelegate stake:** init IO methods PE-7159 ([7539dd2](https://github.com/ar-io/ar-io-sdk/commit/7539dd2edd0e4eae0c08515e0a3001eacada647c)) +* **setLogo:** add set logo api to ant class ([c5812b1](https://github.com/ar-io/ar-io-sdk/commit/c5812b1bdeb66212f4ba398ba3c19645962a1725)) +* **util:** move validation util to ant class ([cad7149](https://github.com/ar-io/ar-io-sdk/commit/cad714987a37ed9cf5ee0246cc745faab1915e33)) +* **validation util:** simplify validation util ([cd57929](https://github.com/ar-io/ar-io-sdk/commit/cd579290d6b6230fcbe4274ee84eea5f27eb9108)) +* **validations:** add write validation util ([69fc131](https://github.com/ar-io/ar-io-sdk/commit/69fc13173daee4124e21f74aeab1ca85db5418f5)) + # [2.4.0](https://github.com/ar-io/ar-io-sdk/compare/v2.3.2...v2.4.0) (2024-11-12)