Skip to content

Commit 026f050

Browse files
committed
docs(release): reformat migration guide
1 parent 973c663 commit 026f050

File tree

2 files changed

+47
-24
lines changed

2 files changed

+47
-24
lines changed

CHANGELOG.md

Lines changed: 43 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,79 +4,96 @@ All notable changes to this project will be documented in this file. See [standa
44

55
## [6.0.0](https://github.com/aeternity/aepp-cli-js/compare/v5.0.0...v6.0.0) (2024-04-16)
66

7+
*Check out the new documentation at [docs.aeternity.com/aepp-cli-js](https://docs.aeternity.com/aepp-cli-js/)*
78

89
### ⚠ BREAKING CHANGES
910

10-
* **oracle:** `aecli oracle get` removed
11+
#### **oracle:** `aecli oracle get` removed
1112
Use `aecli inspect` instead.
12-
* **oracle:** aecli won't accept already known account address in oracles
13+
14+
#### **oracle:** aecli don't accept already known account address in oracles
1315
Remove extra argument:
1416
```diff
1517
- $ aecli oracle extend ./wallet.json ok_2a1j2Mk9YSmC1gioUq4PWRm3bsv887MbuRVwyv4KaUGoR1eiKi 200
1618
+ $ aecli oracle extend ./wallet.json 200
1719
- $ aecli oracle respond-query ./wallet.json ok_2a1j2Mk9YSmC1gi... oq_6y3N9KqQb74QsvR... +16Degree
1820
+ $ aecli oracle respond-query ./wallet.json oq_6y3N9KqQb74QsvR... +16Degree
1921
```
20-
* **account:** `aecli account verify-message` accepts signer address instead wallet
21-
* **chain:** `aecli chain network_id` removed
22+
23+
#### **account:** `aecli account verify-message` accepts signer address instead wallet
24+
25+
#### **chain:** `aecli chain network_id` removed
2226
Use `aecli chain status` instead.
23-
* Commands don't accept `--no-waitMined` anymore
27+
28+
#### Commands don't accept `--no-waitMined` anymore
2429
In the most cases transactions gets mined immediately. In case of NameClaim, tx needs to be
2530
submitted in the next keyblock after preclaim. In that case it would be mined also immediately,
2631
with no early name revealing.
2732
If still needed, use `aecli chain broadcast tx_... --no-waitMined` instead.
28-
* **account:** `account save` removed
33+
34+
#### **account:** `account save` removed
2935
Use `account create` instead:
3036
```diff
3137
-$ aecli account save ./my-wallet.json <hex secret key>
3238
+$ aecli account create ./my-wallet.json <hex secret key>
3339
```
34-
* **account:** `aecli account spend` renamed to `aecli spend`
35-
* **chain:** aecli connects to mainnet by default
36-
Use
40+
41+
#### **account:** `aecli account spend` renamed to `aecli spend`
42+
43+
#### **chain:** aecli connects to mainnet by default
44+
Use the below to switch back to testnet.
3745
```
3846
$ aecli select-node https://testnet.aeternity.io
3947
```
40-
to switch back to testnet.
41-
* require nodejs@18 or newer
48+
49+
#### require nodejs@18 or newer
4250
Because nodejs@16 is not maintained currently.
43-
* **name:** `name lookup` command removed
51+
52+
#### **name:** `name lookup` command removed
4453
Use `inspect` instead.
4554
```diff
4655
- aecli name lookup <name.chain>
4756
+ aecli inspect <name.chain>
4857
```
49-
* **account:** `account generate` command removed
58+
59+
#### **account:** `account generate` command removed
5060
Use `account create` in a cycle instead.
51-
* **crypto:** `crypto sign` command removed
61+
62+
#### **crypto:** `crypto sign` command removed
5263
Use `account sign` instead.
53-
* **crypto:** `crypto unpack` command removed
64+
65+
#### **crypto:** `crypto unpack` command removed
5466
Use `inspect` instead.
5567
```diff
5668
- aecli crypto unpack <tx-prefixed transaction>
5769
+ aecli inspect <tx-prefixed transaction>
5870
```
59-
* **crypto:** `crypto decode` removed
71+
72+
#### **crypto:** `crypto decode` removed
6073
Use another base58 decoder if necessary.
61-
* **account:** `account balance`, `account nonce` commands removed
74+
75+
#### **account:** `account balance`, `account nonce` commands removed
6276
Use `inspect <ak-address>` instead.
6377
```diff
6478
- aecli account balance wallet.json --password=123
6579
- aecli account nonce wallet.json --password=123
66-
+ address=$(aecli account address wallet.json --json --password=123 | jq -r .publicKey)
80+
+ address=$(aecli account address wallet.json --json | jq -r .publicKey)
6781
+ aecli inspect $address
6882
```
69-
* **account:** remove useless `output` option
70-
* **account:** `account spend` returns unwrapped JSON
83+
84+
#### **account:** remove useless `output` option
85+
86+
#### **account:** `account spend` returns unwrapped JSON
7187
```diff
7288
- aecli account spend ... | jq .tx.tx.amount
73-
+ aecli account spend ... | jq .tx.amount
89+
+ aecli spend ... | jq .tx.amount
7490
```
75-
* **account:** `account transfer` command removed
76-
Use `account spend` instead.
91+
92+
#### **account:** `account transfer` command removed
93+
Use `spend` instead.
7794
```diff
7895
- aecli account transfer 0.42 <recipient>
79-
+ aecli account spend 42% <recipient>
96+
+ aecli spend 42% <recipient>
8097
```
8198

8299
### Features
@@ -107,6 +124,8 @@ Use `account spend` instead.
107124
* **oracle:** remove extra arguments in tx builder, refactor, fix examples ([e3be365](https://github.com/aeternity/aepp-cli-js/commit/e3be36575f32d9c346048e5d0a7495017be0e9d1))
108125

109126

127+
#### Other commits with breaking changes
128+
110129
* **account:** combine `account create` and `account save` ([fdaeeff](https://github.com/aeternity/aepp-cli-js/commit/fdaeeff250c8e267de000b0bb244e07422014553))
111130
* **account:** combine spend and transfer commands ([2a2a94b](https://github.com/aeternity/aepp-cli-js/commit/2a2a94b76a67d96154f45d9da3f1cd1ad338c1b3))
112131
* **account:** move `aecli account spend` to `aecli spend` ([4af1b4c](https://github.com/aeternity/aepp-cli-js/commit/4af1b4ced43a9f6af82d333b9572aed783f5e9f1))

commitlint.config.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ export default {
1414
'oracle',
1515
'release',
1616
'tx-builder',
17+
'inspect',
18+
// TODO: remove 2 after releasing 6.0.0
19+
'crypto',
20+
'name',
1721
],
1822
],
1923
},

0 commit comments

Comments
 (0)