@owlprotocol/contracts

OWL Protocol Contracts

This repository contains all Owl Protocol Smart production smart contracts.

What is it?

We're developing plug-and-play smart contracts and libraries to make it easier for developers and creators to focus on what they do best: making great games and content.

With our platform, you can easily deploy contracts which implement complex functionality like item crafting and breeding.

TLDR

Comprehensive documentation can be found here.

See contracts for more info on using the smart contracts.

Deploy it yourself

If you want to deploy our contracts yourself, we have some scripts to make it slightly easier to manage the proxies and contracts. It also helps when deploying on many networks at once, and maintains the same deterministic address on all chains.

In deploy, run ProxyFactory.ts script. Take the address outputted and place it in variable ProxyFactoryAddress in CrafterTransfer.ts

https://github.com/wighawag/hardhat-deploy#the-deployments-field

hh deploy --tags Implementations --network polygon
hh

Testing

Temporarily not imported, though some tests do work directly (with some commonjs/module replacement):

TEST_FILE=lib/cjs/test/assets/ERC721/ERC721Dna-readOnChain.test.js pnpm run test-grep

Architecture

We use a somewhat complicated system of interlaced proxies in order to optimize for low-gas deployments and easily-upgradeable contracts. This comes at the cost of a small uptick in gas used per transaction.

See OWLArchitecture for more info on what's going on under the hood.

Development

See contract-structure.md for more info.

Roles

DEFAULT_ADMIN_ROLE              #Admin
CONTRACT_URI_ROLE               #Set contract uri
APPROVED_FOR_ALL_ROLE           #Approve all transfers (god-mode)
MINTER_ROLE                     #Mint token
REQUEST_ROLE                    #Request Chainlink
WITHDRAW_ROLE                   #Withdraw tokens
FULFILL_ROLE                    #Fulfill Chainlink request
DEPOSIT_ROLE                    #Deposit to asset router
ROYALTY_ROLE                    #Set royalty
TOKEN_ROYALTY_PROVIDER_ROLE     #Set royalty provider address
TOKEN_DNA_ROLE                  #Set dna
TOKEN_DNA_PROVIDER_ROLE         #Set dna provider address
TOKEN_URI_ROLE                  #Set uri (for TokenURI contract)
TOKEN_URI_BASE_URI_ROLE         #Set base uri (for TokenURIBaseURI and TokenURIDna)
TOKEN_URI_PROVIDER_ROLE         #Set uri provider address
TOKEN_ROLE                      #Set token address