1.0.1 • Published 5 months ago

bctsag-governance v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
5 months ago

Initial Setup

Prerequisites

The following tools are expected to be installed on your system to run this project:

  • Node
  • NPM
  • YARN
  • Hardhat
  • Git

Setup

Publish to NPM repository Tellor Protocol dependencies: 1. Publish tellorFlex to NPM repo (see the README.md in the tellorFlex folder) 2. Publish usingTellor to NPM repo (see the README.md in the usingTellor folder)

Install dependencies:

yarn install

Compile

Compile contracts:

npx hardhat compile

Lint

Run linter:

npx eslint .

Publish

Publish to NPM repository.

Login to your account at https://www.npmjs.com/:

npm login

Publish package to your NPM account:

npm publish

Usage

Test Locally (on hardhat)

Run unit tests on the contracts (on hardhat):

npx hardhat test

Test Locally (on localhost)

  1. Start HTTP and WebSocket JSON-RPC server at http://127.0.0.1:8545/:
npx hardhat node
  1. Run unit tests on the contracts (by other command line terminal):
npx hardhat test --network localhost

Deploy Smart Contracts

You need to set the environment variables NODE_URL and PRIVATE_KEY. To learn more about these environment variables, see the README.md in the tellorFlex folder.

Deploy Smart Contracts onto Fantom testnet

Deploy the contract onto the Fantom testnet:

npx hardhat run --network fantom_testnet scripts/deployGovernance3.js

Deploy Smart Contracts onto SwissDLT testnet

Deploy the contract onto the SwissDLT testnet:

npx hardhat run --network swissdlt_testnet scripts/deployGovernance3.js

Deploy Smart Contracts onto Hedera testnet

Deploy the contract onto the Hedera testnet:

npx hardhat run --network hedera_testnet scripts/deployGovernance3.js

Contributing

Bug reports and pull requests are welcome on GitHub at: https://github.com/BCTSAG/tellor