Skip to content

Latest commit

 

History

History
 
 

guardian-cli

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
index.ts
index.ts
 
 
package.json
package.json
 
 

README.md

@open-web3/guardian-cli

Overview

guardian-cli is a tool to configure and run guardian JS library.

Guardian library is used to monitor on-chain states and events. When a user has defined criteria are met, it will execute a script or post a webhook to perform an action. This action can notify users, or initiate/participate in collateral auctions such as send a transaction.

See #1 for spec and example.

Example

To use guardian-cli tool first install package globaly.

yarn global add @open-web3/guardian-cli

Create a YAML config file.

version: "0.1"
guardians:
  - chain: substrate
    nodeEndpoint: wss://kusama-rpc.polkadot.io/

    monitors:
      accounts-monitor: # user defined
        task: system.accounts

        arguments:
          account:
            - 5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty
            - 5DAAzDBM2xoob4fcN4X7c8QXxZj7AEENfcMQWApUE6ALspWG

        actions:
          - method: script
            path: ./do_something # any script

Start guardian using the command.

guardian-cli --config=./config.yaml

guardian will start monitoring and will execute script do_something when there's a balance change. The script can read the data from stdin.