1414
1515## What is Engine?
1616
17- [ Aurora] ( https://doc.aurora.dev/getting-started/aurora-engine/ ) is an Ethereum
18- Virtual Machine (EVM) project built on the NEAR Protocol, that provides a
19- solution for developers to deploy their apps on an Ethereum-compatible,
20- high-throughput, scalable and future-safe platform, with low transaction costs
17+ [ Aurora] ( https://doc.aurora.dev/getting-started/aurora-engine/ ) is an Ethereum Virtual Machine (EVM)
18+ project built on the NEAR Protocol, that provides a solution for developers to deploy their apps
19+ on an Ethereum-compatible, high-throughput, scalable and future-safe platform, with low transaction costs
2120for their users. Engine is the Aurora's implementation for it.
2221
2322## What is Aurora CLI?
2423
25- Aurora CLI is a command line interface to bootstrap Aurora Engine with rapid
26- speed built with rust.
24+ Aurora CLI is a command line interface to bootstrap Aurora Engine with rapid speed built with rust.
2725
28- Aurora CLI comes pre-configuration with opinionated, sensible defaults for
29- standard testing environments. If other projects mention testing on Aurora, they
30- are referring to the settings defined in this repo.
26+ Aurora CLI comes pre-configuration with opinionated, sensible defaults for standard testing environments.
27+ If other projects mention testing on Aurora, they are referring to the settings defined in this repo.
3128
3229** Aurora CLI has the following advantages over api:**
3330
3431- :pencil : ** Easily modifiable EVM states through terminal**
3532- :handshake : ** Quick to interact for rapid iterations**
3633
37- See also prior version
38- [ aurora-cli] ( https://github.com/aurora-is-near/aurora-cli ) .
34+ See also prior version [ aurora-cli] ( https://github.com/aurora-is-near/aurora-cli ) .
3935
4036## Prerequisites
4137
@@ -44,17 +40,14 @@ See also prior version
4440## Quickstart
4541
4642- 📦 Install ` aurora-cli-rs ` and start interacting with it:
47- _ ` cargo install --git https://github.com/aurora-is-near/aurora-cli-rs.git ` _
48- - 🔍 Check out what each command is for in the
49- [ Commands Reference] ( #commands-reference ) section
50- - ✋ Have questions? Ask them at the official Aurora
51- [ forum] ( https://forum.aurora.dev/ )
43+ * ` cargo install --git https://github.com/aurora-is-near/aurora-cli-rs.git ` *
44+ - 🔍 Check out what each command is for in the [ Commands Reference] ( #commands-reference ) section
45+ - ✋ Have questions? Ask them at the official Aurora [ forum] ( https://forum.aurora.dev/ )
5246
5347## Usage
5448
55- In the following example, we will see how to deploy Aurora EVM on the
56- ` localnet ` . Also, we will deploy a simple EVM smart contract and will be
57- interacting with it.
49+ In the following example, we will see how to deploy Aurora EVM on the ` localnet ` . Also, we will deploy a simple EVM
50+ smart contract and will be interacting with it.
5851
5952### ** Requirements**
6053
@@ -67,11 +60,10 @@ First what we need to do is to install `aurora-cli`:
6760
6861``` shell
6962git clone https://github.com/aurora-engine/aurora-cli-rs
70- cd aurora-cli-rs/cli && cargo install --path .
63+ cd aurora-cli-rs/cli && cargo install --path .
7164```
7265
73- Next we need to start a NEAR node locally. We can use the NEAR utility,
74- ` nearup ` .
66+ Next we need to start a NEAR node locally. We can use the NEAR utility, ` nearup ` .
7567
7668### ** Start a NEAR node locally**
7769
@@ -87,18 +79,16 @@ Start NEAR node:
8779nearup run localnet --home /tmp/localnet
8880```
8981
90- When running the ` nearup run localnet ` command on Apple’s M-based hardware, a
91- local build of ` neard ` is required due to compatibility issues with the
92- architecture.
82+ When running the ` nearup run localnet ` command on Apple’s M-based hardware, a local build of ` neard ` is required due to
83+ compatibility issues with the architecture.
9384
9485Start NEAR node (Apple's M-based hardware):
9586
9687``` shell
9788nearup run localnet --home /tmp/localnet --binary-path /path/to/nearcore/target/release
9889```
9990
100- Replace ` /path/to/nearcore/target/release ` with the actual path to the locally
101- built ` neard ` binary.
91+ Replace ` /path/to/nearcore/target/release ` with the actual path to the locally built ` neard ` binary.
10292
10393### ** Prepare an account and create a private key file for Aurora EVM**
10494
@@ -135,9 +125,8 @@ aurora-cli --engine aurora.node0 --near-key-path /tmp/localnet/aurora_key.json i
135125
136126### ** Deploy the EVM smart contract**
137127
138- And now we can deploy the EVM smart contract. In our example, it will be a
139- simple counter that can return its current value and increment and decrement its
140- value.
128+ And now we can deploy the EVM smart contract. In our example, it will be a simple counter that can return its current
129+ value and increment and decrement its value.
141130
142131But before that we need to generate a private key for signing transactions:
143132
@@ -172,14 +161,13 @@ If everything went well, the response should be like this:
172161Contract has been deployed to address: 0x53a9fed853e02a39bf8d298f751374de8b5a6ddf successfully
173162```
174163
175- So. Now we have deployed the smart contract at address:
176- ` 0x53a9fed853e02a39bf8d298f751374de8b5a6ddf ` .
164+ So. Now we have deployed the smart contract at address: ` 0x53a9fed853e02a39bf8d298f751374de8b5a6ddf ` .
177165
178166### ** Interact with the smart contract**
179167
180168First, let's check that the current value is the same as we set in the
181- initialization stage. For that, we will use the ` view-call ` operation, which
182- doesn't demand a private key because it is a read-only operation:
169+ initialization stage. For that, we will use the ` view-call ` operation, which doesn't demand a private key
170+ because it is a read-only operation:
183171
184172``` shell
185173aurora-cli --engine aurora.node0 view-call -a 0x53a9fed853e02a39bf8d298f751374de8b5a6ddf -f value \
@@ -198,8 +186,8 @@ aurora-cli --engine aurora.node0 --near-key-path /tmp/localnet/aurora_key.json s
198186 --aurora-secret-key 3fac6dca1c6fc056b971a4e9090afbbfbdf3bc443e9cda595facb653cb1c01e1
199187```
200188
201- In the response, we can see if the transaction was successful and the amount of
202- gas used for the execution of this transaction.
189+ In the response, we can see if the transaction was successful and the amount of gas used for the execution of this
190+ transaction.
203191
204192Let's make sure that our value was incremented:
205193
@@ -212,15 +200,13 @@ So, if we can see `6` in the output then the demo was successful. That's it!
212200
213201### ** Build aurora-cli with the advanced command line interface (Advanced CLI)**
214202
215- Advanced CLI provides more options andadvanced features. You can try it by
216- building with the following command:
203+ Advanced CLI provides more options andadvanced features. You can try it by building with the following command:
217204
218205``` shell
219206cargo install --path . --no-default-features -F advanced
220207```
221208
222- Documentation on how to work with the advanced version of ` aurora-cli ` can be
223- found [ here] ( docs/localnet.md ) .
209+ Documentation on how to work with the advanced version of ` aurora-cli ` can be found [ here] ( docs/localnet.md ) .
224210
225211### ** Browse Deployed EVM Metadata**
226212
@@ -283,19 +269,17 @@ Disable whitelist status
283269aurora-cli --engine aurora.node0 set-whitelist-status --kind < whitelist-kind> --status 0
284270```
285271
286- Replace ` <whitelist-kind> ` with the desired whitelist type (admin, evm-admin,
287- account, or address), and ` <entry-value> ` with the address or account to be
288- whitelisted or removed.
272+ Replace ` <whitelist-kind> ` with the desired whitelist type (admin, evm-admin, account, or address), and ` <entry-value> `
273+ with the address or account to be whitelisted or removed.
289274
290275Add whitelist batch
291276
292277``` shell
293278aurora-cli --engine aurora.node0 add-entry-to-whitelist-batch path/to/batch_list.json
294279```
295280
296- The batch should be provided in a JSON format. Each entry in the JSON array
297- should have two properties: ` kind ` and either ` account_id ` or ` address ` ,
298- depending on the type of whitelist being updated.
281+ The batch should be provided in a JSON format. Each entry in the JSON array should have two properties: ` kind ` and
282+ either ` account_id ` or ` address ` , depending on the type of whitelist being updated.
299283
300284Example JSON batch file (` batch_list.json ` ):
301285
@@ -554,6 +538,7 @@ Arguments:
554538
555539Options:
556540 -h, --help Print help
541+
557542```
558543
559544### ` aurora-cli get-block-hash `
@@ -584,6 +569,7 @@ Arguments:
584569
585570Options:
586571 -h, --help Print help
572+
587573```
588574
589575### ` aurora-cli get-balance `
@@ -882,7 +868,7 @@ Options:
882868 --value <VALUE> Attached value in EVM transaction
883869 --from <FROM> From account_id
884870 -h, --help Print help
885- ```
871+ ```
886872
887873### ` aurora-cli submit `
888874
@@ -1217,7 +1203,7 @@ Usage: aurora-cli set-eth-connector-contract-account [OPTIONS] --account-id <ACC
12171203Options:
12181204 --account-id <ACCOUNT_ID> Account id of eth connector
12191205 --withdraw-ser <WITHDRAW_SER> Serialization type in withdraw method
1220- -h, --help
1206+ -h, --help
12211207```
12221208
12231209### ` aurora-cli get-eth-connector-contract-account `
@@ -1305,4 +1291,4 @@ Options:
13051291 --full-access-pub-key <FULL_ACCESS_PUB_KEY>
13061292 --function-call-pub-key <FUNCTION_CALL_PUB_KEY>
13071293 -h, --help Print help
1308- ```
1294+ ```
0 commit comments