Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@bisonai/orakl-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Orakl Network CLI

This package is used controlling Orakl Network nodes.

Development

yarn install
yarn build

Settings

Orakl CLI uses SQLite in backend to store all relevant settings. The default database (settings.sqlite) is stored at ${HOME}/.orakl. If you wish to change the default location, you can set it with ORAKL_DIR environment variable.

Environment Variables

ORAKL_NETWORK_API_URL
ORAKL_NETWORK_FETCHER_URL

Publishing

@bisonai/orakl-cli is published through Github Actions pipeline when package version specified in package.json changes.

Chain

List all chains

npx orakl-cli chain list

[
  { id: 1, name: 'localhost' },
  { id: 2, name: 'baobab' },
  { id: 3, name: 'cypress' }
]

Insert new chain

npx orakl-cli chain insert --name other

Remove chain specified by id

npx orakl-cli chain remove --id 4

Service

List all services

npx orakl-cli service list

[
  { id: 1, name: 'VRF' },
  { id: 2, name: 'Aggregator' },
  { id: 3, name: 'RequestResponse' }
]

Insert new service

npx orakl-cli service insert --name Automation

Remove service specified by id

npx orakl-cli service remove --id 4

Listener

List all listeners

npx orakl-cli listener list

[
  {
    address: '0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0',
    eventName: 'RandomWordsRequested'
  },
  {
    address: '0xa513E6E4b8f2a923D98304ec87F64353C4D5C853',
    eventName: 'NewRound'
  },
  {
    address: '0x45778c29A34bA00427620b937733490363839d8C',
    eventName: 'Requested'
  }
]

List listeners based on --chain filter

npx orakl-cli listener list --chain localhost

List listeners based on --service filter

npx orakl-cli listener list --service VRF

[
  {
    address: '0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0',
    eventName: 'RandomWordsRequested'
  }
]

Insert new listener to baobab chain

npx orakl-cli listener insert \
    --chain baobaob \
    --service VRF \
    --address 0x97ba95dcc35e820148cab9ce488f650c77e4736f \
    --eventName SomeEvent

Remove listener specified by id

npx orakl-cli listener remove --id 4

VRF

List all VRF keys

npx orakl-cli vrf list

List VRF keys based on --chain filter

npx orakl-cli vrf list --chain localhost

Insert new VRF keys for baobab chain. VRF keys can be generated with npx orakl-cli keygen

npx orakl-cli vrf insert \
    --sk 83a8c15d203a71f4f9e7238d663d1ae7eabe10bee47699d4256438acf9bdcce3 \
    --pk 044ffbfebcd28f48144c18f7bd9f233199c438b39b5ce1ecc8f049924ba57a8740a814ca7ac5d14c34850e3b61dcbce296de95a4578ac928f8bab48f2a834d1bb9 \
    --pk_x 36177951785554001241008675842510466823271112960800516449139368880820117473088 \
    --pk_y 76025292965992487548362208012694556435399374398995576443525051210529378212793 \
    --chain baobab

Remove VRF keys specified by id

npx orakl-cli vrf remove --id 2

Adapter

List all adapters

npx orakl-cli adapter list

List all adapters registered for baobab chain

npx orakl-cli adapter list --chain baobab

Add new adaper

npx orakl-cli adapter insert --file-path [adapter-file] --chain baobab

Remove adapter

npx orakl-cli adapter remove --id [id]

Add new adapter from other chain

npx orakl-cli adapter insertFromChain --adapter-id [adapter-id] --from-chain [from-chain] --to-chain [to-chain]

Aggregator

List all aggregators

npx orakl-cli aggregator list

List all aggregators registered for baobab chain

npx orakl-cli aggregator list --chain baobab

Add new aggregator

npx orakl-cli aggregator insert --file-path [aggregator-file] --adapter [adapter-id] --chain baobab

Remove aggregator

npx orakl-cli aggregator remove --id [id]

Add new aggregator from other chain

npx orakl-cli aggregator insertFromChain --aggregator-id [aggregator-id] --adapter [adapter-id] --from-chain [from-chain] --to-chain [to-chain]