Skip to content

README.md

Latest commit

 

History

History
74 lines (48 loc) · 1.92 KB

README.md

File metadata and controls

74 lines (48 loc) · 1.92 KB

Admin Plugin artifacts

This package contains the ABIs of the OSx Admin plugin, as well as the address of the plugin repository on each supported network.

Installation

yarn add @aragon/admin-plugin-artifacts

Usage

import {
    AdminSetupABI,
    AdminABI
} from "@aragon/admin-plugin-artifacts";

import { addresses } from "@aragon/admin-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 packages/contracts.
  2. Install its dependencies.
  3. Compile the contracts using Hardhat.
  4. Generate their ABI.
  5. Extract their ABI and embed it into on src/abi.ts.

Syncing the deployment addresses

Clone OSx Commons in a folder next to this repo.

yarn sync-addresses

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.