Skip to content

Latest commit

 

History

History
113 lines (71 loc) · 3.57 KB

README.md

File metadata and controls

113 lines (71 loc) · 3.57 KB
Raw

Fractal Contracts

Azorius Protocol

A Safe module which allows for composable governance.

Azorius conforms to the Zodiac pattern for Safe modules.

The Azorius contract acts as a central manager of DAO Proposals, maintaining the specifications of the transactions that comprise a Proposal.

All voting details are delegated to BaseStrategy implementations, of which an Azorius DAO can have any number.

Azorius was forked from and heavily based on the Usul module, by SekerDAO.

Contract Documentation

NatSpec documentation for Azorius Protocol contracts are available here.

Local Setup & Testing

Clone the repository:

git clone https://github.com/decent-dao/fractal-contracts.git

Look up the recommended Node version to use in the .nvmrc file and install and use the correct version:

nvm install
nvm use

Install necessary dependencies:

npm install

Copy the example .env and replace the values for the desired networks

cp .env.example .env

Compile contracts to create typechain files:

npm run compile

Run the tests

npm run test

Update natspec doc files after modifying contracts

npx hardhat docgen

Deploy Contracts to <network>

npx hardhat deploy --network <network>

Deployed contracts can be verified on Etherscan via the following command:

npx hardhat verify --network {network name} {contract address}

Currently, this is done manually for each contract deployed, found in deployments/<network>/XXX.json

Local Hardhat deployment

To deploy the Fractal contracts to a local node:

npx hardhat node

NPM Package

The core contracts in this repository are published in an NPM package for easy use within other repositories.

To install the npm package in your project, run:

npm i @fractal-framework/fractal-contracts

To include uncompiled contracts within typechain-types follow these steps.

Publishing new versions to NPM

  1. Increment the version in package.json, then npm install to get those version updates into package-lock.json.
  2. Get those changes into the main branch through a PR.
  3. Tag the merge commit with that version number you just bumped.
  4. Create a Release on GitHub.

Versioning

Fractal follows a modified style of semantic versioning (https://semver.org/) specific to a smart contract use case.

There are three types of releases:

  • MAJOR: Rare, and correlates to a major overhaul to the core DAO governance contracts. These are changes incompatible with prior contract versions and would require an existing DAO's successful proposal to migrate to. A major version will have undergone a professional smart contract audit.
  • MINOR: Adds backwards-compatible functionality and additional utility or optimizations to the core governance smart contracts. New functionality will not impact the existing core governance contracts, will be optional for a DAO to utilize, and will have undergone either a contract audit or community bug bounty.
  • PATCH: Also rare, but adds bug and/or security fixes. No new functionality will be introduced and the code may or may not have a contract audit or bug bounty, depending on the context and severity of the issue. Also depending on the context of the issue, DAOs may be required to pass a proposal to migrate to this new version.