Giter VIP home page Giter VIP logo

documentation's Introduction

T-REX : Token for Regulated EXchanges

GitHub GitHub release (latest by date) GitHub Workflow Status (branch) GitHub repo size GitHub Release Date




Overview

The T-REX (Token for Regulated EXchanges) protocol is a comprehensive suite of Solidity smart contracts, implementing the ERC-3643 standard and designed to enable the issuance, management, and transfer of security tokens in compliance with regulations. It ensures secure and compliant transactions for all parties involved in the token exchange.

Key Components

The T-REX protocol consists of several key components:

  • ONCHAINID: A smart contract deployed by a user to interact with the security token or any other application where an on-chain identity may be relevant. It stores keys and claims related to a specific identity.

  • Trusted Issuers Registry: This contract houses the addresses of all trusted claim issuers associated with a specific token.

  • Claim Topics Registry: This contract maintains a list of all trusted claim topics related to the security token.

  • Identity Registry: This contract holds the identity contract addresses of all eligible users authorized to hold the token. It is responsible for claim verification.

  • Compliance Smart Contract: This contract independently operates to check whether a transfer is in compliance with the established rules for the token.

  • Security Token Contract: This contract interacts with the Identity Registry to check the eligibility status of investors, enabling token holding and transactions.

Getting Started

  1. Clone the repository: git clone https://github.com/TokenySolutions/T-REX.git
  2. Install dependencies: npm ci
  3. Compile the contracts: hardhat compile
  4. Run tests: hardhat test

Documentation

For a detailed understanding of the T-REX protocol, please refer to the whitepaper. All functions of T-REX smart contracts are described in the T-REX documentation

Contributing

We welcome contributions from the community. Please refer to the CONTRIBUTING guide for more details.

License

This project is licensed under the GNU General Public License v3.0.



documentation's People

Contributors

nakasar avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Forkers

andriy-shymkiv

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.