Skip to main content
Version: 3.x

OpenBrush

OpenBrush is a library for smart contract development on ink! maintained by the Brushfam team.

It provides standard contracts based on PSPs, as well as useful contracts and Rust macros to help you build ink! smart contracts.

Using OpenBrush is simple, you will only add the dependency to your Cargo.toml file. Here is an example of how to do it.

Why use OpenBrush?​

  • To make contracts interoperable to do safe cross-contracts calls (by having the same function's signature among every contract)
  • To ensure the usage of Polkadot Standards Proposals
  • To ensure the usage of the latest and most secure implementation
  • Useful contracts that provide custom logic to be implemented in contracts
  • To save time by not writing boilerplate code
  • Useful features which can simplify development

Which standard tokens and useful contracts does it provide?​

  • PSP22 - Fungible Token (ERC20 equivalent) with extensions
  • PSP34 - Non-Fungible Token (ERC721 equivalent) with extensions
  • PSP37: ERC1155 equivalent with extensions
  • Ownable Restrict access to action for non-owners
  • Access Control: Define a set of roles and restrict access to an action by roles
  • Reentrancy Guard: Prevent reentrant calls to a function
  • Pausable: Pause/Unpause the contract to disable/enable some operations
  • Timelock Controller: Execute transactions with some delay
  • Payment Splitter: Split the amount of native tokens between participants

Generic Trait Implementation​

More importantly, OpenBrush adds support for generic Trait implementation so you can split Trait and Impls into different files, which will increase the readability and maintainability of your smart-contract code base (see detailed description here)

Wrapper around Traits​

Defining a Trait definition is sufficient (a contract that implements that Trait is not needed anymore) to call methods of that Trait from some contract in the network (do a cross contract call). It makes cross-contract calls easier.

Documentation​

Typechain-Polkadot​

Another tool essential for ink! smart contracts development is Typechain-Polkadot.

Typechain-Polkadot is used to generate Typescript wrappers around your smart-contract, which can be used in UI or in integration tests of your ink! smart contracts. It uses polkadot-api under the hood, but is especially useful because all calls and queries are typed, therefore the chance of getting some error during a call is mitigated.

Sol2Ink​

Sol2Ink is a useful tool which can help you migrating from Solidity to ink! You will only pass the Solidity code of your smart contract to Sol2Ink and get the ink! contract in return. You can also use Sol2Ink to learn the differences between Solidity and ink! code and use it to help you learning to create ink! smart contracts.