Update readme and chiba-clonk-client reference in package json (#4)
* Update chiba-clonk-client commit hash * Update readme with setup instructions
This commit is contained in:
parent
bc8a825021
commit
8b3f8c8f36
28
README.md
28
README.md
@ -1,5 +1,29 @@
|
||||
# chiba-clonk-sdk
|
||||
|
||||
## Setup
|
||||
|
||||
* Run `yarn` to install all dependencies.
|
||||
|
||||
* This repo uses chiba-clonk-client. We will need to use this locally.
|
||||
|
||||
* Run the following in [chiba-clonk-client repo](https://github.com/vulcanize/chiba-clonk-client):
|
||||
|
||||
```bash
|
||||
$ yarn
|
||||
|
||||
$ yarn build
|
||||
|
||||
$ yarn link
|
||||
```
|
||||
|
||||
* In chiba-clonk-sdk repo run:
|
||||
|
||||
```bash
|
||||
$ yarn link chiba-clonk-client
|
||||
```
|
||||
|
||||
* Create a `config.yml` file from [config.example.yml](./config.example.yml) file.
|
||||
|
||||
## Account Setup
|
||||
|
||||
Registering records in CNS requires an account. To get account private key run:
|
||||
@ -8,7 +32,7 @@ Registering records in CNS requires an account. To get account private key run:
|
||||
$ chibaclonkd keys export mykey --unarmored-hex --unsafe
|
||||
```
|
||||
|
||||
Create a `config.yml` file from [config.example.yml](./config.example.yml) file and assign the account private key to `userKey`.
|
||||
In `config.yml` file assign the account private key to `userKey`.
|
||||
|
||||
## Gas and Fees
|
||||
|
||||
@ -27,7 +51,7 @@ $ chiba cns bond create --type aphoton --quantity 1000000000 --gas 200000 --fees
|
||||
|
||||
## Operations
|
||||
|
||||
These commands require a `config.yml` file present in the current worknig directory when using the CLI.
|
||||
These commands require a `config.yml` file present in the current working directory when using the CLI.
|
||||
|
||||
Get node status:
|
||||
|
||||
|
@ -14,7 +14,7 @@
|
||||
"typescript": "^4.6.3"
|
||||
},
|
||||
"dependencies": {
|
||||
"chiba-clonk-client": "https://github.com/vulcanize/chiba-clonk-client.git#416c06deeb8e6cec685e75590728b6d5258d4adc",
|
||||
"chiba-clonk-client": "https://github.com/vulcanize/chiba-clonk-client.git#27a176fbade406a9c89599b6a0c81c1f0ca6e7cc",
|
||||
"fs-extra": "^10.1.0",
|
||||
"js-yaml": "^4.1.0",
|
||||
"lodash": "^4.17.21",
|
||||
|
@ -721,9 +721,9 @@ chalk@^2.4.1:
|
||||
escape-string-regexp "^1.0.5"
|
||||
supports-color "^5.3.0"
|
||||
|
||||
"chiba-clonk-client@https://github.com/vulcanize/chiba-clonk-client.git#416c06deeb8e6cec685e75590728b6d5258d4adc":
|
||||
"chiba-clonk-client@https://github.com/vulcanize/chiba-clonk-client.git#27a176fbade406a9c89599b6a0c81c1f0ca6e7cc":
|
||||
version "0.1.0"
|
||||
resolved "https://github.com/vulcanize/chiba-clonk-client.git#416c06deeb8e6cec685e75590728b6d5258d4adc"
|
||||
resolved "https://github.com/vulcanize/chiba-clonk-client.git#27a176fbade406a9c89599b6a0c81c1f0ca6e7cc"
|
||||
dependencies:
|
||||
"@cosmjs/amino" "^0.28.1"
|
||||
"@cosmjs/crypto" "^0.28.1"
|
||||
|
Loading…
Reference in New Issue
Block a user