Skip to content

Commit

Permalink
fix: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Olanetsoft committed Sep 25, 2024
1 parent d798c36 commit cdf34f1
Showing 1 changed file with 51 additions and 8 deletions.
59 changes: 51 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,56 @@
# Sample Hardhat Project
# Interchain Governance with OpenZeppelin Governor Example

This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, and a script that deploys that contract.
Link to article: https://blog.axelar.dev/cross-chain-governance-with-openzeppelin-governor-and-axelar

Try running some of the following tasks:
## Getting Started

```shell
npx hardhat help
Clone the repository and install the dependencies:

```sh
git clone https://github.com/axelarnetwork/interchain-governance-with-openzeppelin-governor-example.git

cd interchain-governance-with-openzeppelin-governor-example

npm install
```

## Running the Example

To test the example, you can run the following command:

```sh
npx hardhat test
REPORT_GAS=true npx hardhat test
npx hardhat node
npx hardhat run scripts/deploy.js
```
You should see something similar to the following output:

```sh
CrossChainGovernor
Deployment
✔ Should set the right token
✔ Should set the right gas service
✔ Should set the right proposal sender
Governance settings
✔ Should have the correct voting delay
✔ Should have the correct voting period
✔ Should have the correct quorum
Whitelisting
✔ Should allow whitelisting a proposal sender
Threshold Proposal
✔ Should allow creating a threshold proposal
✔ Should allow voting on a threshold proposal (9103ms)
Proposal lifecycle
✔ Should start in the Pending state
✔ Should move to Active state after votingDelay
✔ Should allow voting when Active
Proposal Creation and Voting
✔ Should allow non-token holders to create proposals, but the proposal should fail (9040ms)
✔ Should not allow voting before the voting delay has passed
✔ Should not allow voting after the voting period has ended (9368ms)
✔ Should not allow double voting
Proposal Execution
✔ Should not allow execution of a proposal that hasn't succeeded
✔ Should allow execution of a succeeded proposal (9349ms)
✔ Should not allow execution of an already executed proposal (9709ms)
19 passing (50s)
```

0 comments on commit cdf34f1

Please sign in to comment.