Skip to content
This repository was archived by the owner on Aug 12, 2024. It is now read-only.

Commit 1dca16f

Browse files
authored
Merge pull request #118 from aeternity/release/v2.0.0
Release/v2.0.0
2 parents 627c627 + 71604a4 commit 1dca16f

Some content is hidden

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

48 files changed

+2387
-1845
lines changed

.env

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1-
# this is used by docker-compose.yml to for the epoch image tag
2-
TAG=v1.0.0
1+
# this is used by docker-compose.yml to for the node image tag
2+
TAG=v2.0.0
3+

.github/ISSUE_TEMPLATE.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
Issue tracker is **ONLY** used for reporting bugs or feature request. NO SUPPORT REQUESTS ACCEPTED! Use [stackoverflow](https://stackoverflow.com/tags/aeternity) for supporting issues.
2-
31
<!--- Provide a general summary of the issue in the Title above -->
42

53
## Expected Behavior
@@ -25,7 +23,7 @@ Issue tracker is **ONLY** used for reporting bugs or feature request. NO SUPPORT
2523

2624
<!--- Provide a general summary of the issue in the Title above -->
2725

28-
## [Epoch](https://github.com/aeternity/epoch/releases) Version
26+
## [Aeternity Node](https://github.com/aeternity/aeternity/releases) Version
2927

3028
## Detailed Description
3129
<!--- Provide a detailed description of the change or addition you are proposing -->

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,6 @@ venv
77
aepp_sdk.egg-info
88
dist
99
build
10+
coverage.xml
11+
docker-compose.override.yml
12+
test-results.xml

CHANGELOG.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,23 @@ log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).
55

66
## [Unreleased]
77

8+
## [2.0.0]
9+
10+
### Added
11+
12+
- Compatibility with aeternity node >= 1.4.0 and < 3.0.0
13+
- Transaction serialization/deserialization support
14+
- Automatic fee calculation
15+
16+
### Removed
17+
18+
- Compatibility with aeternity node < 1.4.0
19+
20+
### Changed
21+
22+
- Rename references of `epoch` to `node`
23+
- CLI interface for aens claim
24+
825
## [1.1.2]
926

1027
### Changed
@@ -239,7 +256,7 @@ refer to the [documentation](docs/keystore_format_change.md) about how to update
239256

240257
### Changed
241258

242-
- Switch to curve ed25519 (from secp256k1) to align with Epoch protocol changes
259+
- Switch to curve ed25519 (from secp256k1) to align with Node protocol changes
243260
- Generate basic API directly from Swagger files, also validate input data
244261

245262
### Fixed

INSTALL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# How to install an Epoch test network on Linux
1+
# How to install an Node test network on Linux
22

33
Tested on Ubuntu 17.10, Ubuntu 17.04 and Fedora 27. This will install a 3-node
44
system for local testing. Optionally you may choose to speed up mining in order

Jenkinsfile

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ pipeline {
1212

1313
environment {
1414
DOCKER_COMPOSE = "docker-compose -p ${env.BUILD_TAG} -H 127.0.0.1:2376"
15-
SCANNER_HOME = tool 'default-sonarqube-scanner'
1615
}
1716

1817
stages {
@@ -21,12 +20,9 @@ pipeline {
2120
withCredentials([usernamePassword(credentialsId: 'genesis-wallet',
2221
usernameVariable: 'WALLET_PUB',
2322
passwordVariable: 'WALLET_PRIV')]) {
23+
sh "${env.DOCKER_COMPOSE} pull node"
2424
sh "${env.DOCKER_COMPOSE} run sdk flake8"
2525
sh "${env.DOCKER_COMPOSE} run sdk make test"
26-
// run sonar?
27-
// withSonarQubeEnv('default-sonarqube-server') {
28-
// sh "${env.SCANNER_HOME}/bin/sonar-scanner -X"
29-
// }
3026
}
3127
}
3228
}

README.md

Lines changed: 72 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@ Usage: aecli [OPTIONS] COMMAND [ARGS]...
4040
4141
Welcome to the aecli client.
4242
43-
The client is to interact with an epoch node.
43+
The client is to interact with an node node.
4444
4545
Options:
4646
--version Show the version and exit.
47-
-u, --url URL Epoch node url
47+
-u, --url URL Node node url
4848
-d, --debug-url URL
49-
--force Ignore epoch version compatibility check
49+
--force Ignore node version compatibility check
5050
--wait Wait for transactions to be included
5151
--json Print output in JSON format
5252
--version Show the version and exit.
@@ -65,68 +65,76 @@ Commands:
6565
## Environment variables
6666

6767
Use the environment variables
68-
- `EPOCH_URL`
69-
- `EPOCH_URL_DEBUG`
68+
69+
- `NODE_URL`
70+
- `NODE_URL_DEBUG`
7071

7172
### Example usage
7273

73-
The following is a walkthrough to execute an offline spend transaction on the *sdk-edgenet* network
74+
The following is a walkthrough to execute an offline spend transaction on the *testnet* network
7475

7576
1. Set the environment variables
7677
```
77-
export EPOCH_URL=https://sdk-edgenet.aepps.com
78-
export EPOCH_URL_DEBUG=https://sdk-edgenet.aepps.com
78+
export NODE_URL=https://sdk-testnet.aepps.com
7979
```
80+
81+
❗ When not set the command line client will connect to mainnet
82+
8083
2. Retrieve the top block
8184
```
82-
./aecli chain top
83-
<none>
84-
Beneficiary _______________________________________ ak_25MZX3BXYP32YDPGWsJqYZ6CgWnqD93VdpCYaTk6KsThEbeFJX
85-
Hash ______________________________________________ kh_b8bTJYdmyiRuyCrV3AowFxSsGjXr28Ue5QtHbVuLXQQERZjnD
86-
Height ____________________________________________ 3604
87-
Miner _____________________________________________ ak_2Li2KZjMzNd9tWqhkhLLi2j97XFjyEBUK9BBDZtY3f2jkjtCMj
88-
Nonce _____________________________________________ 3313408265463920434
89-
Prev hash _________________________________________ kh_F6c5zJYf91ewJhSgH28Z59Rjzotpz8KyPWzvTiTQt4V4kDsVA
90-
Prev key hash _____________________________________ kh_F6c5zJYf91ewJhSgH28Z59Rjzotpz8KyPWzvTiTQt4V4kDsVA
91-
State hash ________________________________________ bs_gQTYraBQZPgPxb5a5MKtnZthVTMoDs1eZ5qGrsvziLFoQeY9
92-
Target ____________________________________________ 536993844
93-
Time ______________________________________________ 2018-11-16T17:41:28.123000+00:00
94-
Version ___________________________________________ 28
95-
</none>
85+
$ aecli chain top
86+
<top for node at https://sdk-testnet.aepps.com >
87+
Beneficiary _______________________________________ ak_2iBPH7HUz3cSDVEUWiHg76MZJ6tZooVNBmmxcgVK6VV8KAE688
88+
Hash ______________________________________________ kh_WTqMQQRsvmbtP5yrKPxd4p2PPKiA51AuPyCkVJk7d7HVtkhS6
89+
Height ____________________________________________ 46049
90+
Info ______________________________________________ cb_Xfbg4g==
91+
Miner _____________________________________________ ak_24yQXT3g2jNryZbY2veHYcgQn3PspfTnkTHbXMwNYDQd9NZAs5
92+
Nonce _____________________________________________ 17848795956567990671
93+
Prev hash _________________________________________ kh_B5Q3F7Gxbmg2z3prkay2uYohvhv4xXUKQzKKkbTdm7Z3GuQxU
94+
Prev key hash _____________________________________ kh_B5Q3F7Gxbmg2z3prkay2uYohvhv4xXUKQzKKkbTdm7Z3GuQxU
95+
State hash ________________________________________ bs_bkP3QdFKCWNetDHfwL3rJG2hEgRzZRAQN6jh33SKwUd17tBjp
96+
Target ____________________________________________ 538409724
97+
Time ______________________________________________ 2019-03-03T23:38:49.720000+00:00
98+
Version ___________________________________________ 2
99+
</top for node at https://sdk-testnet.aepps.com >
96100
```
97101

98-
3. Create an account
102+
3. Create a new account
99103

100104
```
101-
aecli account create TEST.json
105+
aecli account create Bob.json
102106
Enter the account password []:
103107
<account>
104-
Address ___________________________________________ ak_KUF5Y1BwYaMYXCGZU93vjQHxT3hQSVeryBvCMLLguvZTgGGWB
105-
Path ______________________________________________ /..../TEST.json
108+
Address ___________________________________________ ak_BobY97QUVR4iDLg4k3RKmy6shZYx9FR75nLaN33GsVmSnhWxn
109+
Path ______________________________________________ /.../Bob.json
106110
</account>
111+
107112
```
108113

109-
4. Go to [edge-faucet.aepps.com](https://edge-faucet.aepps.com) and top up your account
114+
❗ Make sure that you use a long and difficult-to-guess password for an account that you plan to use on mainnet
115+
116+
4. Go to [testnet.faucet.aepps.com](https://testnet.faucet.aepps.com) and top up your account
110117

111118
![](docs/assets/images/faucet.png)
112119

113120
5. Inspect the transaction reported by the faucet app
114121
```
115-
aecli inspect th_uMTuHHgk2RHVjWktNXUKSfPBNjirCRXSRQgx4S5wjGJms2pwE
122+
aecli inspect th_2CV4a7xxDYj5ysaDjXNoCSLxnkowGM5bbyAvtdoPvHZwTSYykX
116123
<transaction>
117-
Block hash ________________________________________ mh_25fkUuH9ZWF8NVHJRxG6SByPvgpR9tYEfc2sES3nQacQcoPVEz
118-
Block height ______________________________________ 3605
119-
Hash ______________________________________________ th_uMTuHHgk2RHVjWktNXUKSfPBNjirCRXSRQgx4S5wjGJms2pwE
124+
Block hash ________________________________________ mh_2vjFffExUZPVGo3q6CHRSzxVUhzLcUnQQUWpijFtSvKfoHwQWe
125+
Block height ______________________________________ 12472
126+
Hash ______________________________________________ th_2CV4a7xxDYj5ysaDjXNoCSLxnkowGM5bbyAvtdoPvHZwTSYykX
120127
<signatures 1>
121-
Signature #1 ____________________________________ sg_G7rDNL81BGPL9iEUC9w4Pmuvk582QBWm2W41gq1DKR8q7sPBhqmU3VbJhBFzvTKJe6XfkRDWd1rF6kmF86aqyw78g6G76
128+
Signature #1 ____________________________________ sg_WtPeyKWN4zmcnZZXpAxCT8EvjF3qSjiUidc9cdxQooxe1JCLADTVbKDFm9S5bNwv3yq57PQKTG4XuUP4eTzD5jymPHpNu
129+
</signatures>
122130
<tx>
123-
Amount __________________________________________ 250
124-
Fee _____________________________________________ 1
125-
Nonce ___________________________________________ 23
131+
Amount __________________________________________ 5000000000000000000
132+
Fee _____________________________________________ 20000
133+
Nonce ___________________________________________ 146
126134
Payload _________________________________________ Faucet Tx
127-
Recipient id ____________________________________ ak_KUF5Y1BwYaMYXCGZU93vjQHxT3hQSVeryBvCMLLguvZTgGGWB
128-
Sender id _______________________________________ ak_Jq7fsE1x9Hy8XnXpyHuJuwxiC1xbeCLsKqrKggfBi6b5o9VSE
129-
Ttl _____________________________________________ 3655
135+
Recipient id ____________________________________ ak_2ioQbdSViNKjknaLUWphdRjpbTNVpMHpXf9X5ZkoVrhrCZGuyW
136+
Sender id _______________________________________ ak_2iBPH7HUz3cSDVEUWiHg76MZJ6tZooVNBmmxcgVK6VV8KAE688
137+
Ttl _____________________________________________ 12522
130138
Type ____________________________________________ SpendTx
131139
Version _________________________________________ 1
132140
</tx>
@@ -136,46 +144,59 @@ aecli inspect th_uMTuHHgk2RHVjWktNXUKSfPBNjirCRXSRQgx4S5wjGJms2pwE
136144
6. Create another account
137145

138146
```
139-
aecli account create TEST1.json
147+
aecli account create Alice.json
140148
Enter the account password []:
141149
<account>
142-
Address ___________________________________________ ak_2PSjWyfKy1vitPF3UVWW7bFLBVC96vTbU6XF8Z5sWFDsJ9UX8w
143-
Path ______________________________________________ /Users/andrea/Documents/workspaces/blockchain/aeternity/aepp-sdk-python/TEST1.json
150+
Address ___________________________________________ ak_9j8akv2PE2Mnt5khFeDvS9BGc3TBBrJkfcgaJHgBXcLLagX8M
151+
Path ______________________________________________ /.../Alice.json
144152
</account>
145153
```
146154

147155

148156
7. Transfer some tokens to an account to the other
149157

150158
```
151-
aecli account spend TEST.json ak_2PSjWyfKy1vitPF3UVWW7bFLBVC96vTbU6XF8Z5sWFDsJ9UX8w 50
159+
aecli account spend Bob.json ak_9j8akv2PE2Mnt5khFeDvS9BGc3TBBrJkfcgaJHgBXcLLagX8M 1000000000000000000
152160
Enter the account password []:
153161
<spend transaction>
154-
Sender account ____________________________________ ak_KUF5Y1BwYaMYXCGZU93vjQHxT3hQSVeryBvCMLLguvZTgGGWB
155-
Recipient account _________________________________ ak_2PSjWyfKy1vitPF3UVWW7bFLBVC96vTbU6XF8Z5sWFDsJ9UX8w
156-
Unsigned __________________________________________ tx_51fEeKes4ZMpp7njot9VTwFQQCmU4EHgc2U6EzU8dm3TuvB3YzsQhshMV9ksrqCpygPtQyHoMxzC3XXW5QJmADyo8WUJogjrTtgkGXmB88JfVncVC6
157-
Signed ____________________________________________ tx_66dpehQZhw1sUsS5agWkmDMYasvWBYFoagoMEsFatXUaXawyhu9Fy6Has356wNir5bzN567qtLTSxmYr2LpEFN6DMpktFp2YPWtfmGAm8Wcjr2qcXWHS32dBMA1va3CfkS7o5bdzFVVjohhVaN2BPnECJBnJGJHBdJBuQCadeCnY4PWEH5dbdGij3iLADgBjRCCyGomQsuz594heQL8Bhaf
158-
Hash ______________________________________________ th_LUbGLvcY3YL9rG52jzsyQDyxvagqwqgEsxMhrRNuoHXGLqTsg
162+
<data>
163+
Tag _____________________________________________ 12
164+
Vsn _____________________________________________ 1
165+
Sender id _______________________________________ ak_BobY97QUVR4iDLg4k3RKmy6shZYx9FR75nLaN33GsVmSnhWxn
166+
Recipient id ____________________________________ ak_9j8akv2PE2Mnt5khFeDvS9BGc3TBBrJkfcgaJHgBXcLLagX8M
167+
Amount __________________________________________ 1000000000000000000
168+
Fee _____________________________________________ 16860000000000
169+
Ttl _____________________________________________ 0
170+
Nonce ___________________________________________ 4
171+
Payload _________________________________________
172+
</data>
173+
Metadata
174+
Tx ________________________________________________ tx_+KMLAfhCuEAKN05UwTV0fSgO5woziVNnAMBcDrh46XlNFTZTJQlI05fz/8pVSyrb1guCLcw8n7++O887k/JEu6/XHcCSHOMMuFv4WQwBoQEYh8aMDs7saMDBvys+lbKds3Omnzm4crYNbs9xGolBm6EBE9B4l/BeyxMO//3ANxwyT+ZHL52j9nAZosRe/YFuK4eIDeC2s6dkAACGD1WGT5gAAASAN24JGA==
175+
Hash ______________________________________________ th_2gAL72dtnaeDcZoZA9MbfSL1JrWzNErMJuikmTRvBY8zhkGh91
176+
Signature _________________________________________ sg_2LX9hnJRiYGSspzpS34QeN3PLT9bGSkFRbad9LXvLj5QUFoV5eHRf9SueDgLiiquCGbeFEBPBe7xMJidf8NMSuF16dngr
177+
Network id ________________________________________ ae_uat
159178
</spend transaction>
160179
```
161180

162181
8. Verify the balance of the new account
163182
```
164-
aecli inspect ak_2PSjWyfKy1vitPF3UVWW7bFLBVC96vTbU6XF8Z5sWFDsJ9UX8w
183+
aecli inspect ak_9j8akv2PE2Mnt5khFeDvS9BGc3TBBrJkfcgaJHgBXcLLagX8M
165184
<account>
166-
Balance ___________________________________________ 50
167-
Id ________________________________________________ ak_2PSjWyfKy1vitPF3UVWW7bFLBVC96vTbU6XF8Z5sWFDsJ9UX8w
185+
Balance ___________________________________________ 1000000000000000000
186+
Id ________________________________________________ ak_9j8akv2PE2Mnt5khFeDvS9BGc3TBBrJkfcgaJHgBXcLLagX8M
168187
Nonce _____________________________________________ 0
169188
</account>
170189
```
171190

191+
192+
172193
## Advanced usage
173194

174195
For advanced usage check the [documentation](docs).
175196

176197

177198
## Reference:
178199

179-
[AENS API Spec](https://github.com/aeternity/protocol/blob/master/epoch/api/naming_system_api_usage.md)
200+
[AENS API Spec](https://github.com/aeternity/protocol/blob/master/node/api/naming_system_api_usage.md)
180201

181202
[AENS Protocol](https://github.com/aeternity/protocol/blob/master/AENS.md)

aeternity/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
__version__ = '1.1.2'
1+
__version__ = '2.0.0'
22

33
__compatibility__ = dict(
4-
from_version=">=1.0.0",
5-
to_version="<2.0.0"
4+
from_version=">=1.4.0",
5+
to_version="<3.0.0"
66
)

0 commit comments

Comments
 (0)