Skip to content

README.md

Latest commit

 

History

History
75 lines (51 loc) · 2.12 KB

README.md

File metadata and controls

75 lines (51 loc) · 2.12 KB

Token Voting Plugin artifacts

This package contains the ABI of the TokenVoting Plugin for OSx, as well as the address of its plugin repository on each supported network. Install it with:

yarn add @aragon/token-voting-plugin-artifacts

Usage

// ABI definitions
import {
    TokenVotingABI,
    TokenVotingSetupABI,
    TokenVotingSetupZkSyncABI,
    VotingPowerConditionABI,
    GovernanceERC20ABI,
    GovernanceWrappedERC20ABI,
    IERC20MintableUpgradeableABI,
    IGovernanceWrappedERC20ABI
} from "@aragon/token-voting-plugin-artifacts";

// Plugin Repository addresses per-network
import { addresses } from "@aragon/token-voting-plugin-artifacts";

You can also open addresses.json directly.

Development

Building the package

Install the dependencies and generate the local ABI definitions.

yarn --ignore-scripts
yarn build

The build script will:

  1. Move to ../src.
  2. Compile the contracts using Foundry.
  3. Generate their ABI.
  4. Extract their ABI and embed it into on src/abi.ts.

Deployment addresses

Add the plugin repo address for new networks to src/addresses.json.

Publishing

  • Access the repo's GitHub Actions panel
  • Click on "Publish Artifacts"
  • Select the corresponding release-v* branch as the source

This action will:

  • Create a git tag like v1.2, following package.json's version field
  • Publish the package to NPM

Documentation

You can find all documentation regarding how to use this plugin in Aragon's documentation here.

Contributing

If you like what we're doing and would love to support, please review our CONTRIBUTING_GUIDE.md here. We'd love to build with you.

Security

If you believe you've found a security issue, we encourage you to notify us. We welcome working with you to resolve the issue promptly.

Security Contact Email: sirt@aragon.org

Please do not use the issue tracker for security issues.