Co-Museum Contracts

This repository contains the smart contracts for the Co-Museum project.

Running Local Dev Environment

Running yarn hardhat node followed by yarn deploy-test should provide you with a full test environment you can develop/test against.

After that connect to the hardhat network at http://localhost:8545, with a chain ID of 31337. Input this info into your wallet to connect to the network and create custom tokens using the addresses produced by the deployment script

Since contract addresses are computed as a function of the deployer's address and their transaction number, if you start from a clean slate (start a fresh node and immediately deploy) you should always end up with the same addresses (such that you only need to take note of them once).

Make sure you're using one of the accounts specified in hardhat.config.ts

Contract/User Relationships

Approval, sender (see PartiallyPausable) as well as other relevant relationships between the Co-Museum contracts are laid out in the following diagram (dynamic relationshops in red):

• Implementation details are ommited from this diagram.
• All user approvals must be dynamically requested for
• Where relationships are through another contract they are indicated with a label suffix such as approves-stablecoin

erDiagram
  USER ||--o{ CROWDSALE-CONTRACT : approves-stablecoin
  USER ||--o{ MEMBERSHIP-CONTRACT : approves-art-token
  USER ||--o{ MEMBERSHIP-CONTRACT : approves-membership

  MEMBERSHIP-CONTRACT ||--|| MEMBERSHIP-CONTRACT : sender-of
  CROWDSALE-CONTRACT ||--|| ART-TOKEN : sender-of
  MEMBERSHIP-CONTRACT ||--|| ART-TOKEN : sender-of

  NFT-OWNER ||--|| TOKEN-VAULT-FACTORY : approves-art-nft
  SETTINGS ||--|| TOKEN-VAULT-FACTORY : configures
  TOKEN-VAULT-FACTORY ||--o{ ART-TOKEN : deploys

  ART-TOKEN-HOLDING-WALLET ||--|| MEMBERSHIP-CONTRACT : approves-art-token
  ART-TOKEN-HOLDING-WALLET ||--|| CROWDSALE-CONTRACT : approves-art-token
  CROWDSALE-CONTRACT ||--|| TREASURY-WALLET : pays

Loading

Building

git clone https://github.com/co-museum/contracts.git co-museum-contracts
cd co-museum-contracts
yarn install
yarn hardhat compile
yarn hardhat <task>

Scripts

yarn prettier:format
yarn prettier:check
yarn test
yarn test:coverage
yarn test:gas
yarn deploy:test