Merge pull request #2092 from aeternity/release/14.1.0

Release v14.1.0

Author: davidyuk

.eslintrc.cjs

@@ -20,6 +20,7 @@ module.exports = {
     'es',
     'src/apis',
     'docs/api',
+    'test/assets',
     'test/environment/ledger/browser',
     'docs/examples',
     'site',

.github/workflows/main.yml

@@ -25,12 +25,9 @@ jobs:
       - run: npm run lint
       - run: npm run docs:examples && npm run docs:api && ./docs/build-assets.sh
         if: contains(github.event.pull_request.title, 'Release')
-      - run: docker compose up -d --wait
-      - run: npx nyc npm test
-      - run: npx nyc report --reporter=text-lcov > coverage.lcov
-      - uses: codecov/codecov-action@v4
-        with:
-          files: coverage.lcov
+      - run: docker compose up -d --wait --quiet-pull
+      - run: npx c8 npm test
+      - uses: codecov/codecov-action@v5
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       - run: docker compose logs

.gitignore

@@ -1,26 +1,13 @@
 node_modules
-/test-results.xml
-.tern-port
-.tern-project
-.dir-locals.el
 /dist
 /es
-/docs/api.md
-/docs/api/*
+/docs/api
 /docs/examples
 /docs/public
-/docs/docco.css
 __pycache__
-/.envrc
-/yarn-error.log
 .idea
-/docker-compose.override.yml
-/pnpm-debug.log
-.vscode/
-debug/
+.vscode
 /coverage
-coverage.*
-.nyc_output/
 /**/package-lock.json
 /**/dist
 /examples/**/artifacts

LICENSE

@@ -1,5 +1,5 @@
 ISC License (ISC)
-Copyright © 2024 aeternity developers
+Copyright © 2025 aeternity developers
 
 Permission to use, copy, modify, and/or distribute this software for any purpose
 with or without fee is hereby granted, provided that the above copyright notice

README.md

@@ -27,15 +27,24 @@ Usage guides:
 - [Contract Events](docs/guides/contract-events.md)
 - [Oracles](docs/guides/oracles.md)
 - [PayingForTx](docs/guides/paying-for-tx.md) (Meta-Transactions)
-- [Batch Transactions](docs/guides//batch-requests.md)
+- [Batch Transactions](docs/guides/batch-requests.md)
 - [Error Handling](docs/guides/error-handling.md)
 - [Low vs High level API](docs/guides/low-vs-high-usage.md)
+- [Typed data hashing and signing](docs/guides/typed-data.md)
+- [Usage with TypeScript](docs/guides/typescript.md)
+- [JWT usage](docs/guides/jwt.md)
+- [Transaction options](docs/transaction-options.md)
+- [Range of possible address length](docs/guides/address-length.md)
 - Wallet Interaction
   - [Connect an æpp to a wallet](docs/guides/connect-aepp-to-wallet.md)
   - [How to build a wallet](docs/guides/build-wallet.md)
+  - [Ledger Hardware Wallet](docs/guides/ledger-wallet.md)
+  - [Aeternity snap for MetaMask](docs/guides/metamask-snap.md)
 
 There are also [examples](examples/README.md) that you can directly use and play with.
 
+### [API Reference](https://sdk.aeternity.io/v14.1.0/api/)
+
 ## CLI - Command Line Interface
 
 To quickly test _all_ of æternity's blockchain features from your terminal, you can install and use the [CLI](https://github.com/aeternity/aepp-cli-js) by running:
@@ -50,20 +59,3 @@ For advanced use, to get a deeper understanding of the SDK or to contribute to i
 ## Changelog
 
 We keep our [Changelog](docs/CHANGELOG.md) up to date.
-
-## License
-
-ISC License (ISC)
-Copyright © 2024 æternity developers
-
-Permission to use, copy, modify, and/or distribute this software for any purpose
-with or without fee is hereby granted, provided that the above copyright notice
-and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
-FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
-OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
-TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
-THIS SOFTWARE.

docker-compose.yml

@@ -1,7 +1,7 @@
 services:
   node:
     # TODO: switch to master after merging https://github.com/aeternity/aeternity/pull/4303
-    image: aeternity/aeternity:v7.2.0-bundle
+    image: aeternity/aeternity:v7.3.0-rc5-bundle
     # TODO: remove 3313 port after merging https://github.com/aeternity/aeternity/pull/4303
     ports: [3013:3013, 3113:3113, 3014:3014, 3313:3313]
     # TODO: remove after releasing https://github.com/aeternity/aeternity/pull/4292
@@ -26,7 +26,7 @@ services:
 
   middleware:
     # TODO: use upstream after solving https://github.com/aeternity/ae_mdw/issues/1758
-    image: davidyuk/temp:mdw-dev-mode-1.81.0
+    image: davidyuk/temp:mdw-dev-mode-1.97.1-oas-fix
     ports: [4000:4000, 4001:4001, 4013:3013, 4014:3014, 4313:3313]
     volumes:
       - ./docker/middleware.yaml:/home/aeternity/aeternity.yaml

docs/CHANGELOG.md

@@ -2,11 +2,48 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [14.1.0](https://github.com/aeternity/aepp-sdk-js/compare/v14.0.0...v14.1.0) (2025-04-29)
+
+### Features
+
+- **account:** add sync versions of AccountMnemonicFactory methods ([1d60eac](https://github.com/aeternity/aepp-sdk-js/commit/1d60eac5206cbd283003f58a8ab1e397a3e03cf1))
+- **account:** detect MetaMask over EIP-6963 ([9e74b53](https://github.com/aeternity/aepp-sdk-js/commit/9e74b53918385c0aff93976c73336781288b37ce))
+- **account:** experimental support of Ledger app v1.0.0 ([0116d74](https://github.com/aeternity/aepp-sdk-js/commit/0116d74fbcda28b1fcb5012dd44ff883dcf6971c))
+- **account:** init AccountMnemonicFactory by seed ([fe74643](https://github.com/aeternity/aepp-sdk-js/commit/fe74643fb925768669fae8db28dfbcd68fbd2722))
+- **account:** add `unsafeSign`, deprecate `sign` ([b0288cc](https://github.com/aeternity/aepp-sdk-js/commit/b0288cc4dec47e1b3bdaf68a653fc001b2a823ab))
+- add `ensureEncoded`, `isEncoded`; deprecate `isAddressValid` ([5a11dc3](https://github.com/aeternity/aepp-sdk-js/commit/5a11dc34b0e8b577a937ed79b6ede1d4e3b412c8))
+- add `hashMessage`, deprecate `messageToHash` ([5306e6b](https://github.com/aeternity/aepp-sdk-js/commit/5306e6bedec3b7fe1a5f9ddb47695e4d99ca9705))
+- add `verifyMessageSignature`, deprecate `verifyMessage` ([f862b67](https://github.com/aeternity/aepp-sdk-js/commit/f862b67ccd55457a256ff7da3db5a087725ca89e))
+- add `verifySignature`, deprecate `verify` ([a4a0232](https://github.com/aeternity/aepp-sdk-js/commit/a4a02329ea485eae39c7b176a5653e1a1df1b520))
+- **aens:** add `getAuctionState` to Name ([4150890](https://github.com/aeternity/aepp-sdk-js/commit/4150890bb177e371a417d903fff9dbcdb4ba3a97))
+- **aens:** add `id` getter to Name ([8700534](https://github.com/aeternity/aepp-sdk-js/commit/8700534d629053760fd44d4029fefd28cd9e7d5f))
+- **aens:** add `isName`, deprecate `isNameValid` ([88c242a](https://github.com/aeternity/aepp-sdk-js/commit/88c242ab73a01043827abdb4a82ac491a8379052))
+- **aens:** allow to pass salt between Name while claiming ([c8dc8cc](https://github.com/aeternity/aepp-sdk-js/commit/c8dc8ccce578b8b887574216696cee35ed665ebe))
+- **node:** add Hyperchain endpoints ([05fcdfd](https://github.com/aeternity/aepp-sdk-js/commit/05fcdfd0fec517d96b4b55d2993d6aaeeccead58))
+- **node:** ignore consensus protocol version if `ignoreVersion` set ([e2f83d6](https://github.com/aeternity/aepp-sdk-js/commit/e2f83d6630f09f8eb1a9835d666b1d1781285cb0))
+- **node:** warn if incompatible version when `ignoreVersion` set ([2d6c59d](https://github.com/aeternity/aepp-sdk-js/commit/2d6c59de151a9c77b83b7c66ca15846fcd0f05c0))
+- **oracle:** add `getQueries` to OracleBase ([0af61da](https://github.com/aeternity/aepp-sdk-js/commit/0af61da9c2a229aa6459881f601aa5479b39fe84))
+- **contract:** show function name along its hash if missed in bytecode ([2727713](https://github.com/aeternity/aepp-sdk-js/commit/2727713e2d56297ee017b8898b50281a731c6d00))
+
+### Bug Fixes
+
+- **account:** implicitly connect to Aeternity snap, clean up flow ([e347d25](https://github.com/aeternity/aepp-sdk-js/commit/e347d2512678342850057335da32b249d3ff7bf0))
+- **aens:** `computeAuctionEndBlock` returns value according to Ceres ([3b2f20c](https://github.com/aeternity/aepp-sdk-js/commit/3b2f20c98416639f33a8c95e63794e05888882c6))
+- **aens:** handle `highestBid` as BigInt in auction details ([847bfa6](https://github.com/aeternity/aepp-sdk-js/commit/847bfa63de5a3b8a66525b46ab54ed1e64bd43f5))
+- **aens:** make `getState`'s options override instance options ([2e0d672](https://github.com/aeternity/aepp-sdk-js/commit/2e0d672c790cd40b15c2ffcc0e6e504c1cfb023a))
+- **aens:** mark `started_at` as required in auction details ([fba1012](https://github.com/aeternity/aepp-sdk-js/commit/fba1012cd493f2855dbbeb453cc183adddf1ce10))
+- **chain:** set correct poll interval on hyperchain ([0454c62](https://github.com/aeternity/aepp-sdk-js/commit/0454c62a50677ab7ec044266450e3fb96dd284e8))
+- **contract:** type checking of contract call return value ([4c8926b](https://github.com/aeternity/aepp-sdk-js/commit/4c8926b6c4b72cc6fca8608162ebe71dd7bc7ec7))
+- **middleware:** generate api based on 1.97.1 ([359c17a](https://github.com/aeternity/aepp-sdk-js/commit/359c17a9afd6741e25b8c838e4d8605e98e2a2b4))
+- **node,middleware:** more strict enum handling ([d3c5f0f](https://github.com/aeternity/aepp-sdk-js/commit/d3c5f0f2190a9dd1f1386c7a8910e99663066263))
+- **tx-builder:** replace OracleResponseTx with OracleRespondTx ([19ec9b3](https://github.com/aeternity/aepp-sdk-js/commit/19ec9b366b5d2308eceb61cc43651440d136bb1e))
+- **wallet:** don't require `debug` flag in BrowserRuntimeConnection ([997db99](https://github.com/aeternity/aepp-sdk-js/commit/997db993dc2b2b2d6e7c381b25a50a0e733a58d9))
+
 ## [14.0.0](https://github.com/aeternity/aepp-sdk-js/compare/v13.3.3...v14.0.0) (2024-10-20)
 
 ### ⚠ BREAKING CHANGES
 
-Please check out the [migration guide](./guides/migration/14.md) and a [tool](https://docs.aeternity.com/aepp-sdk-js/develop/examples/browser/tools/) to convert to convert secret keys.
+Please check out the [migration guide](./guides/migration/14.md) and a [tool](https://sdk.aeternity.io/v14.0.0/examples/browser/tools/) to convert to convert secret keys.
 
 - CommonJS bundles have cjs extension instead js
 - **aepp:** AeSdkWallet requires `onAskToSelectNetwork` constructor option

docs/README.md

@@ -16,7 +16,7 @@ In case you're not using any JS bundling/compilation technique, the SDK can also
 <script src="https://unpkg.com/@aeternity/aepp-sdk@VERSION/dist/aepp-sdk.browser-script.cjs"></script>
 ```
 
-...where `VERSION` is the version number of the SDK you want to use (eg. `14.0.0`).
+...where `VERSION` is the version number of the SDK you want to use (eg. `14.1.0`).
 
 ### Browser `<script>` tag
 
@@ -116,21 +116,25 @@ module.exports = {
 ### Vue@3
 
 Reactivity in Vue@3 [based on] Proxy class. Proxy is [not compatible] with private fields of ES
-classes. AeSdk and Contract classes uses private fields, so if you make an instance of these
+classes. AeSdk, Contract and AccountMemory classes uses private fields, so if you make an instance of these
 classes reactive then the app may fail with
 
 > TypeError: attempted to get private field on non-instance
 
 AeSdk and Contract classes doesn’t have a state intended to be tracked using reactivity. Therefore
-to solve this issue we suggest to avoid making their instances reactive. One of the ways is to use
+to solve this issue we suggest to avoid making their instances reactive using
 Vue's integrated utility: [shallowRef]. The idea is to make reactive only the
-root variable, to don't make it reactive in deep. You can find it implementation in the
-[æpp example].
+instance value, to don't make it reactive in deep.
+
+Alternatively, [toRaw] can unwrap the proxy object, returning an unmodified instance and allowing access to its private properties by its methods. It can be useful if you need a reactive array of AccountMemory.
+
+You can find both approaches used in the [æpp example].
 
 [based on]: https://vuejs.org/guide/extras/reactivity-in-depth.html#how-reactivity-works-in-vue
 [not compatible]: https://github.com/tc39/proposal-class-fields/issues/106
 [shallowRef]: https://vuejs.org/api/reactivity-advanced.html#shallowref
-[æpp example]: https://github.com/aeternity/aepp-sdk-js/blob/568c291b92c030011ca9e68169f328be6ff79488/examples/browser/aepp
+[toRaw]: https://vuejs.org/api/reactivity-advanced.html#toraw
+[æpp example]: https://github.com/aeternity/aepp-sdk-js/blob/1cd128798018d98bdd41eff9104442b44b385d46/examples/browser/aepp
 
 ## Command Line Interface (CLI)
 

docs/contrib/README.md

@@ -46,7 +46,7 @@ aepp-sdk is transpiled to EcmaScript 5 through [WebPack](https://webpack.js.org/
 
 ## Documenting
 
-Apart from documenting features and code, there is also documentation automatically generated using [**TypeDoc**](https://typedoc.org/) for documenting TS files and [a script](https://github.com/aeternity/aepp-sdk-js/blob/568c291b92c030011ca9e68169f328be6ff79488/tooling/docs/examples-to-md.js) for documenting examples and code partials.
+Apart from documenting features and code, there is also documentation automatically generated using [**TypeDoc**](https://typedoc.org/) for documenting TS files and [a script](https://github.com/aeternity/aepp-sdk-js/blob/1cd128798018d98bdd41eff9104442b44b385d46/tooling/docs/examples-to-md.js) for documenting examples and code partials.
 
 ```bash
 #generate examples and api documentation

docs/guides/address-length.md

@@ -5,16 +5,16 @@ base58 it depends on the exact data to encode, e.g. it is shorter if encoded dat
 leading zeroes.
 
 Building an aepp you may need to know the range of possible address lengths to validate an
-user-provided addresses (though better to use [isAddressValid]) or for designs of address-related
+user-provided addresses (though better to use [isEncoded]) or for designs of address-related
 components. Doing manual tests you may conclude that account address length is between 52 and 53
 chars, but it is not correct.
 
 ```js
-import { MemoryAccount } from '@aeternity/aepp-sdk';
+import { AccountMemory } from '@aeternity/aepp-sdk';
 
 const result = new Array(10000)
   .fill()
-  .map(() => MemoryAccount.generate().address.length)
+  .map(() => AccountMemory.generate().address.length)
   .reduce((p, n) => ({ ...p, [n]: (p[n] ?? 0) + 1 }), {});
 
 console.log(result);
@@ -28,9 +28,9 @@ Theoretically there can be even shorter addresses if they lucky to be prefixed w
 sequence of `0`.
 
 ```js
-import { MemoryAccount, Encoding, encode, decode } from '@aeternity/aepp-sdk';
+import { AccountMemory, Encoding, encode, decode } from '@aeternity/aepp-sdk';
 
-const publicKey = decode(MemoryAccount.generate().address);
+const publicKey = decode(AccountMemory.generate().address);
 
 for (let i = -1; i < publicKey.length; i += 1) {
   if (i >= 0) publicKey[i] = 0;
@@ -80,5 +80,5 @@ Running the above code you would get output like
 Therefore the minimum address length is 41 chars. All these addresses valid, for example
 `ak_11111111111111111111111111111111273Yts` [used] to collect AENS name fees.
 
-[isAddressValid]: https://docs.aeternity.com/aepp-sdk-js/v13.2.2/api/functions/isAddressValid.html
+[isEncoded]: https://sdk.aeternity.io/v14.1.0/api/functions/isEncoded.html
 [used]: https://mainnet.aeternity.io/v3/accounts/ak_11111111111111111111111111111111273Yts