Skip to content

Commit d966c82

Browse files
authored
Merge pull request #271 from aeternity/release/7.0.0
Release 7.0.0
2 parents e3bbf30 + 13a6a5d commit d966c82

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+7223
-5899
lines changed

.editorconfig

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,7 @@ indent_style = space
66
indent_size = 2
77
end_of_line = lf
88
insert_final_newline = true
9-
trim_trailing_whitespace = true
9+
trim_trailing_whitespace = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false

.eslintrc.cjs

Lines changed: 0 additions & 23 deletions
This file was deleted.

.github/ISSUE_TEMPLATE.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
**Note: for support questions, please use the [forum](https://forum.aeternity.com)**. This repository's issues are reserved for feature requests and bug reports.
22

3-
* **Do you want to request a *feature* or report a *bug*?**
3+
- **Do you want to request a _feature_ or report a _bug_?**
44

5-
* **What is the current behavior?**
5+
- **What is the current behavior?**
66

7-
* **If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem**
7+
- **If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem**
88

9-
* **What is the expected behavior?**
9+
- **What is the expected behavior?**
1010

11-
* **What is the motivation / use case for changing the behavior?**
11+
- **What is the motivation / use case for changing the behavior?**
1212

13-
* **Please tell us about your environment:**
13+
- **Please tell us about your environment:**
1414

1515
- CLI Version: v0.0.0
1616
- Node Version: v0.0.0
1717
- NPM Version: v0.0.0
1818
- Protocol Version: 1
1919
- Compiler version: v0.0.0
2020

21-
* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. forum, telegram, etc)
21+
- **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. forum, telegram, etc)

.github/workflows/main.yml

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,16 @@ on:
55
pull_request:
66
jobs:
77
main:
8-
runs-on: ubuntu-22.04
8+
runs-on: ubuntu-latest
99
steps:
10-
- run: |
11-
wget -q https://packages.erlang-solutions.com/erlang/debian/pool/esl-erlang_25.2.3-1~ubuntu~jammy_amd64.deb
12-
sudo apt install ./esl-erlang_25.2.3-1~ubuntu~jammy_amd64.deb
10+
- run: sudo apt update && sudo apt install --no-install-recommends erlang
1311
- uses: actions/checkout@v4
1412
with:
1513
fetch-depth: 100
1614
- uses: actions/setup-node@v4
1715
with:
1816
node-version: 18.x # minimum supported version
19-
- uses: actions/cache@v4
20-
with:
21-
path: |
22-
~/.npm
23-
~/.autorest
24-
key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
17+
cache: npm
2518
- run: npm ci
2619
- name: Run Commitlint
2720
if: github.event_name == 'pull_request'
@@ -30,14 +23,11 @@ jobs:
3023
BASE: ${{ github.event.pull_request.base.sha }}
3124
run: npx commitlint --from $BASE --to $HEAD --verbose
3225
- run: npm run lint
33-
- run: docker compose up -d --wait
26+
- run: docker compose up -d --wait --quiet-pull
3427
- name: Ensure that docs are up to date
35-
run: npm run docs && git diff
28+
run: npm run docs && git diff --exit-code
3629
- run: npx c8 npm test
37-
- run: npx c8 report --reporter=text-lcov > coverage.lcov
38-
- uses: codecov/codecov-action@v4
39-
with:
40-
files: coverage.lcov
30+
- uses: codecov/codecov-action@v5
4131
env:
4232
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
4333
- run: docker compose logs

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
node_modules
22
.idea
33
/coverage
4-
/coverage.lcov

.mocharc.cjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
module.exports = {
22
recursive: true,
3-
timeout: '4s',
4-
}
3+
timeout: '3s',
4+
};

.prettierrc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"printWidth": 100,
3+
"singleQuote": true
4+
}

CHANGELOG.md

Lines changed: 218 additions & 198 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 73 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
# aepp-cli-js
2+
23
Command Line Interface for the æternity blockchain.
34

45
## Installation
6+
57
You can install `aecli` using your preferred tool (`yarn` or `npm`). Here's an `npm` example
8+
69
```
710
$ npm install --global @aeternity/aepp-cli
811
```
912

1013
## Quick start
14+
1115
Let's ensure that CLI installed correctly by running `$ aecli`. It will show the available commands as below.
1216

1317
<!-- ROOT-HELP-BEGIN -->
18+
1419
```
1520
$ aecli
1621
Usage: aecli [options] [command]
@@ -33,18 +38,21 @@ Commands:
3338
select-compiler [compilerUrl] specify compiler to use in other commands
3439
help [command] display help for command
3540
```
41+
3642
<!-- ROOT-HELP-END -->
3743

3844
> To read documentation of other commands and sub-commands, you can append `--help`. For example, type `aecli account --help` to get a list of commands available in `account` module.
3945
4046
The next step is to create a wallet to use in other commands:
4147

4248
<!-- WALLET-CREATE-BEGIN -->
49+
4350
```
4451
$ aecli account create ./wallet.json
45-
Address _________________________________ ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E
46-
Path ____________________________________ /path/to/wallet.json
52+
Address ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E
53+
Path /path/to/wallet.json
4754
```
55+
4856
<!-- WALLET-CREATE-END -->
4957

5058
You need to send some coins to the created wallet.
@@ -54,34 +62,40 @@ You need to send some coins to the created wallet.
5462
[faucet]: https://faucet.aepps.com/
5563

5664
Run `$ aecli inspect <wallet address>` to ensure that it got coins.
65+
5766
<!-- INSPECT-BEGIN -->
67+
5868
```
5969
$ aecli inspect ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E
60-
Account ID ______________________________ ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E
61-
Account balance _________________________ 10000ae
62-
Account nonce ___________________________ 0
70+
Account ID ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E
71+
Account balance 10000ae
72+
Account nonce 0
6373
No pending transactions
6474
```
75+
6576
<!-- INSPECT-END -->
6677

6778
At the last step, we will send our coins to another account:
79+
6880
<!-- SPEND-BEGIN -->
81+
6982
```
7083
$ aecli spend ./wallet.json ak_AgV756Vfo99juwzNVgnjP1gXX1op1QN3NXTxvkPnHJPUDE8NT 42ae
7184
Transaction mined
72-
Transaction hash ________________________ th_2muLsbZeFaVJ3tePTnLqobPhxBzwFsm1zUv8sjgMX4LKuevX2T
73-
Block hash ______________________________ mh_dnoULQWpiRtcrntd5yJPUxcu7YrTu18xZ1e9EC2b8prKdShME
74-
Block height ____________________________ 2 (about now)
75-
Signatures ______________________________ ["sg_SG5uW5KEGiy5iG1cCkKq4VEdpyvewcW4NjVf4vj2ZoCiap5iB7UQoknWpyWsD4FkziBuGPE88zwXemq3ZvPrdzNtXtKuD"]
76-
Transaction type ________________________ SpendTx (ver. 1)
77-
Sender address __________________________ ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E
78-
Recipient address _______________________ ak_AgV756Vfo99juwzNVgnjP1gXX1op1QN3NXTxvkPnHJPUDE8NT
79-
Amount __________________________________ 42ae
80-
Payload _________________________________ ba_Xfbg4g==
81-
Fee _____________________________________ 0.00001684ae
82-
Nonce ___________________________________ 1
83-
TTL _____________________________________ 4 (about now)
85+
Transaction hash th_2muLsbZeFaVJ3tePTnLqobPhxBzwFsm1zUv8sjgMX4LKuevX2T
86+
Block hash mh_dnoULQWpiRtcrntd5yJPUxcu7YrTu18xZ1e9EC2b8prKdShME
87+
Block height 2 (about now)
88+
Signatures ["sg_SG5uW5KEGiy5iG1cCkKq4VEdpyvewcW4NjVf4vj2ZoCiap5iB7UQoknWpyWsD4FkziBuGPE88zwXemq3ZvPrdzNtXtKuD"]
89+
Transaction type SpendTx (ver. 1)
90+
Sender address ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E
91+
Recipient address ak_AgV756Vfo99juwzNVgnjP1gXX1op1QN3NXTxvkPnHJPUDE8NT
92+
Amount 42ae
93+
Payload ba_Xfbg4g==
94+
Fee 0.00001684ae
95+
Nonce 1
96+
TTL 4 (about now)
8497
```
98+
8599
<!-- SPEND-END -->
86100

87101
Find out more in the [user guide](./user-guide.md).
@@ -95,55 +109,57 @@ Find out more in the [user guide](./user-guide.md).
95109
## Commands reference
96110

97111
<!-- REFERENCE-TOC-BEGIN -->
112+
98113
- `account`
99-
- [`sign`](./reference.md#sign) — sign a transaction using wallet
100-
- [`sign-message`](./reference.md#sign-message) — sign a personal message using wallet
101-
- [`verify-message`](./reference.md#verify-message) — check if message was signed by address
102-
- [`address`](./reference.md#address) — get wallet address and optionally private key
103-
- [`create`](./reference.md#create) — create a wallet by a private key or generate a new one
114+
- [`sign`](./reference.md#sign) — sign a transaction using wallet
115+
- [`sign-message`](./reference.md#sign-message) — sign a personal message using wallet
116+
- [`verify-message`](./reference.md#verify-message) — check if message was signed by address
117+
- [`address`](./reference.md#address) — get wallet address and optionally secret key
118+
- [`create`](./reference.md#create) — create a wallet by a secret key or generate a new one
104119
- [`spend`](./reference.md#spend) — send coins to another account or contract
105120
- `name`
106-
- [`full-claim`](./reference.md#full-claim) — claim an AENS name in a single command
107-
- [`pre-claim`](./reference.md#pre-claim) — pre-claim an AENS name
108-
- [`claim`](./reference.md#claim) — claim an AENS name (requires pre-claim)
109-
- [`bid`](./reference.md#bid) — bid on name in auction
110-
- [`update`](./reference.md#update) — update a name pointer
111-
- [`extend`](./reference.md#extend) — extend name TTL
112-
- [`revoke`](./reference.md#revoke) — revoke an AENS name
113-
- [`transfer`](./reference.md#transfer) — transfer a name to another account
121+
- [`full-claim`](./reference.md#full-claim) — claim an AENS name in a single command
122+
- [`pre-claim`](./reference.md#pre-claim) — pre-claim an AENS name
123+
- [`claim`](./reference.md#claim) — claim an AENS name (requires pre-claim)
124+
- [`bid`](./reference.md#bid) — bid on name in auction
125+
- [`update`](./reference.md#update) — update a name pointer
126+
- [`extend`](./reference.md#extend) — extend name TTL
127+
- [`revoke`](./reference.md#revoke) — revoke an AENS name
128+
- [`transfer`](./reference.md#transfer) — transfer a name to another account
114129
- `contract`
115-
- [`compile`](./reference.md#compile) — compile a contract to get bytecode
116-
- [`encode-calldata`](./reference.md#encode-calldata) — encode calldata for contract call
117-
- [`decode-call-result`](./reference.md#decode-call-result) — decode contract call result
118-
- [`call`](./reference.md#call) — execute a function of the contract
119-
- [`deploy`](./reference.md#deploy) — deploy a contract on the chain
130+
- [`compile`](./reference.md#compile) — compile a contract to get bytecode
131+
- [`encode-calldata`](./reference.md#encode-calldata) — encode calldata for contract call
132+
- [`decode-call-result`](./reference.md#decode-call-result) — decode contract call result
133+
- [`call`](./reference.md#call) — execute a function of the contract
134+
- [`deploy`](./reference.md#deploy) — deploy a contract on the chain
120135
- `oracle`
121-
- [`create`](./reference.md#create-1) — register current account as oracle
122-
- [`extend`](./reference.md#extend-1) — extend oracle's time to leave
123-
- [`create-query`](./reference.md#create-query) — create an oracle query
124-
- [`respond-query`](./reference.md#respond-query) — respond to an oracle query
136+
- [`create`](./reference.md#create-1) — register current account as oracle
137+
- [`extend`](./reference.md#extend-1) — extend oracle's time to leave
138+
- [`create-query`](./reference.md#create-query) — create an oracle query
139+
- [`respond-query`](./reference.md#respond-query) — respond to an oracle query
125140
- `chain`
126-
- [`top`](./reference.md#top) — query the top key/micro block of the chain
127-
- [`status`](./reference.md#status) — query node version, network id, and related details of the selected node
128-
- [`ttl`](./reference.md#ttl) — get relative TTL by absolute TTL
129-
- [`play`](./reference.md#play) — prints blocks from top until condition
130-
- [`broadcast`](./reference.md#broadcast) — send signed transaction to the chain
141+
- [`top`](./reference.md#top) — query the top key/micro block of the chain
142+
- [`status`](./reference.md#status) — query node version, network id, and related details of the selected node
143+
- [`ttl`](./reference.md#ttl) — get relative TTL by absolute TTL
144+
- [`play`](./reference.md#play) — prints blocks from top until condition
145+
- [`broadcast`](./reference.md#broadcast) — send signed transaction to the chain
131146
- [`inspect`](./reference.md#inspect) — get details of a node entity
132147
- `tx`
133-
- [`spend`](./reference.md#spend-1) — build spend transaction
134-
- [`name-preclaim`](./reference.md#name-preclaim) — build name preclaim transaction
135-
- [`name-claim`](./reference.md#name-claim) — build name claim transaction
136-
- [`name-update`](./reference.md#name-update) — build name update transaction
137-
- [`name-transfer`](./reference.md#name-transfer) — build name transfer transaction
138-
- [`name-revoke`](./reference.md#name-revoke) — build name revoke transaction
139-
- [`contract-deploy`](./reference.md#contract-deploy) — build contract deploy transaction
140-
- [`contract-call`](./reference.md#contract-call) — build contract call transaction
141-
- [`oracle-register`](./reference.md#oracle-register) — build oracle register transaction
142-
- [`oracle-extend`](./reference.md#oracle-extend) — build oracle extend transaction
143-
- [`oracle-post-query`](./reference.md#oracle-post-query) — build oracle post query transaction
144-
- [`oracle-respond`](./reference.md#oracle-respond) — build oracle respond transaction
145-
- [`verify`](./reference.md#verify) — verify transaction using node
148+
- [`spend`](./reference.md#spend-1) — build spend transaction
149+
- [`name-preclaim`](./reference.md#name-preclaim) — build name preclaim transaction
150+
- [`name-claim`](./reference.md#name-claim) — build name claim transaction
151+
- [`name-update`](./reference.md#name-update) — build name update transaction
152+
- [`name-transfer`](./reference.md#name-transfer) — build name transfer transaction
153+
- [`name-revoke`](./reference.md#name-revoke) — build name revoke transaction
154+
- [`contract-deploy`](./reference.md#contract-deploy) — build contract deploy transaction
155+
- [`contract-call`](./reference.md#contract-call) — build contract call transaction
156+
- [`oracle-register`](./reference.md#oracle-register) — build oracle register transaction
157+
- [`oracle-extend`](./reference.md#oracle-extend) — build oracle extend transaction
158+
- [`oracle-post-query`](./reference.md#oracle-post-query) — build oracle post query transaction
159+
- [`oracle-respond`](./reference.md#oracle-respond) — build oracle respond transaction
160+
- [`verify`](./reference.md#verify) — verify transaction using node
146161
- [`config`](./reference.md#config) — print the current sdk configuration
147162
- [`select-node`](./reference.md#select-node) — specify node to use in other commands
148163
- [`select-compiler`](./reference.md#select-compiler) — specify compiler to use in other commands
164+
149165
<!-- REFERENCE-TOC-END -->

commitlint.config.js

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,6 @@ export default {
1515
'release',
1616
'tx-builder',
1717
'inspect',
18-
// TODO: remove 2 after releasing 6.0.0
19-
'crypto',
20-
'name',
2118
],
2219
],
2320
},

0 commit comments

Comments
 (0)