cerc-io/laconic-registry-cli
19
0
Fork 1
Code Issues 1 Pull Requests 2 Actions Packages Projects Releases 24 Wiki Activity
3cf35dad43
laconic-registry-cli/demo
History
Prathamesh Musale 86259b35a6
All checks were successful
Lint / lint (18.x) (push) Successful in 1m12s
Details
Publish npm package to gitea / npm_publish (18.x) (release) Successful in 1m24s
Details
Tests / cli_tests (18.x) (push) Successful in 9m15s
Details
Add a config option and arg to set gas price for auto fees calculation (#81) 
Part of [Create a public laconicd testnet](https://www.notion.so/Create-a-public-laconicd-testnet-896a11bdd8094eff8f1b49c0be0ca3b8)
Requires cerc-io/registry-sdk#22

Behaviour in different configuration scenarios:
- Gas set, fees set to `Xalnt`:

  ```bash
  # Example
  gas: 500000
  fees: 500000alnt
  gasPrice:
  ```

  - `gasPrice` config ignored
  - tx rejected if given `fees` < `gas` * `min-gas-price` set by the node
  - tx fails mid-execution if it runs out of given `gas`
- Fees not set, gas price set to `Xalnt`:

  ```bash
  # Example
  gas:
  fees:
  gasPrice: 1alnt
  ```

  - `gas` config ignored
  - uses `auto` fee calculation using gas estimation with [default multiplier](https://git.vdb.to/cerc-io/registry-sdk/src/branch/main/src/constants.ts) (`2`) value from `registry-sdk`
  - tx rejected if given `gasPrice` < `min-gas-price` set by the node
  - tx fails mid-execution if it runs out of calculated gas
- Fees set to a `X` (without `alnt` suffix), gas price set to `Yalnt`:

  ```bash
  # Example
  gas:
  fees: 1.8
  gasPrice: 1alnt
  ```

  - `gas` config ignored
  - uses `auto` fee calculation using gas estimation with `fees` as the multiplier
  - tx rejected if given `gasPrice` < `min-gas-price` set by the node
  - tx fails mid-execution if it runs out of calculated gas, can be retried with a higher gas estimation multiplier (`fees`)
- Fees and gas price both not set:

  ```bash
  # Example
  gas:
  fees:
  gasPrice:
  ```

  - `gas` config ignored
  - uses `auto` fee calculation using gas estimation
  - throws error:
    ```bash
    Gas price must be set in the client options when auto gas is used.
    ```

The provided config can be overridden with CLI args if required.

Co-authored-by: IshaVenikar <ishavenikar7@gmail.com>
Reviewed-on: #81
Co-authored-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
Co-committed-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
2024-09-06 09:44:47 +00:00
..
scripts Add a config option and arg to set gas price for auto fees calculation (#81) 2024-09-06 09:44:47 +00:00
README.md Add a config option and arg to set gas price for auto fees calculation (#81) 2024-09-06 09:44:47 +00:00

README.md

Registry Demo

Setup

  • Install laconic CLI globally:

    # In laconic-registry-cli repo root
yarn && yarn build
yarn global add file:$PWD

  • Run the laconicd chain:

    # In laconci2d repo
make install
./scripts/init.sh clean

  • Create and populate config.yml following config.example.yml:

    # In laconic-registry-cli repo root
cp config.example.yml config.yml

# Update the gas value in config.yml
# gas: 500000
# fees: 500000alnt

# Get user private key
laconicd keys export alice --unarmored-hex --unsafe --keyring-backend test --home ~/.laconicd

# Set the output as 'userKey' in config.yml
# userKey: <ALICE_PRIVATE_KEY>

# Create a bond
laconic --config config.yml registry bond create --type alnt --quantity 100000000000

# Get the bond id
laconic --config config.yml registry bond list | jq -r '.[].id'

# Set the output as 'bondId' in config.yml
# bondId: <BOND_ID>

Run

  • Publish records:

    # Publishes records and corresponding 'deployment' records from given directory

# In laconic-registry-cli repo root
# Use records dir path for '--records' as required
yarn ts-node demo/scripts/publish-records.ts --config config.yml --records <RECORDS_DIR>

Example

  • Query for azimuth-watcher deployment(s):

    • Find the WatcherRecord for azimuth-watcher:

      WATCHER_RECORD_ID=$(laconic registry record list --all --type WatcherRecord --name azimuth-watcher | jq -r '.[].id')

    • Find corresponding deployment(s):

      laconic registry record list --all --type WatcherDeploymentRecord watcher $WATCHER_RECORD_ID

# Get the deployment URL(s)
laconic registry record list --all --type WatcherDeploymentRecord watcher $WATCHER_RECORD_ID | jq -r '.[].attributes.url'

# Expected output:
https://azimuth-watcher-endpoint.example.com

  • Query for sushiswap-v3-subgraph deployment(s):

    • Find the SubgraphRecord for sushiswap-v3-subgraph:

      SUBGRAPH_RECORD_ID=$(laconic registry record list --all --type SubgraphRecord --name sushiswap-v3-subgraph | jq -r '.[].id')

    • Find corresponding deployment(s):

      laconic registry record list --all --type SubgraphDeploymentRecord subgraph $SUBGRAPH_RECORD_ID

# Get the deployment URL(s)
laconic registry record list --all --type SubgraphDeploymentRecord subgraph $SUBGRAPH_RECORD_ID | jq -r '.[].attributes.url'

# Expected output:
# https://sushiswap-v3-subgraph-endpoint.example.com

  • Query for geth service deployment(s):

    • Find the ServiceRecord for geth:

      SERVICE_RECORD_ID=$(laconic registry record list --all --type ServiceRecord --name geth | jq -r '.[].id')

    • Find corresponding deployment(s):

      laconic registry record list --all --type ServiceDeploymentRecord service $SERVICE_RECORD_ID

# Get the deployment URL(s)
laconic registry record list --all --type ServiceDeploymentRecord service $SERVICE_RECORD_ID | jq -r '.[].attributes.url'

# Expected output:
# https://geth-rpc-endpoint-1.example.com
# https://geth-rpc-endpoint-2.example.com