From 5ecf2abd79c7fd2e178336ba1c05f937e5401948 Mon Sep 17 00:00:00 2001 From: Chris Hagedorn <1844858+ChrisHagedorn@users.noreply.github.com> Date: Fri, 16 Aug 2024 17:45:38 -0400 Subject: [PATCH] Add main readme (#71) * Staging (#45) * Added SDK integration, flexible policy accounts, and general security updates (#41) * make policy account resizable * resiable idenitty accounts (#35) * resiable idenitty accounts * update tests, init more tests * remove commented files * update signer checks + hash policy account (#36) * update signer checks to use only authority or delegate * policy hash + patches (#38) * generic security fixes * use hash to identify policies (#39) * use hash to identify policies * use policy account in hash * Merged resizable policies and dashboards * Updated clients rwa-token-sdk for resizable policy * Added program * update anchor binary * update idls * Rename IDL types in client * use camel case + fix eslint + fix tests partially + update anchor repo * fix tests * Added @bridgesplit/sdk update to example * Updated to support new PolicyType * Updated policy enum types * Updated examples * fix typedoc issues * fix typedoc issues * Update instructions * Updated instructions * Convention update * Updated typedoc json * Updated testing path * Removed examples * fix build yaml * update package + add lint to actions * update package naming across file * rm untracked file * Added conventions * Updated client to be coral anchor. * clear github cache * Deleted old idls * update file names * fix tests --------- Co-authored-by: Bhargava Sai Macha * Fixed documentation (#44) --------- Co-authored-by: Chris Hagedorn <1844858+ChrisHagedorn@users.noreply.github.com> * Update README.md (#51) * Create README.md --------- Co-authored-by: Bhargava Sai Macha Co-authored-by: Luke Truitt <38018183+luke-truitt@users.noreply.github.com> --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e40675b --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +

+ RWA Token Program +

+

+ Program to issue, manage, and integrate off-chain backed tokens on SVM blockchains. +

+ +## Overview +Non-blockchain originated tokens (NBOs), also referred to as Real World Assets (RWAs), encompass tangible and intangible assets with property rights enforced by a legal system rather than the blockchain. The blockchain serves as a programmable ledger for these assets and trust-minimized applications that seek to interface with them. The solution described below seeks to standardize NBOs in a way that is: + +1. **Unopinionated** to support the legal frameworks of all jurisdictions and blockchain applications. +2. **Flexible** to support a diverse set of asset classes and representations, including tangible assets (real estate, commodities) and intangible assets (tokenized equities, climate assets, intellectual property) +3. **Composable** to ensure minimal overhead in composing across new applications and existing standards like Metaplex and Token-2022. + +To accomplish the above, we propose developing a modular framework that standardizes assets across the following primitives: + +1. **Asset Management:** A program for asset issuers to create and enforce rules for asset management, such as transfer controls and privacy. This program will rely heavily on Token-2022. +2. **Policy Engine Program:** A program that allows for fully on-chain management of policies regarding token transfers including transaction size, count, and velocity. +3. **Identity Registry:** A program for asset issuers to manage and share wallet-to-identity relationships used by the Asset Management program. +4. **Asset Data Registry:**  A program for asset issuers to establish and manage naive asset data in the form of ownership data (titles, deeds, or audits), legal information (filings and liens), and informational data. + +These programs limit the assumed necessary functionality to the support of permissioning, identity, on-chain ownership information, on-chain legal information, and off-chain asset information. This ensures that applications will benefit from a shared source of truth while maintaining optionality to create asset class-specific standards within any particular program (e.g. a Legal Registry standard specific to a Regulation D security). + +## Getting Started + +This program is currently in development and not for active use. If you wish to contribute, please reach out to team [at] bridgesplit [dot] com.