@sygnum/sygnum-contracts v0.0.2

Secure foundation smart contracts used by other Sygnum contracts. Build on a solid foundation of community-vetted code, utilizing open-zeppelin industry standards.

• Admin, Operator, and System role-based permissioning scheme.
• Reusable Solidity components to build custom contracts and complex decentralized systems.
• Audited by Quantstamp with no major findings.

Overview

Installation

Login to your npmjs account that has been granted access to the npm @sygnum org.

$ npm login

$ npm install @sygnum/sygnum-contracts

Usage

Once installed, you can use the contracts in the library by importing them:

pragma solidity 0.5.0;

import "@sygnum/sygnum-contracts/contracts/role/Operatorable.sol";
import "@sygnum/sygnum-contracts/contracts/helpers/Pausable.sol";

contract MyContract is Operatorable, Pausable {
    constructor() public {
    }
}

To keep your system secure, you should always use the installed code as-is, and neither copy-paste it from online sources, nor modify it yourself. The library is designed so that only the contracts and functions you use are deployed, so you don't need to worry about it needlessly increasing gas costs.

Security

This project is maintained by Sygnum, and developed following our high standards for code quality and security. Please use common sense when doing anything that deals with real money! We take no responsibility for your implementation decisions and any security problems you might experience.

The latest audit was done on November 2019 on version 0.0.1.

Please report any security issues you find to connor.howe@sygnum.com.

License

Sygnum-Contracts is released under the MIT License.