tribute-contracts-cli

A command line interface tool to interact with @openlaw/tribute-contracts.

Usage no npm install needed!

<script type="module">
  import tributeContractsCli from 'https://cdn.skypack.dev/tribute-contracts-cli';
</script>

README

Tribute Contract CLI

Build

npm ci

Setup

From the root folder of the project:

  • Create the contracts.js, and set the contract's names and addresses from your DAO:
    const contracts = {
    // DAO Core Contracts
    DaoRegistry: "0x...",
    
    // Extensions
    BankExtension: "0x...",
    
    // Adapters
    ManagingContract: "0x...",
    OffchainVotingContract: "0x...",
    };
    
    module.exports = { contracts };
    
  • Create the .env file, and set the env vars:
    # The mnemonic to open your wallet and sign transactions
    TRUFFLE_MNEMONIC=...
    
    # The snapshot-hub URL to connect
    SNAPSHOT_HUB_API_URL=https://...
    
    # The space name defined in the Snapshot Hub API
    SNAPSHOT_HUB_SPACE=...
    
    # The Ethereum Network which CLI should interact with: ganache, rinkeby, mainnet
    ETHEREUM_NETWORK=rinkeby
    
    # Enable DEBUG to see the logs of the CLI interactions with SnapshotHub and DAO
    DEBUG=false
    
    # Infura Key
    INFURA_KEY=...
    
    # Alchemy Key
    ALCHEMY_KEY=...
    

Compile

npm run compile

Run

npm link trib --help

Version Compatibility

Contracts UI CLI Snapshot
v1.0.0 v1.1.0 v0.1.1 v1.2.0
v1.0.2 v1.1.0 v0.1.2 v1.2.0