Skip to content

Commit 2938a39

Browse files
committed
chore(release): 14.1.0
1 parent 1cd1287 commit 2938a39

23 files changed

+93
-54
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Usage guides:
4343

4444
There are also [examples](examples/README.md) that you can directly use and play with.
4545

46-
### [API Reference](https://sdk.aeternity.io/v14.0.0/api/)
46+
### [API Reference](https://sdk.aeternity.io/v14.1.0/api/)
4747

4848
## CLI - Command Line Interface
4949

docs/CHANGELOG.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,43 @@
22

33
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.
44

5+
## [14.1.0](https://github.com/aeternity/aepp-sdk-js/compare/v14.0.0...v14.1.0) (2025-04-29)
6+
7+
### Features
8+
9+
- **account:** add sync versions of AccountMnemonicFactory methods ([1d60eac](https://github.com/aeternity/aepp-sdk-js/commit/1d60eac5206cbd283003f58a8ab1e397a3e03cf1))
10+
- **account:** detect MetaMask over EIP-6963 ([9e74b53](https://github.com/aeternity/aepp-sdk-js/commit/9e74b53918385c0aff93976c73336781288b37ce))
11+
- **account:** experimental support of Ledger app v1.0.0 ([0116d74](https://github.com/aeternity/aepp-sdk-js/commit/0116d74fbcda28b1fcb5012dd44ff883dcf6971c))
12+
- **account:** init AccountMnemonicFactory by seed ([fe74643](https://github.com/aeternity/aepp-sdk-js/commit/fe74643fb925768669fae8db28dfbcd68fbd2722))
13+
- add `ensureEncoded`, `isEncoded`; deprecate `isAddressValid` ([5a11dc3](https://github.com/aeternity/aepp-sdk-js/commit/5a11dc34b0e8b577a937ed79b6ede1d4e3b412c8))
14+
- add `hashMessage`, deprecate `messageToHash` ([5306e6b](https://github.com/aeternity/aepp-sdk-js/commit/5306e6bedec3b7fe1a5f9ddb47695e4d99ca9705))
15+
- add `verifyMessageSignature`, deprecate `verifyMessage` ([f862b67](https://github.com/aeternity/aepp-sdk-js/commit/f862b67ccd55457a256ff7da3db5a087725ca89e))
16+
- add `verifySignature`, deprecate `verify` ([a4a0232](https://github.com/aeternity/aepp-sdk-js/commit/a4a02329ea485eae39c7b176a5653e1a1df1b520))
17+
- **aens:** add `getAuctionState` to Name ([4150890](https://github.com/aeternity/aepp-sdk-js/commit/4150890bb177e371a417d903fff9dbcdb4ba3a97))
18+
- **aens:** add `id` getter to Name ([8700534](https://github.com/aeternity/aepp-sdk-js/commit/8700534d629053760fd44d4029fefd28cd9e7d5f))
19+
- **aens:** add `isName`, deprecate `isNameValid` ([88c242a](https://github.com/aeternity/aepp-sdk-js/commit/88c242ab73a01043827abdb4a82ac491a8379052))
20+
- **aens:** allow to pass salt between Name while claiming ([c8dc8cc](https://github.com/aeternity/aepp-sdk-js/commit/c8dc8ccce578b8b887574216696cee35ed665ebe))
21+
- **node:** add Hyperchain endpoints ([05fcdfd](https://github.com/aeternity/aepp-sdk-js/commit/05fcdfd0fec517d96b4b55d2993d6aaeeccead58))
22+
- **node:** ignore consensus protocol version if `ignoreVersion` set ([e2f83d6](https://github.com/aeternity/aepp-sdk-js/commit/e2f83d6630f09f8eb1a9835d666b1d1781285cb0))
23+
- **node:** warn if incompatible version when `ignoreVersion` set ([2d6c59d](https://github.com/aeternity/aepp-sdk-js/commit/2d6c59de151a9c77b83b7c66ca15846fcd0f05c0))
24+
- **oracle:** add `getQueries` to OracleBase ([0af61da](https://github.com/aeternity/aepp-sdk-js/commit/0af61da9c2a229aa6459881f601aa5479b39fe84))
25+
- show function name along its hash if missed in bytecode ([2727713](https://github.com/aeternity/aepp-sdk-js/commit/2727713e2d56297ee017b8898b50281a731c6d00))
26+
27+
### Bug Fixes
28+
29+
- **account:** add `unsafeSign`, deprecate `sign` ([b0288cc](https://github.com/aeternity/aepp-sdk-js/commit/b0288cc4dec47e1b3bdaf68a653fc001b2a823ab))
30+
- **account:** implicitly connect to Aeternity snap, clean up flow ([e347d25](https://github.com/aeternity/aepp-sdk-js/commit/e347d2512678342850057335da32b249d3ff7bf0))
31+
- **aens:** `computeAuctionEndBlock` returns value according to Ceres ([3b2f20c](https://github.com/aeternity/aepp-sdk-js/commit/3b2f20c98416639f33a8c95e63794e05888882c6))
32+
- **aens:** handle `highestBid` as BigInt in auction details ([847bfa6](https://github.com/aeternity/aepp-sdk-js/commit/847bfa63de5a3b8a66525b46ab54ed1e64bd43f5))
33+
- **aens:** make `getState`'s options override instance options ([2e0d672](https://github.com/aeternity/aepp-sdk-js/commit/2e0d672c790cd40b15c2ffcc0e6e504c1cfb023a))
34+
- **aens:** mark `started_at` as required in auction details ([fba1012](https://github.com/aeternity/aepp-sdk-js/commit/fba1012cd493f2855dbbeb453cc183adddf1ce10))
35+
- **chain:** set correct poll interval on hyperchain ([0454c62](https://github.com/aeternity/aepp-sdk-js/commit/0454c62a50677ab7ec044266450e3fb96dd284e8))
36+
- **contract:** type checking of contract call return value ([4c8926b](https://github.com/aeternity/aepp-sdk-js/commit/4c8926b6c4b72cc6fca8608162ebe71dd7bc7ec7))
37+
- **middleware:** generate api based on 1.97.1 ([359c17a](https://github.com/aeternity/aepp-sdk-js/commit/359c17a9afd6741e25b8c838e4d8605e98e2a2b4))
38+
- **node,middleware:** more strict enum handling ([d3c5f0f](https://github.com/aeternity/aepp-sdk-js/commit/d3c5f0f2190a9dd1f1386c7a8910e99663066263))
39+
- **tx-builder:** replace OracleResponseTx with OracleRespondTx ([19ec9b3](https://github.com/aeternity/aepp-sdk-js/commit/19ec9b366b5d2308eceb61cc43651440d136bb1e))
40+
- **wallet:** don't require `debug` flag in BrowserRuntimeConnection ([997db99](https://github.com/aeternity/aepp-sdk-js/commit/997db993dc2b2b2d6e7c381b25a50a0e733a58d9))
41+
542
## [14.0.0](https://github.com/aeternity/aepp-sdk-js/compare/v13.3.3...v14.0.0) (2024-10-20)
643

744
### ⚠ BREAKING CHANGES

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ In case you're not using any JS bundling/compilation technique, the SDK can also
1616
<script src="https://unpkg.com/@aeternity/aepp-sdk@VERSION/dist/aepp-sdk.browser-script.cjs"></script>
1717
```
1818

19-
...where `VERSION` is the version number of the SDK you want to use (eg. `14.0.0`).
19+
...where `VERSION` is the version number of the SDK you want to use (eg. `14.1.0`).
2020

2121
### Browser `<script>` tag
2222

@@ -134,7 +134,7 @@ You can find both approaches used in the [æpp example].
134134
[not compatible]: https://github.com/tc39/proposal-class-fields/issues/106
135135
[shallowRef]: https://vuejs.org/api/reactivity-advanced.html#shallowref
136136
[toRaw]: https://vuejs.org/api/reactivity-advanced.html#toraw
137-
[æpp example]: https://github.com/aeternity/aepp-sdk-js/blob/ec3b888c653138d5a369b37604bf916428884170/examples/browser/aepp
137+
[æpp example]: https://github.com/aeternity/aepp-sdk-js/blob/1cd128798018d98bdd41eff9104442b44b385d46/examples/browser/aepp
138138

139139
## Command Line Interface (CLI)
140140

docs/contrib/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ aepp-sdk is transpiled to EcmaScript 5 through [WebPack](https://webpack.js.org/
4646

4747
## Documenting
4848

49-
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.
49+
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.
5050

5151
```bash
5252
#generate examples and api documentation

docs/guides/build-wallet.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This guide shows how to build either an **WebExtension Wallet** or a **iFrame-ba
66

77
The full implementation of this example can be found here:
88

9-
- [WebExtension Wallet Example](https://github.com/aeternity/aepp-sdk-js/blob/568c291b92c030011ca9e68169f328be6ff79488/examples/browser/wallet-web-extension)
9+
- [WebExtension Wallet Example](https://github.com/aeternity/aepp-sdk-js/blob/1cd128798018d98bdd41eff9104442b44b385d46/examples/browser/wallet-web-extension)
1010

1111
Note:
1212

@@ -16,19 +16,19 @@ Note:
1616

1717
First you need to create a bridge between your extension and the page. This can be done as follows:
1818

19-
https://github.com/aeternity/aepp-sdk-js/blob/568c291b92c030011ca9e68169f328be6ff79488/examples/browser/wallet-web-extension/src/content-script.js#L1-L30
19+
https://github.com/aeternity/aepp-sdk-js/blob/1cd128798018d98bdd41eff9104442b44b385d46/examples/browser/wallet-web-extension/src/content-script.js#L1-L30
2020

2121
### 2. Initialize `AeSdkWallet` class
2222

2323
Then you need to initialize `AeSdkWallet` class in your extension and subscribe for new `runtime` connections.
2424
After the connection is established you can share the wallet details with the application.
2525

26-
https://github.com/aeternity/aepp-sdk-js/blob/568c291b92c030011ca9e68169f328be6ff79488/examples/browser/wallet-web-extension/src/background.js#L1-L163
26+
https://github.com/aeternity/aepp-sdk-js/blob/1cd128798018d98bdd41eff9104442b44b385d46/examples/browser/wallet-web-extension/src/background.js#L1-L163
2727

2828
## iFrame-based Wallet
2929

3030
The **iFrame-based** approach works similar to the **WebExtension** approach except that the `connectionProxy` in between isn't needed.
3131

3232
You can take a look into the implementation of the following example to see how it works:
3333

34-
- [iFrame-based Wallet Example](https://github.com/aeternity/aepp-sdk-js/blob/568c291b92c030011ca9e68169f328be6ff79488/examples/browser/wallet-iframe)
34+
- [iFrame-based Wallet Example](https://github.com/aeternity/aepp-sdk-js/blob/1cd128798018d98bdd41eff9104442b44b385d46/examples/browser/wallet-iframe)

docs/guides/connect-aepp-to-wallet.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ This guide describes the 4 steps that are necessary to connect your application
99

1010
## 1. Specify imports and constants
1111

12+
<!-- deprecated approach, needs to be fully updated -->
13+
1214
https://github.com/aeternity/aepp-sdk-js/blob/f60d1b8a1124b32781769342e4941c8dacf6ad53/examples/browser/aepp/src/StoreAeSdkPlugin.js#L1-L5
1315

1416
## 2. Initialize the `AeSdkAepp` class

docs/guides/contracts.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,21 @@ import { AeSdk, AccountMemory, Node } from '@aeternity/aepp-sdk';
2020

2121
Compiler primarily used to generate bytecode to deploy a contract.
2222
Skip this step if you have a contract bytecode or need to interact with an already deployed contract.
23-
Out-of-the-box SDK supports [aesophia_cli](https://github.com/aeternity/aesophia_cli) and [aesophia_http](https://github.com/aeternity/aesophia_http) implemented in [CompilerCli](https://sdk.aeternity.io/v14.0.0/api/classes/CompilerCli.html) and [CompilerHttp](https://sdk.aeternity.io/v14.0.0/api/classes/CompilerHttp.html) respectively.
23+
Out-of-the-box SDK supports [aesophia_cli](https://github.com/aeternity/aesophia_cli) and [aesophia_http](https://github.com/aeternity/aesophia_http) implemented in [CompilerCli](https://sdk.aeternity.io/v14.1.0/api/classes/CompilerCli.html) and [CompilerHttp](https://sdk.aeternity.io/v14.1.0/api/classes/CompilerHttp.html) respectively.
2424

2525
CompilerCli is available only in Node.js and requires Erlang installed (`escript` available in `$PATH`), Windows is supported.
2626

2727
```js
2828
const compiler = new CompilerCli();
2929
```
3030

31-
CompilerHttp requires a hosted compiler service. Preferable to host your own compiler service since [compiler.aepps.com](https://v8.compiler.aepps.com/api) is planned to be decommissioned. An example of how to run it using [docker-compose](https://github.com/aeternity/aepp-sdk-js/blob/568c291b92c030011ca9e68169f328be6ff79488/docker-compose.yml#L20-L25).
31+
CompilerHttp requires a hosted compiler service. Preferable to host your own compiler service since [compiler.aepps.com](https://v8.compiler.aepps.com/api) is planned to be decommissioned. An example of how to run it using [docker-compose](https://github.com/aeternity/aepp-sdk-js/blob/1cd128798018d98bdd41eff9104442b44b385d46/docker-compose.yml#L20-L25).
3232

3333
```js
3434
const compiler = new CompilerHttp('https://v8.compiler.aepps.com'); // host your own compiler
3535
```
3636

37-
Both compiler classes implement the [same interface](https://sdk.aeternity.io/v14.0.0/api/classes/CompilerBase.html) that can be used to generate bytecode and ACI without a Contract instance.
37+
Both compiler classes implement the [same interface](https://sdk.aeternity.io/v14.1.0/api/classes/CompilerBase.html) that can be used to generate bytecode and ACI without a Contract instance.
3838

3939
## 3. Create an instance of the SDK
4040

@@ -242,8 +242,8 @@ Refer to [its documentation](https://www.npmjs.com/package/@aeternity/aepp-calld
242242

243243
## Generate file system object in Node.js
244244

245-
To do so you can use [getFileSystem](https://sdk.aeternity.io/v14.0.0/api/functions/getFileSystem.html) function.
245+
To do so you can use [getFileSystem](https://sdk.aeternity.io/v14.1.0/api/functions/getFileSystem.html) function.
246246
In most cases, you don't need to do it explicitly. Prefer to use `sourceCodePath` instead `sourceCode` in
247-
[Contract::initialize](https://sdk.aeternity.io/v14.0.0/api/classes/_internal_.Contract.html#initialize),
248-
and [compile](https://sdk.aeternity.io/v14.0.0/api/classes/CompilerBase.html#compile)
249-
instead [compileBySourceCode](https://sdk.aeternity.io/v14.0.0/api/classes/CompilerBase.html#compileBySourceCode) in CompilerBase.
247+
[Contract::initialize](https://sdk.aeternity.io/v14.1.0/api/classes/_internal_.Contract.html#initialize),
248+
and [compile](https://sdk.aeternity.io/v14.1.0/api/classes/CompilerBase.html#compile)
249+
instead [compileBySourceCode](https://sdk.aeternity.io/v14.1.0/api/classes/CompilerBase.html#compileBySourceCode) in CompilerBase.

docs/guides/error-handling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Error Handling
22

3-
This guide shows you how to handle errors originating from the SDK. SDK by default exports the following error classes from file [errors.ts](https://github.com/aeternity/aepp-sdk-js/blob/568c291b92c030011ca9e68169f328be6ff79488/src/utils/errors.ts)
3+
This guide shows you how to handle errors originating from the SDK. SDK by default exports the following error classes from file [errors.ts](https://github.com/aeternity/aepp-sdk-js/blob/1cd128798018d98bdd41eff9104442b44b385d46/src/utils/errors.ts)
44

55
## Error Hierarchy
66

docs/guides/ledger-wallet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ console.log(await account.signTransaction('tx_...')); // 'tx_...' (with signatur
3333

3434
The private key for the account would be derived on the Ledger device using the provided index and the mnemonic phrase it was initialized with. The private key won't leave the device.
3535

36-
The complete examples of how to use it in nodejs and browser can be found [here](https://github.com/aeternity/aepp-sdk-js/blob/568c291b92c030011ca9e68169f328be6ff79488/test/environment/ledger).
36+
The complete examples of how to use it in nodejs and browser can be found [here](https://github.com/aeternity/aepp-sdk-js/blob/1cd128798018d98bdd41eff9104442b44b385d46/test/environment/ledger).
3737

3838
## Account verification
3939

docs/guides/low-vs-high-usage.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The aeternity node exposes [a REST API]. This API is described in the [OpenAPI d
1212

1313
[a REST API]: https://api-docs.aeternity.io/
1414
[OpenAPI document]: https://mainnet.aeternity.io/api?oas3
15-
[node]: https://sdk.aeternity.io/v14.0.0/api/classes/Node.html
15+
[node]: https://sdk.aeternity.io/v14.1.0/api/classes/Node.html
1616

1717
So to get a transaction based on its hash you would invoke `node.getTransactionByHash('th_fWEsg152BNYcrqA9jDh9VVpacYojCUb1yu45zUnqhmQ3dAAC6')`. In this way the SDK is simply a mapping of the raw API calls into JavaScript.
1818

@@ -21,18 +21,18 @@ So to get a transaction based on its hash you would invoke `node.getTransactionB
2121
Any blockchain state change requires signing a transaction. Transaction should be built according to the [protocol]. SDK implements it in [`buildTx`][buildTx], [`buildTxAsync`][buildTxAsync], and [`unpackTx`][unpackTx]. [`buildTxAsync`][buildTxAsync] requires fewer arguments than [`buildTx`][buildTx], but it expects the node instance provided in arguments.
2222

2323
[protocol]: https://github.com/aeternity/protocol/blob/c007deeac4a01e401238412801ac7084ac72d60e/serializations.md#accounts-version-1-basic-accounts
24-
[buildTx]: https://sdk.aeternity.io/v14.0.0/api/functions/buildTx.html
25-
[buildTxAsync]: https://sdk.aeternity.io/v14.0.0/api/functions/buildTxAsync.html
26-
[unpackTx]: https://sdk.aeternity.io/v14.0.0/api/functions/unpackTx.html
24+
[buildTx]: https://sdk.aeternity.io/v14.1.0/api/functions/buildTx.html
25+
[buildTxAsync]: https://sdk.aeternity.io/v14.1.0/api/functions/buildTxAsync.html
26+
[unpackTx]: https://sdk.aeternity.io/v14.1.0/api/functions/unpackTx.html
2727

2828
## High-level SDK usage (preferable)
2929

3030
Example spend call, using æternity's SDK abstraction:
3131

32-
https://github.com/aeternity/aepp-sdk-js/blob/cb80689a4aa10c3f3f0f57494c825533bbe6d01e/examples/node/_api-high-level.js#L1-L18
32+
https://github.com/aeternity/aepp-sdk-js/blob/1cd128798018d98bdd41eff9104442b44b385d46/examples/node/_api-high-level.js#L1-L18
3333

3434
## Low-level SDK usage
3535

3636
The same spend execution, but using low-level SDK functions:
3737

38-
https://github.com/aeternity/aepp-sdk-js/blob/cb80689a4aa10c3f3f0f57494c825533bbe6d01e/examples/node/_api-low-level.js#L1-L19
38+
https://github.com/aeternity/aepp-sdk-js/blob/1cd128798018d98bdd41eff9104442b44b385d46/examples/node/_api-low-level.js#L1-L19

0 commit comments

Comments
 (0)