README
General utility module with helper smart contracts.
The 0xcert Framework is a free and open-source JavaScript library that provides tools for building powerful decentralized applications. Please refer to the official documentation for more details.
This module is one of the bricks of the 0xcert Framework. It's written with TypeScript and it's actively maintained. The source code is available on GitHub where you can also find our issue tracker.
Ethereum Utility Contracts
This module includes Solidity contracts which should be useful for any smart contract project.
safe-math.sol
Safe math -- This library includes basic arithmetic operations for unsigned 256-bit integers. This is a modern, gas-efficient implementation which also includes error reporting.
This implementation is based on the openzeppelin-solidity however the documentation and readability of the code is much improved. We hope this will help you to write more error-free code.
Example usage:
pragma solidity ^0.5.6;
import "https://github.com/0xcert/framework/packages/0xcert-ethereum-utils-contracts/src/contracts/math/safe-math.sol";
contract MilitaryStrengthAdder
{
using SafeMath for uint256;
function add(
uint256 _addend1,
uint256 _addend2
)
external
pure
returns (uint256 sum)
{
return _addend1.add(_addend2);
}
}
abilitable.sol
Abilities -- This is a permissions model where you may assign different forms of permission on your contract to any address. Typically these permissions will be used to allow administrative tasks on a smart contract.
ownable.sol
and claimable.sol
Ownership -- These are two ownership models that you can use for any smart contract. Ownable uses a single owner model that can be transferred unilaterally to a new owner. Claimable extends this model to a two-step transfer process, first the existing must send and the new owner must receive, the ownership privilege.
address-utils.sol
Address utilities -- This allows you to check whether any address is a normal account or if it is a smart contract. Please note that a normal account can become a smart contract (CREATE
) and a smart contract can become a normal account (SELFDESTRUCT
).
erc165.sol
and supports-interface.sol
ERC-165 -- ERC-165 is a standard for publishing interfaces that your smart contract supports. If you are implementing a standard interface then it is best practice for your contract to identify this with ERC-165. This makes it simple for other contracts to detect how it works so they can cooperate as expected.
Build
By default, the contracts in this package are built for Constantinople EVM. If you would like to use these smart contracts for Wanchain
or other blockchains using EVM for a different version, you will need to rebuild them for the desired version.