npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@daonomic/regulated

v0.3.0

Published

Security tokens

Downloads

23

Readme

Contracts for Regulated Tokens

Regulated tokens essentially are ERC-20 tokens, but with additional checks for transfer/transferFrom functions. These checks must be carried out to comply with different laws regarding securities in different countries.

How it works

  1. Investor identification is done using one or more Investor Data provider (https://github.com/daonomic/contracts-regulated/blob/master/contracts/InvestorDataProvider.sol)
  2. After that different jurisdiction regulation rules are applied. If all checks pass, then transfer is allowed

contracts

Investor Data provider

Investor Data provider is Oracle which has one function:

    /**
     * @dev resolve investor address
     * @param _address Investor's Ethereum address
     * @return struct representing investor - its jurisdiction and some generic data
     */
    function resolve(address _address) public returns (Investor);

investor is declared as following:

    struct Investor {
        uint16 jurisdiction;
        bytes30 data;
    }
  • jurisdiction is jurisdiction id. Currently supported jurisdictions are stored here: https://github.com/daonomic/contracts-regulated/blob/master/contracts/Jurisdictions.sol
  • data is arbitrary data (specific for investor's jurisdiction, for example, for US 1st bit of information tells if investor is accredited)

This data should be stored on-chain.

Supported providers

Our platform supports any KYC provider available:

  • issuer can check investor's status by himself
  • or select any present KYC provider (platform supports any KYC provider available with little or no development)

Regulation rules

Excerpt from https://github.com/daonomic/contracts-regulated/blob/master/contracts/RegulationRule.sol:

    /**
     * @dev Regulated tokens should call this when new tokens are minted
     */
    function checkMint(address _address, uint256 _amount, Investor investor) public returns (bool);

    /**
     * @dev Regulated tokens should call this when tokens are to be transferred from investor's account
     */
    function checkTransferFrom(address _address, uint256 _amount, Investor _investor) public returns (bool);

    /**
     * @dev Regulated tokens should call this when tokens are to be transferred to investor's account
     */
    function checkTransferTo(address _address, uint256 _amount, Investor _investor) public returns (bool);

RegulationRule should define any logic specific for investor's jurisdiction. For example, if investor is from US, he must be accredited investor to buy tokens (https://github.com/daonomic/contracts-regulated/blob/master/contracts/UsRegulationRule.sol)

Support for Exchanges

One more function needed to provide better UX with regulated tokens exchange: Exchange should filter investors who can buy/sell regulated tokens. This can be done through simple check function:

    /**
     * @dev Check if investor is able to receive token
     */
    function ableToReceive(address _address, uint256 _amount) constant public returns (bool);

Exchange should create/fill orders only for investors passing this check. Otherwise orders will fail on the fill step