Giter Club home page Giter Club logo

contracts's Introduction



thirdweb Contracts

npm version Build Status Join our Discord!

Collection of smart contracts deployable via the thirdweb SDK, dashboard and CLI


Installation

npm i @thirdweb-dev/contracts

Running Tests

  1. yarn: install contracts dependencies
  2. forge install: install tests dependencies
  3. forge test: run the tests

This repository is a hybrid hardhat and forge project.

First install the relevant dependencies of the project:

yarn

forge install

To compile contracts, run:

forge build

Or, if you prefer hardhat, you can run:

npx hardhat compile

To run tests:

forge test

To export the ABIs of the contracts in the /contracts directory, run:

npx hardhat export-abi

To run any scripts in the /scripts directory, run:

npx hardhat run scripts/{path to the script}

Pre-built Contracts

Pre-built contracts are written by the thirdweb team, and cover the most common use cases for smart contracts.

Release pages for pre-built contracts:

Learn more about pre-built contracts

Extensions

Extensions are building blocks that help enrich smart contracts with features.

Some blocks come packaged together as Base Contracts, which come with a full set of features out of the box that you can modify and extend. These contracts are available at contracts/base/.

Other (smaller) blocks are Features, which provide a way for you to pick and choose which individual pieces you want to put into your contract; with full customization of how those features work. These are available at contracts/extension/.

Learn more about extensions

Deployments

The thirdweb registry (TWRegistry) and factory (TWFactory) have been deployed on the following chains:

TWRegistry is deployed to a common address on all mentioned networks. TWFactory is deployed to a common address on all mentioned networks except Fantom mainnet.

Bug reports

Found a security issue with our smart contracts? Send bug reports to [email protected] and we'll continue communicating with you from there. We're actively developing a bug bounty program; bug report payouts happen on a case by case basis, for now.

Feedback

If you have any feedback, please reach out to us at [email protected].

Authors

License

Apache 2.0

contracts's People

Contributors

adam-maj avatar atbe avatar atharvadeosthale avatar ciaranightingale avatar furqanrydhan avatar jakeloo avatar jarrodwatts avatar jnsdls avatar joaquim-verges avatar kumaryash90 avatar nachoiacovino avatar ndeto avatar nkrishang avatar ryleysill93 avatar saarthdeshpande avatar warengonzaga avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.