Nomenclature Processing Machine

    selfkey-token

    1.1.1 • Public • Published

    SelfKey Token

    Greenkeeper badge

    An ERC20 token used to fuel a wide range of KYC related dapps

    • develop Build Status codecov
    • master Build Status codecov

    About

    Development

    The smart contracts are being implemented in Solidity 0.4.19.

    Prerequisites

    • NodeJS, version 9+ (I use nvm to manage Node versions — brew install nvm.)
    • truffle, which is a comprehensive framework for Ethereum development. npm install -g truffle — this should install Truffle v4.0.6 or better. Check that with truffle version.
    • Access to the KYC_Chain Jira

    Optional but very useful

    • Docker (don't brew install docker as it's nowhere near as relaible. Use the official Docker For Mac installer.)
    • ethereum-docker — run geth and any monitoring tools within docker using docker-compose up -d

    Initialisation

        npm install
    

    Compiling

    From within Truffle

    Run the truffle development environment

    truffle develop
    

    then from the prompt you can run

    compile
    migrate
    test
    

    as well as other truffle commands. See truffleframework.com for more.

    Standalone

    Run

    npm test
    

    To generate code coverage reports run

    npm run test:cov
    

    Note Generating code coverage reports takes a bit longer to run than just running the tests.

    Linting

    We provide the following linting options

    • npm run lint:sol — to lint the solidity files, and
    • npm run lint:js — to lint the javascript.

    Deploying to ropsten

    You'll need an address on the Ropsten blockchain with some ETH in it.

    Use MetaMask to create a wallet and use faucet.metamask.io to get some ETH for it.

    You will need to supply a file called wallet.json in the root of the project.

    {
      "name": "my awesome wallet",
      "mnemonic": "the sequence of twelve words you used to keep your wallet secure"
    }
    

    Then run

    npm run deploy:ropsten
    

    Contributing

    Contributions are welcomed. Please see the contributing notes

    Install

    npm i selfkey-token

    DownloadsWeekly Downloads

    0

    Version

    1.1.1

    License

    MIT

    Unpacked Size

    77 kB

    Total Files

    21

    Last publish

    Collaborators

    • cbruguera