/examples

Examples of contracts using RoyalDAO extensions

Primary LanguageTypeScriptMIT LicenseMIT

RoyalDao

Collection of Examples using the Senate/Chancellor pattern

Overview

Who Am I?

I am Vin Rodrigues, Co-founder of QueenEDAO, along with other 3 people (see more at QueenE Repo), and the creator and, currently, only maintainer of RoyalDao Libraries.

QueenEDAO was an innovative project inspired by NounsDAO and using Openzeppelin Governance Contracts.

The innovation in the project falls into the fact that the collection is tied to real world events and can end at an unknown moment. In this specific case, the death of Queen Elizabeth, who inspired the fictional Character QueenE.

So, we knew from the beginning that we would need to find a solution to keep the DAO running and Growing after the event, that came sooner than any of us imagined.

With this background, I envisioned the Senate pattern. Based in the Governor pattern, from Openzeppelin, the Senate allows multiple tokens (at this point, only ERC721) to participate into one single DAO. So, no matter the project you have tokens from, if it is a member of the Senate, you can propose and vote in the same DAO.

The basic pattern is usable in beta and documentation is being done. You can see here some usage examples.

Cloning

Clone the repository

$ git clone https://github.com/RoyalDAO/examples.git

Usage

Once cloned, you can bash into the directory of the example you want to use/test.

$ cd ./RepublicSenateUpgradeable

Install all dependencies

$ npm

or using yarn

$ yarn

The repo is built with some standard testing that will be built over time.

Feel free to run those or built your own.

$ yarn test

If you're new to smart contract development, i strongly recomend all the content made by Sir Patrick Collins, but specially his 36h Course...i swear it's woth it!

Learn More

I am currently building the base docs of the library here. Should be done soon, depending on how much i need to sleep or rest (it has been a while). But you can learn a lot by this repo.

I urge you to take a look at OpenZeppelins Knowledge base! It will help a lot in Smart Contracts Development learning path.

Security

This project is maintained by me mostly, and developed following my questionable standard for code quality and security. So ,PLEASE, use common sense when doing anything that deals with real money! I take no responsibility for your implementation decisions and any security problems you might experience.

As soon i can leverage some funds from sponsorship (you can sponsor me through Github Sponsor and BuyMeACoffee) i intend to audit everything, but 'till there, if you find any vulnerability, please contact us through security e-mail sec.royaldao@gmail.com.

Contribute

I will document the contributing process soon, but in the meanwhile you can email me at [royal dao.contracts@gmail.com](mailto:royal dao.contracts@gmail.com). Lets build!

License

RoyalDao's Contracts is released under the MIT License.