Skip to content

Latest commit

 

History

History
221 lines (176 loc) · 11.1 KB

README.md

File metadata and controls

221 lines (176 loc) · 11.1 KB
Raw

OpenBrush

Docs telegram chat element chat discord chat

OpenBrush is maintained by the Brushfam team, and was created to make ink! development faster, safer and easier. We plan to integrate most of the features OpenBrush into ink!. OpenBrush provides documentation with FAQ section.

If you have any questions regarding OpenBrush, you can join the Brushfam Element channel to find your answers and meet other ink! smart contracts developers, or ask questions regarding ink! development on Element, Discord, or Telegram OpenBrush channels by the links above.

Summary

OpenBrush is a library for smart contract development on ink!.

Why use this library?

  • To make contracts interoperable to do safe cross-contracts calls (by having the same functions signature among every contracts)
  • To ensure the usage of Polkadot Standards Proposals
  • To ensure the usage of the latest & 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
  • All contracts are upgradeable by default

Which Standard tokens & 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 set of roles and restrict access to 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 amount of native tokens between participants

Default implementation in ink! traits

You can provide a default implementation in the traits method and have internal functions. You can use the ink! trait as a native rust trait with several restrictions regarding external functions(functions marked #[ink(message)]).

#[openbrush::trait_definition]
pub trait Governance: AccessControl {
    #[ink(message)]
    fn execute(&mut self, transaction: Transaction) -> Result<(), GovernanceError> {
        self.internal_execute(transaction)
    }

    fn internal_execute(&mut self, transaction: Transaction) -> Result<(), GovernanceError> {
        ...
    }
}

Modifiers

Solidity smart contracts provides modifiers to restrain function call to certain pre-defined parameters. OpenBrush provides attribute macros to use standardised modifiers. You can use our useful contracts to use as modifiers, or define your own modifiers.

// Before execution of `mint` method, `only_owner` should verify that caller is the owner.
#[ink(message)]
#[modifiers(only_owner)]
fn mint(&mut self, ids_amounts: Vec<(Id, Balance)>) -> Result<(), PSP1155Error> {
  self._mint_to(Self::env().caller(), ids_amounts)
}

Wrapper around traits

You are enough to have a trait definition (you don't need directly a contract that implements that trait) to call methods of that trait from some contract in the network (do a cross contract call).

// Somewhere defined trait
#[openbrush::trait_definition]
pub trait Trait1 {
    #[ink(message)]
    fn foo(&mut self) -> bool;
}

// You can create wrapper in the place where you defined the trait
// Or if you import **everything** from the file where you define trait
#[openbrush::wrapper]
type Trait1Ref = dyn Trait1;

{
    // It should be `AccountId` of contract in the network that implements `Trait1` trait
    let callee: openbrush::traits::AccountId = [1; 32].into();
    // This code will execute a cross contract call to `callee` contract
    let result_of_foo: bool = Trait1Ref::foo(&callee);
}

Note: The trait should be defined with openbrush::trait_definition. The callee contract should implement that trait.

Additional stuff

Not sure where to start? Use the interactive generator to bootstrap your contract and learn about the components offered in OpenBrush.

‼️ Important ‼️

Events are not supported currently due to how ink! currently handles them.
The identifiers of events must be based on the name of the trait. At the moment, ink! doesn't support it, but it must be fixed with this issue.

Issues to be resolved before the library becomes production-ready:

Other Issues open:

Roadmap 🚗

OpenBrush participates in the Web3 Grants, you can find the roadmap here

More common roadmap of tasks
  • Implement fungible, non-fungible, and multi tokens.
  • Implement AccessControl and Ownable.
  • Add examples of how to reuse ERC20, ERC721, AccessControl implementations.
  • Stub implementations for token and access folders.
  • Add base description of project
  • Remove the boilerplate to make the internal implementation external.
    • Implement openbrush::contract macro to consume all openbrush's stuff before ink!.
    • Implement openbrush::trait_definition which stores definition of trait and allow to use it in openbrush::contract macro.
    • Implement impl_trait! macro which reuse internal implementation in external impl section.
  • Refactor examples and tests with new macros.
  • Decide how to handle errors and implement it in library (Decided to use panic! and assert!).
  • Create derive macro for storage traits. This macro must adds fields to contract's struct.
  • Cover all contracts with unit tests and integration tests.
  • Create documentation based on readme. Add comments to macros with example of usage.
  • Add Ownable + ERC1155 example.
  • Support simple modifiers (which can only call functions without code injection).
  • Instead of impl_trait! macro add support of default implementation in external trait definition.
  • Add Pausable, TimelockController and PaymentSplitter contracts.
  • Support code injection in modifiers.
  • Implement a reentrancy guard and example of usage.
  • Add more examples and documentation on how to use the library.
  • Finalize PSP for fungible tokens. Refactor of implementation.
  • Agnostic traits.
  • Wrapper around the trait definition to do a cross-contract calls.
  • PSP for NFT token and refactoring according new interface.
  • PSP for Multi token and refactoring according new interface.
  • Add extension: PSP34Enumerable.
  • Import all extensions for tokens from OpenZeppelin.
  • Add support of upgradeable contracts to ink!/contract-pallet level.
  • Implement Proxy pattern.
  • Implement Diamond standard.
  • Publish openbrush into crates.io
  • Add documentation for upgradeable contracts.
  • Add extension: AccessControlEnumerable.
  • Add extension: PSP37Enumerable.
  • Force/help ink! to create new independent events. During this task decide how ink! can generate metadata for events/traits from other crates.
  • Cover everything with UT and integration tests.
  • Improve ink! to allow code injection to have default implementation on ink! level instead Rust level.
  • Refactor the OpenBrush to use default implementation from the ink!.
  • Implement AssetChainExtension to work with asset-pallet.
  • Implement PSP22 via AssetChainExtension.
  • Implement UniquesChainExtension to work with uniques-pallet.
  • Implement PSP34 via UniquesChainExtension.
  • Audit.

Installation & Testing

To work with project you need to install ink! toolchain and NodeJS's dependencies.

Build

$ yarn build

If you want to build in release mode, you can use this command

$ yarn build:release

Tests

You can run unit tests by RUSTFLAGS="-D warnings" cargo +nightly test --workspace --features test-all -- --test-threads=10 command from the root of the directory.

To run integration test you need to start the node with contract-pallet.

After you can run tests by npm run test command. It will build all contracts required for integration tests and run them.

FAQ

Was it audited?

Contracts in this repository have not yet been audited and contain several vulnerabilities due to the specific of the ink!. We know about them and will fix them with a new versions of ink!. ink! will have soon several major changes, so it does not make sense to audit it now. ink! is not ready for production at the moment. It requires resolving some issues.

After that, we plan to do an audit.

License

OpenBrush is released under the MIT License.