Skip to content

Commit

Permalink
doc: fixed readme (#69)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexander-borodulya committed Aug 14, 2024
1 parent 2c88417 commit e7bd388
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ See also prior version [aurora-cli](https://github.com/aurora-is-near/aurora-cli

- 📦 Install `aurora-cli-rs` and start interacting with it:
*`cargo install --git https://github.com/aurora-is-near/aurora-cli-rs.git`*
- 🔍 Check out what each command is for in the official Aurora [docs](https://doc.aurora.dev/tools/aurora-cli)
- 🔍 Check out what each command is for in the [Commands Reference](#commands-reference) section
- ✋ Have questions? Ask them at the official Aurora [forum](https://forum.aurora.dev/)

## Usage
Expand Down Expand Up @@ -79,6 +79,15 @@ Start NEAR node:
nearup run localnet --home /tmp/localnet
```

When running the `nearup run localnet` command on Apple’s M-based hardware, a local build of `neard` is required due to compatibility issues with the architecture.

Start NEAR node (Apple's M-based hardware):
```shell
nearup run localnet --home /tmp/localnet --binary-path /path/to/nearcore/target/release
```

Replace `/path/to/nearcore/target/release` with the actual path to the locally built `neard` binary.

### **Prepare an account and create a private key file for Aurora EVM**

```shell
Expand Down Expand Up @@ -212,7 +221,9 @@ aurora-cli --engine aurora.node0 get-chain-id
aurora-cli --engine aurora.node0 get-nonce 0x53a9fed853e02a39bf8d298f751374de8b5a6ddf
aurora-cli --engine aurora.node0 get-code 0x53a9fed853e02a39bf8d298f751374de8b5a6ddf
aurora-cli --engine aurora.node0 get-balance 0x53a9fed853e02a39bf8d298f751374de8b5a6ddf
aurora-cli --engine aurora.node0 get-storage-at --address 0x53a9fed853e02a39bf8d298f751374de8b5a6ddf --key 0
aurora-cli --engine aurora.node0 get-storage-at \
--address 0x53a9fed853e02a39bf8d298f751374de8b5a6ddf \
--key 0x0000000000000000000000000000000000000000000000000000000000000000
```

### **Silo methods**
Expand Down Expand Up @@ -291,7 +302,7 @@ Example JSON batch file (`batch_list.json`):
]
```

## Reference
## Commands Reference

- [`aurora-cli help`](#aurora-cli-help)
- [`aurora-cli create-account`](#aurora-cli-create-account)
Expand Down

0 comments on commit e7bd388

Please sign in to comment.