# DEPRECATED 🚨 [![Unmaintained](https://img.shields.io/badge/status-unmaintained-red)](https://shields.io/) > This repository has been **deprecated** and is no longer maintained. > > Please use **[@trustvc/trustvc-cli](https://www.npmjs.com/package/@trustvc/trustvc-cli)** instead. > > The new CLI provides the same functionality with ongoing support and updates. # TradeTrust (CLI) > ⚠️ This CLI is for development work only. It is not recommended for production use. > For production, please integrate the TrustVC library. This CLI tool in the [TradeTrust CLI](https://github.com/TradeTrust/tradetrust-cli) repository turns .json documents into any TradeTrust verifiable documents. It applies the OpenAttestation algorithm to produce a hash of the json document and then creates a file with the data and proof of integrity. ## Installation ### Binary To install the binary, simply download the binary from the [CLI release page](https://github.com/TradeTrust/tradetrust-cli/releases) for your OS. > We are aware that the size of the binaries must be reduced and we have tracked the issue in [Github](https://github.com/Open-Attestation/open-attestation-cli/issues/68). We hope to find a solution in a near future and any help is welcomed. ### NPM Alternatively for Linux or MacOS users, if you have `npm` installed on your machine, you may install the cli using the following command: ```bash npm install -g @tradetrust-tt/tradetrust-cli ``` The above command will install the TradeTrust CLI to your machine. You will need to have node.js installed to be able to run the command. You can also opt to use npx: ```bash npx -p @tradetrust-tt/tradetrust-cli tradetrust ``` > In all the guides, we will refer to the CLI as `tradetrust` when running a command. That means we will assume the CLI is available in your execution path. If it's not the case, you will to change `tradetrust` by the full path to the executable. > A configuration folder will be created in the `~/.config/tradetrust/` --- ## Supported networks | Network | Network Name | Chain ID | BlockChain | Network Type | | ----------------- | ---------------- | -------- | ----------- | ------------ | | Local | local | 1337 | Local | Local | | Ethereum Mainnet | mainnet | 1 | Ethereum | Mainnet | | Sepolia | sepolia | 11155111 | Ethereum | Testnet | | Polygon Mainnet | matic | 137 | Polygon | Mainnet | | Amoy | amoy | 80002 | Polygon | Testnet | | XDC Network | xdc | 50 | XDC Network | Mainnet | | Apothem | xdcapothem | 51 | XDC Network | Testnet | | Stability | stability | 101010 | Stability | Mainnet | | Stability Testnet | stabilitytestnet | 20180427 | Stability | Testnet | | Astron | Astron | 1338 | Astron | Mainnet | | Astron Testnet | Astrontestnet | 21002 | Astron | Testnet | _Note: Network Name is the name used in the CLI --network options_ --- ## Usage ### Network Fees For information on how network fees work, please refer to the ethereum documentation: [https://ethereum.org/en/developers/docs/gas/](https://ethereum.org/en/developers/docs/gas/) #### Adjusting preset gas price To adjust transaction gas price, use the variable of `priority` to scale against the market price. Calculation: priority \* previous block priority fee Example: | Priority | Previous block priority fee | Priority Fee to use | | -------- | --------------------------- | ------------------- | | 1 | 1 | 1 \* 1 = 1 | | 1.2 | 1 | 1.2 \* 1 = 1.2 | | 2 | 1 | 2 \* 1 = 2 | | 1 | 10 | 1 \* 10 = 10 | | 1.2 | 10 | 1.2 \* 10 = 12 | | 2 | 10 | 2 \* 10 = 20 | #### Fee Information To display an estimated price of a transaction use the option of `dry-run` on your command. Example: ```bash tradetrust deploy document-store "My Name" --network sepolia --dry-run /!\ Welcome to the fee table. Please read the information below to understand the transaction fee The table below display information about the cost of the transaction on the mainnet network, depending on the gas price selected. Multiple modes are displayed to help you better help you to choose a gas price depending on your needs: Information about the network: Costs based on block number: 4275264 ┌─────────┬──────────────┬──────────────────┬─────────────────────────────────┬────────────────────────┐ │ (index) │ block number │ gas price (gwei) │ max priority fee per gas (gwei) │ max fee per gas (gwei) │ ├─────────┼──────────────┼──────────────────┼─────────────────────────────────┼────────────────────────┤ │ current │ 4275264 │ '0.629067134' │ '2.5' │ '3.758131382' │ └─────────┴──────────────┴──────────────────┴─────────────────────────────────┴────────────────────────┘ Information about the transaction: Estimated gas required: 869810 gas, which will cost approximately US$0.86837 based on prevailing gas price. ┌──────────┬───────────────────────┬────────────────────┬───────────────────────┐ │ (index) │ gas cost │ priority fee price │ max fee price │ ├──────────┼───────────────────────┼────────────────────┼───────────────────────┤ │ GWEI │ '547168.88382454' │ '2174525.0' │ '3268860.25737742' │ │ ETH │ '0.00054716888382454' │ '0.002174525' │ '0.00326886025737742' │ │ ETHUSD │ 0.86837 │ 3.45105 │ 5.18781 │ │ ETHSGD │ 1.18247 │ 4.69931 │ 7.06426 │ │ MATICUSD │ 0.00027 │ 0.00109 │ 0.00165 │ │ MATICSGD │ 0.00037 │ 0.00149 │ 0.00225 │ └──────────┴───────────────────────┴────────────────────┴───────────────────────┘ Please read the information above to understand the table ``` #### List of features with the required options | | Private Key | Wallet | Aws Kms | | -------------------------------------------------------------------------- | ----------- | ------ | ------- | | [Create config](#config-create-configuration-file) | ❎ | ✔️ | ❎ | | [Deploy document store](#deploy-new-document-store) | ✔ | ✔ | ✔ | | [Deploy token registry](#deploy-new-token-registry) | ✔ | ✔ | ✔ | | [Dns txt create](#dns-txt-record) | ❎ | ❎ | ❎ | | [Dns txt get](#dns-txt-record) | ❎ | ❎ | ❎ | | [Document store issue](#issue-document-to-document-store) | ✔ | ✔ | ✔ | | [Document store revoke](#revoke-document-in-document-store) | ✔ | ✔ | ✔ | | [Document store grant ownership](#grant-role-on-document-store) | ✔ | ✔ | ✔ | | [Document store revoke ownership](#revoke-role-on-document-store) | ✔ | ✔ | ✔ | | [Document store transfer ownership](#transfer-ownership-of-document-store) | ✔ | ✔ | ✔ | | [Token registry issue](#issue-document-to-token-registry) | ✔ | ✔ | ✔ | | [Token registry mint](#issue-document-to-token-registry) | ✔ | ✔ | ✔ | | [Transaction cancel](#cancel-pending-transaction) | ✔ | ✔ | ✔ | | [Wallet create](#wallet) | ❎ | ❎ | ❎ | | [Wallet decrypt](#wallet) | ❎ | ❎ | ❎ | | [Wallet encrypt](#wallet) | ✔ | ❎ | ❎ | | [Filter (obfuscate) document](#document-privacy-filter) | ❎ | ❎ | ❎ | | [Sign document](#did-direct-signing) | ✔ | ❎ | ❎ | | [Encrypt document](#encrypting-document) | ❎ | ❎ | ❎ | | [Decrypt document](#decrypting-document) | ❎ | ❎ | ❎ | | [Wrap document](#wrapping-documents) | ❎ | ❎ | ❎ | | [Unwrap document](#unwrapping-documents) | ❎ | ❎ | ❎ | | [Verify document](#verify) | ❎ | ❎ | ❎ | | [Change holder (Title Escrow)](#change-holder) | ✔ | ✔ | ✔ | | [Nominate change of owner (Title Escrow)](#nominate-change-of-owner) | ✔ | ✔ | ✔ | | [Endorse transfer to owner (Title Escrow)](#endorse-transfer-of-owner) | ✔ | ✔ | ✔ | | [Endorse change of owner (Title Escrow)](#endorse-change-of-owner) | ✔ | ✔ | ✔ | | [Reject change of owner (Title Escrow)](#reject-change-of-owner) | ✔ | ✔ | ✔ | | [Reject change of holder (Title Escrow)](#reject-change-of-holder) | ✔ | ✔ | ✔ | | [Reject change of owners (Title Escrow)](#reject-change-of-owners) | ✔ | ✔ | ✔ | | [Return document to issuer (Title Escrow)](#return-document-to-issuer) | ✔ | ✔ | ✔ | | [Reject return of document (Title Escrow)](#reject-returned-document) | ✔ | ✔ | ✔ | | [Accept return of document (Title Escrow)](#accept-returned-document) | ✔ | ✔ | ✔ | ### Wrapping documents This command process all documents in the input directory. It will add the issuance proofs to the individual documents. Additionally, you'll get the Batch Document Root (merkleRoot) value. Thereafter, you can issue all the documents in a single batch with the merkleRoot later. Example: ```bash tradetrust wrap ./examples/raw-documents/example.0.json ✔ success Batch Document Root: 0xf51030c5751a646284c898cff0f9d833c64a50d6f307b61f2c96c3c838b13bfc ``` The command will display the result in the console. If you need to save the file you can use the `--output-file` file. Example: ```bash tradetrust wrap ./examples/raw-documents/example.0.json --output-file ./examples/wrapped-documents/example.0.json ✔ success Batch Document Root: 0x5d318c8083aac18f8075ca2a2eac74b06f2cc37d6ccad680c7c80c9bb36f7be1 ``` If you need to wrap a folder you will need to provide the `--output-dir` options to specify in which folder the documents must be wrapped in. Example: ```bash tradetrust wrap ./examples/raw-documents --output-dir ./examples/wrapped-documents ✔ success Batch Document Root: 0x5d318c8083aac18f8075ca2a2eac74b06f2cc37d6ccad680c7c80c9bb36f7be1 ``` You can also provide an optional JSON schema document to perform extra check on the documents Example: ```bash tradetrust wrap ./examples/raw-documents/ --output-dir ./examples/wrapped-documents/ --schema ./examples/schema.json ✔ success Batch Document Root: 0xf51030c5751a646284c898cff0f9d833c64a50d6f307b61f2c96c3c838b13bfc tradetrust wrap ./examples/raw-documents/ ./examples/wrapped-documents/ -s ./examples/schema.json ✔ success Batch Document Root: 0xf51030c5751a646284c898cff0f9d833c64a50d6f307b61f2c96c3c838b13bfc ``` The JSON schema parameter also allow for http endpoint returning valid JSON schema: Example: ```bash tradetrust wrap ./examples/raw-documents/ --output-dir ./examples/wrapped-documents/ --schema https://gist.githubusercontent.com/Nebulis/dd8198ab76443489e14121dad225d351/raw/693b50a1694942fb3cc6a8dcf5187cc7c75adb58/schema.json ✔ success Batch Document Root: 0xf51030c5751a646284c898cff0f9d833c64a50d6f307b61f2c96c3c838b13bfc tradetrust wrap ./examples/raw-documents/ --output-dir ./examples/wrapped-documents/ -s https://gist.githubusercontent.com/Nebulis/dd8198ab76443489e14121dad225d351/raw/693b50a1694942fb3cc6a8dcf5187cc7c75adb58/schema.json ✔ success Batch Document Root: 0xf51030c5751a646284c898cff0f9d833c64a50d6f307b61f2c96c3c838b13bfc ``` You can also re-wrap a document by editing a wrapped document content and using the `--unwrap` option: ```bash tradetrust wrap ./examples/raw-documents/example.0.json --output-file ./examples/wrapped-documents/example.0.json # edit the recipient name in ./tmp/wrapped-documents/example.0.json for instance for Your Name to Another Name tradetrust wrap ./examples/wrapped-documents/example.0.json --of ./examples/wrapped-documents/example.1.json --unwrap ``` You can disable the `--batched` option to wrap multiple documents individually (i.e. they will not have the same merkle root): ```bash tradetrust wrap ./examples/raw-documents/ --output-dir ./examples/wrapped-documents/ --batched false ✔ success All documents have been individually wrapped ``` By default the CLI will use open-attestation schema v2 but you can opt in for open-attestation schema v3 using `open-attestation-v3` option: ```bash tradetrust wrap ./examples/raw-documents/ ./examples/wrapped-documents/ --open-attestation-v3 tradetrust wrap ./examples/raw-documents/ ./examples/wrapped-documents/ --oav3 ``` > **_NOTE:_** For transferable records, you should wrap them individually as each of them would be minted to a unique title escrow that represents the beneficiary and holder entities of the document. For more information about title escrow, refer [here](https://docs.tradetrust.io/docs/topics/introduction/transferable-records/overview). ### Unwrapping documents This command processes a document in the input directory. It will unwrap the wrapped document to its raw document form to be displayed on the console. Example: ```bash tradetrust unwrap ./examples/v2/wrapped-documents/example.0.json ✔ success The document has been unwrapped ``` The command will display the result in the console. If you need to save the file you can use the `--output-file` option. Example: ```bash tradetrust unwrap ./examples/v2/wrapped-documents/example.0.json --output-file ./examples/v2/raw-documents/example.0.json ✔ success The document has been unwrapped ``` If you need to unwrap a folder you will need to provide the `--output-dir` option to specify which folder the documents must be unwrapped in. Example: ```bash tradetrust unwrap ./examples/v2/wrapped-documents --output-dir ./examples/v2/raw-documents ✔ success The documents have been individually unwrapped into folder ./examples/v2/raw-documents ``` ### Document privacy filter This allows document holders to generate valid documents which obfuscates certain fields. For example, sensitive information that you wish not to disclose. ```bash tradetrust filter [filters...] ``` Example: ```bash tradetrust filter examples/wrapped-documents/example.0.json tmp/example.0.out.json key1 ✔ success Obfuscated document saved to: tmp/example.0.out.json ``` ### Encrypting document This allows you to encrypt document in order to share and store them safely. ```bash tradetrust encrypt ``` Example: ```bash tradetrust encrypt ./examples/wrapped-documents/example.0.json ./tmp/encrypted.json ✔ success Encrypted document saved to: tmp/encrypted.json ⚠ warning Here is the key to decrypt the document: don't lose it: 9bac5be27bac31d852fc1e48eb9d5249ec6ad7978da23377b5879f7a24994cb2 ``` ### Decrypting document This allows you to decrypt document encrypted using the method above. ```bash tradetrust decrypt ``` Example: ```bash tradetrust decrypt ./src/__tests__/fixture/did-dns-encrypted.json decrypted.json 88da9b9cd61cfc1677ae7e79dba9b3aeba4b40c95f94c950759e76c6210b5402 ✔ success Decrypted document saved to: decrypted.json ``` ### Token Registry #### Deploy new Token Registry Deploys a token registry contract on the blockchain. Factory Contract that have been deployed using token-registry can be used with the factory address flag. To deploy a standalone token registry, please refer to [Token-Registry](https://github.com/TradeTrust/token-registry) deployment. ```bash tradetrust deploy token-registry

--factory-address [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust deploy token-registry "My Sample Token" MST --network sepolia ✔ success Token registry deployed at 0x4B127b8d5e53872d403ce43414afeb1db67B1842 ``` #### Mint document to token registry `Mint` a hash to a token registry deployed on the blockchain. The `tokenId` option would be used to indicate the document hash, and the `to` option to indicate the title escrow address the document is mapped to. ```bash tradetrust token-registry mint --network --address --tokenId --beneficiary --holder [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust token-registry mint --network sepolia --address 0x6133f580aE903b8e79845340375cCfd78a45FF35 --tokenId 0x10ee711d151bc2139473a57531f91d961b639affb876b350c31d031059cdcc2c --to 0xB26B4941941C51a4885E5B7D3A1B861E54405f90 ✔ success Token with hash 0x10ee711d151bc2139473a57531f91d961b639affb876b350c31d031059cdcc2c has been issued on 0x6133f580aE903b8e79845340375cCfd78a45FF35 with the initial recipient being 0xB26B4941941C51a4885E5B7D3A1B861E54405f90 ``` `mint` can be used instead of issue and will be strictly equivalent. #### Token Registry Roles Interfaces for the Assignment and Revocation of roles are available on the Token Registry repository. ### Document Store #### Deploy new document store Deploys a document store contract on the blockchain ```bash tradetrust deploy document-store [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust deploy document-store "My Name" --network sepolia ✔ success Document store deployed at 0x4B127b8d5e53872d403ce43414afeb1db67B1842 ``` By default, the owner of the document store will be the deployer. You can specify a different owner using the `--owner` option: ```bash tradetrust deploy document-store "My Name" --owner 0x1234 --network sepolia ``` #### Issue document to document store Issue a hash to a document store deployed on the blockchain ```bash tradetrust document-store issue --address --hash [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust document-store issue --network sepolia --address 0x19f89607b52268D0A19543e48F790c65750869c6 --hash 0x43033b53a462036304f526aeaf3aaeea8d905997d6fde3bb1a02188eadbaaec1 ✔ success Document/Document Batch with hash 0x0c1a666aa55d17d26412bb57fbed96f40ec5a08e2f995a108faf45429ae3511f has been issued on 0x19f89607b52268D0A19543e48F790c65750869c6 ``` #### Revoke document in document store Revoke a hash to a document store deployed on the blockchain ```bash tradetrust document-store revoke --address --hash [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust document-store revoke --network sepolia --address 0x19f89607b52268D0A19543e48F790c65750869c6 --hash 0x43033b53a462036304f526aeaf3aaeea8d905997d6fde3bb1a02188eadbaaec1 ✔ success Document/Document Batch with hash 0x0c1a666aa55d17d26412bb57fbed96f40ec5a08e2f995a108faf45429ae3511f has been revoked on 0x19f89607b52268D0A19543e48F790c65750869c6 ``` #### Grant role on document store Grant role on document store deployed on the blockchain to a wallet ```bash tradetrust document-store grant-role --address --account --role [options] ``` Roles options: "admin", "issuer", "revoker" Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust document-store grant-role --address 0x80732bF5CA47A85e599f3ac9572F602c249C8A28 --new-owner 0xf81ea9d2c0133de728d28b8d7f186bed61079997 --role admin --network sepolia ✔ success Document store 0x80732bF5CA47A85e599f3ac9572F602c249C8A28's role of: admin has been granted to wallet 0xf81ea9d2c0133de728d28b8d7f186bed61079997 ``` #### Revoke role on document store Revoke role on document store deployed on the blockchain to a wallet Roles options: "admin", "issuer", "revoker" ```bash tradetrust document-store revoke-role --address --account --role [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust document-store revoke-role --address 0x80732bF5CA47A85e599f3ac9572F602c249C8A28 --new-owner 0xf81ea9d2c0133de728d28b8d7f186bed61079997 --role admin --network sepolia ✔ success Document store 0x80732bF5CA47A85e599f3ac9572F602c249C8A28's role of: admin has been revoked from wallet 0xf81ea9d2c0133de728d28b8d7f186bed61079997 ``` #### Transfer ownership of document store Transfer ownership of a document store deployed on the blockchain to another wallet ```bash tradetrust document-store transfer-ownership --address --new-owner [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust document-store transfer-ownership --address 0x80732bF5CA47A85e599f3ac9572F602c249C8A28 --new-owner 0xf81ea9d2c0133de728d28b8d7f186bed61079997 --network sepolia ✔ success Ownership of document store 0x80732bF5CA47A85e599f3ac9572F602c249C8A28 has been transferred to new wallet 0xf81ea9d2c0133de728d28b8d7f186bed61079997 ``` ### Verify Verify if a document is valid. ```bash tradetrust verify --document ./examples/wrapped-documents/example.0.json --network sepolia … awaiting Verifying examples/wrapped-documents/example.0.json ✔ success The document is valid ``` ### DID Direct Signing Sign on an OA document directly with a private key. ```bash tradetrust sign ./examples/unsigned-documents -f ./examples/sample-key -p did:ethr:0x6813Eb9362372EEF6200f3b1dbC3f819671cBA69#controller --output-dir ./examples/signed-documents ``` ### DNS TXT Record Create a temporary DNS TXT record in OpenAttestation sandbox ```bash tradetrust dns txt-record create --address 0xf51030c5751a646284c898cff0f9d833c64a50d6f307b61f2c96c3c838b13bfc --networkId 10 ✔ success Record created at exotic-blush-primate.sandbox.fyntech.io and will stay valid until Thu Jul 02 2020 13:51:34 GMT+0800 (Singapore Standard Time) ``` Get the list of DNS TXT records associated to a domain ```bash tradetrust dns txt-record get --location resulting-magenta-locust.sandbox.fyntech.io ┌─────────┬────────────┬────────────┬───────┬──────────┬────────┐ │ (index) │ type │ net │ netId │ addr │ dnssec │ ├─────────┼────────────┼────────────┼───────┼──────────┼────────┤ │ 0 │ 'openatts' │ 'ethereum' │ '10' │ '0xabcd' │ false │ └─────────┴────────────┴────────────┴───────┴──────────┴────────┘ ``` Filter the list of DNS TXT records associated to a domain on a specific network ```bash tradetrust dns txt-record get --location example.openattestation.com --networkId 3 ┌─────────┬────────────┬────────────┬───────┬──────────────────────────────────────────────┬────────┐ │ (index) │ type │ net │ netId │ addr │ dnssec │ ├─────────┼────────────┼────────────┼───────┼──────────────────────────────────────────────┼────────┤ │ 0 │ 'openatts' │ 'ethereum' │ '3' │ '0x2f60375e8144e16Adf1979936301D8341D58C36C' │ false │ │ 1 │ 'openatts' │ 'ethereum' │ '3' │ '0x532C9Ff853CA54370D7492cD84040F9f8099f11B' │ false │ │ 2 │ 'openatts' │ 'ethereum' │ '3' │ '0x53f3a47C129Ea30D80bC727556b015F02bE63811' │ false │ │ 3 │ 'openatts' │ 'ethereum' │ '3' │ '0x8Fc57204c35fb9317D91285eF52D6b892EC08cD3' │ false │ │ 4 │ 'openatts' │ 'ethereum' │ '3' │ '0xdcA6Eea7024151c270b50FcA9E67161119B06BAD' │ false │ └─────────┴────────────┴────────────┴───────┴──────────────────────────────────────────────┴────────┘ ``` ### Wallet Creating a wallet ```bash tradetrust wallet create --of ./tmp ℹ info Creating a new wallet ? Wallet password [hidden] … awaiting Encrypting Wallet [====================] [100/100%] ℹ info Wallet with public address 0x6348a96D96D56665C2E9619f81355918779f3d9E successfully created. Find more details: ✔ success Wallet successfully saved into /path/to/tmp ``` Encrypting a wallet (see [below](#providing-the-wallet) to find out how to provide the key) ```bash tradetrust wallet encrypt --of ./tmp ℹ info Encrypting a wallet ? Wallet password [hidden] … awaiting Encrypting Wallet [====================] [100/100%] ℹ info Wallet with public address 0xB26B4941941C51a4885E5B7D3A1B861E54405f90 successfully created. Find more details: ✔ success Wallet successfully saved into /path/to/tmp ``` Decrypt a wallet to get information about it. Some information might be sensitive ```bash tradetrust wallet decrypt wallet.json ⚠ warning You are about to reveal the private key of your wallet. Please type the following word into the terminal to prove that you understand the risks: active-aqua-swordtail ? ack: active-aqua-swordtail ℹ info User consented to risks ? Wallet password [hidden] … awaiting Decrypting Wallet [====================] [100/100%] ℹ info Wallet successfully decrypted ✔ success Wallet information: - address: 0x19bf1b00f78f521999d9A4246818F362fcaA1A96 - public key: 0x04e1a6facd0fee89e44ae51c1352e32224e79caaa3ccf5afa9d77f10f92f7c4c584ccdf6cfb9a71584c18408a1a0e12341556757268117afebda00d6d6e71133bf - private key .... ``` ### Providing the wallet When interacting with blockchain you will likely need to provide a way to access your wallet. All functions - when the wallet is required - will provide multiples ways for you to pass it in: 1. Using `encrypted-wallet-path` option where you provide a path to an [encrypted wallet](https://docs.ethers.io/v5/api/signer/#Wallet-encrypt) (recommended). 1. Using `OA_PRIVATE_KEY` environment variable holding the private key. 1. Using `--key-file` option where you provide a path to a file containing the private key. 1. Using `--key` option where you provide the private key directly to the command (**Note that in this case, the private key may be stored in the machine's bash history**). Example: ```bash # Using encrypted-wallet-path option tradetrust deploy document-store "My Name" --network sepolia --encrypted-wallet-path /path/to/wallet.json # Then you will be prompted to type your password to decrypt the wallet ? Wallet password [input is hidden] # Using environment variable export OA_PRIVATE_KEY=0000000000000000000000000000000000000000000000000000000000000001 tradetrust deploy document-store "My Name" --network sepolia unset OA_PRIVATE_KEY # Using private key stored in file echo -n 0000000000000000000000000000000000000000000000000000000000000002 >> ./examples/sample-key tradetrust deploy document-store "My Name" --network sepolia --key-file ./examples/sample-key rm ./examples/sample-key # Providing the key to the command tradetrust deploy document-store "My Name" --network sepolia --key 0000000000000000000000000000000000000000000000000000000000000003 ``` ### Providing custom RPC URLs When interacting with the blockchain, you may want to connect to a different Ethereum provider than the default ones. All functions that interact with the blockchain support the `--rpc-url` option to specify a custom RPC endpoint: 1. Using `--rpc-url` option where you provide the URL of your custom Ethereum RPC provider. 2. When `--rpc-url` is provided, it takes precedence over the default network provider. 3. This is useful for connecting to private networks, custom providers, or alternative public endpoints. Example: ```bash # Using custom RPC URL with document store deployment tradetrust deploy document-store "My Name" --network sepolia --rpc-url https://custom-rpc.example.com # Using custom RPC URL with token registry operations tradetrust deploy token-registry "My Registry" --network sepolia --rpc-url https://my-provider.com # Using custom RPC URL with document store operations tradetrust document-store issue --address 0x1234... --hash 0xabcd... --network sepolia --rpc-url https://custom-endpoint.io ``` ### Providing the Remarks and Encryption Key Enables users to attach encrypted remarks (up to 120 characters) to blockchain transactions. The encrypted remarks are stored immutably on the blockchain and can be viewed in the endorsement chain. This ensures secure and meaningful metadata is recorded alongside transactions. 1. Using `remark` option where you provide a remark not more than 120 characters. 1. Using `encryptionKey` option where you provide token registry address as your encryption key. ```bash # Using remark tradetrust title-escrow reject-transfer-owner-holder --token-registry --tokenId --remark # Using encryption key tradetrust title-escrow reject-transfer-owner-holder --token-registry --tokenId --remark --encryptionKey ``` ### Config (Create configuration file) This command will generate a config file with sandbox DNS, document store and token registry. > Please note that a wallet.json file with sufficient **funds** in the specified network must be provided in order for this command to work. Command options to take note: - `--output-dir` option specify which folder the config file will be created in. - `--encrypted-wallet-path` option indicates a path to an [encrypted wallet](https://docs.ethers.io/v5/api/signer/#Wallet-encrypt). There are 2 ways of using this command to generate a config file, both in which, will return a new config file with sandbox DNS, updated document store and updated token registry. #### Method 1: Using config-template-url option (recommended) These are the reference config templates: - [v2 config template](https://raw.githubusercontent.com/TradeTrust/tradetrust-config/master/build/reference/config-v2.json) - [v3 config template](https://raw.githubusercontent.com/TradeTrust/tradetrust-config/master/build/reference/config-v3.json). Step 1: Generate a wallet.json file & add funds into wallet.json ``` // If you already have a wallet.json that has sufficient funds in the specific network, you can skip step 1. tradetrust wallet create --output-file wallet.json ``` Currently, we do not provide any faucet to dispense any funds into the wallet.json. You can search the web for some faucets. Step 2: Generate config file by passing in the generated wallet.json file and a config template url ``` tradetrust config create --output-dir ./example-configs --encrypted-wallet-path /wallet.json // Please fill in the necessary information when prompted. ℹ info Creating a new config file ? Wallet password [hidden] ? Using a config template URL? Yes ? Please enter the config template URL https://raw.githubusercontent.com/TradeTrust/tradetrust-config/master/build/reference/config-v2.json ? Select Network sepolia ``` #### Method 2: Using config-template-path option Step 1: Generate a wallet.json file & add funds into wallet.json This step is the same as [Method 1](#method-1-using-config-template-url-option-recommended). Step 2: Generate config file by passing in the generated wallet.json file and a existing config file ``` tradetrust config create --output-dir ./example-configs --encrypted-wallet-path /wallet.json // Please fill in the necessary information when prompted. ℹ info Creating a new config file ? Wallet password [hidden] ? Using a config template URL? No ? Please enter the config template path /config.json ? Select Network sepolia ``` ### Cancel pending transaction This command will cancel pending transaction. Please note that a this action is irreversible. You will need: - `--nonce` option specify which transaction to cancel. - `--gas-price` option, the gas price is required to be higher than the pending transaction. - `--transaction-hash` transaction hash option can be used as an alternative to nonce and gas-price option. Using this option will automatically increase the transaction gas price by 100%. - options to provide the wallet (https://github.com/TradeTrust/tradetrust-cli#providing-the-wallet) ``` tradetrust transaction cancel --nonce --gas-price [option] ``` Examples: ``` tradetrust transaction cancel --nonce 1 --gas-price 300 --network sepolia --encrypted-wallet-path /path/to/wallet ``` ``` tradetrust transaction cancel --transaction-hash 0x000 --network sepolia --encrypted-wallet-path /path/to/wallet ``` ### Title Escrow #### Change Holder This command will allow the owner of a transferable record to change its holder. ```bash tradetrust title-escrow change-holder --token-registry --tokenId --newHolder [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust title-escrow change-holder --token-registry 0x4933e30eF8A083f49d14759b2eafC94E56F0b3A7 --tokenId 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 --newHolder 0xB26B4941941C51a4885E5B7D3A1B861E54405f90 ✔ success Transferable record with hash 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990's holder has been successfully changed to holder with address: 0xB26B4941941C51a4885E5B7D3A1B861E54405f90 ``` #### Nominate Change of Owner This command will allow the owner of the transferable record to nominate a new owner of the transferable record. **This command will fail if you are not the owner of the transferable record.** ```bash tradetrust title-escrow nominate-change-owner --token-registry --tokenId --newOwner [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust title-escrow nominate-change-owner --token-registry 0x4933e30eF8A083f49d14759b2eafC94E56F0b3A7 --tokenId 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 --newOwner 0xB26B4941941C51a4885E5B7D3A1B861E54405f90 ✔ success Transferable record with hash 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990's holder has been successfully nominated to new owner with address: 0xB26B4941941C51a4885E5B7D3A1B861E54405f90 ``` #### Endorse Transfer of Owner This command will allow the holder of the transferable record to endorse the transfer to an approved owner and approved holder of the transferable record. **This command will fail if there is no approved owner or holder record on the transferable record.** ```bash tradetrust title-escrow endorse-transfer-owner --token-registry --tokenId --newBeneficiary [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust title-escrow endorse-transfer-owner --token-registry 0x4933e30eF8A083f49d14759b2eafC94E56F0b3A7 --tokenId 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 --newBeneficiary 0x2f60375e8144e16Adf1979936301D8341D58C36C ✔ success Transferable record with hash 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990's holder has been successfully endorsed to approved beneficiary at 0x2f60375e8144e16Adf1979936301D8341D58C36C ``` #### Endorse Change of Owner This command will allow the owner of the transferable record to endorse the change of owner to a new owner and new holder of the transferable record. **This command will fail if the provided holder and owner's addresses are the same as the current owner and current holder's addresses.** ```bash tradetrust title-escrow endorse-change-owner --token-registry --tokenId --newOwner --newHolder [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust title-escrow endorse-change-owner --token-registry 0x4933e30eF8A083f49d14759b2eafC94E56F0b3A7 --tokenId 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 --newOwner 0xB26B4941941C51a4885E5B7D3A1B861E54405f90 --newHolder 0x2f60375e8144e16Adf1979936301D8341D58C36C ✔ success Transferable record with hash 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990's holder has been successfully endorsed to new owner with address 0x2f60375e8144e16Adf1979936301D8341D58C36C and new holder with address: 0xB26B4941941C51a4885E5B7D3A1B861E54405f90 ``` #### Reject Change of Owner This command will allow the owner of the transferable record to reject the change of owner to previous owner. **This command will fail if the current owner has made any transactions.** ```bash tradetrust title-escrow reject-transfer-owner --token-registry --tokenId [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust title-escrow reject-transfer-owner --token-registry 0x4933e30eF8A083f49d14759b2eafC94E56F0b3A7 --tokenId 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 ✔ success Transferable record with hash 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990's owner has been successfully rejected to previous owner ``` #### Reject Change of Holder This command will allow the holder of the transferable record to reject the change of holder to previous holder. **This command will fail if the current holder has made any transactions.** ```bash tradetrust title-escrow reject-transfer-holder --token-registry --tokenId [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust title-escrow reject-transfer-holder --token-registry 0x4933e30eF8A083f49d14759b2eafC94E56F0b3A7 --tokenId 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 ✔ success Transferable record with hash 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990's holder has been successfully rejected to previous holder ``` #### Reject Change of Owners This command will allow the owner of the transferable record to reject the change of owner and holder to previous owner and holder. **This command will fail if the current owner has made any transactions.** ```bash tradetrust title-escrow reject-transfer-owner-holder --token-registry --tokenId [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust title-escrow reject-transfer-owner-holder --token-registry 0x4933e30eF8A083f49d14759b2eafC94E56F0b3A7 --tokenId 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 ✔ success Transferable record with hash 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990's owners has been successfully rejected to previous owner and holder ``` #### Return Document to Issuer This command will allow the entity (who is both an owner and holder) to return it's transferable record to the token registry. ```bash tradetrust title-escrow return-to-issuer --token-registry --tokenId [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust title-escrow return-to-issuer --token-registry 0x4933e30eF8A083f49d14759b2eafC94E56F0b3A7 --tokenId 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 --network sepolia ✔ success Transferable record with hash 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 has been returned to issuer. ``` #### Reject Returned Document This command will allow the token registry to reject a returned transferable record. ```bash tradetrust title-escrow reject-returned --token-registry --tokenId [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust title-escrow reject-returned --token-registry 0x4933e30eF8A083f49d14759b2eafC94E56F0b3A7 --tokenId 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 --network sepolia ✔ success Returned transferable record with hash 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 has been rejected. ``` #### Accept Returned Document This command will allow the token registry to accept a returned transferable record. ```bash tradetrust title-escrow accept-returned --token-registry --tokenId [options] ``` Example - with private key set in `OA_PRIVATE_KEY` environment variable (recommended). [More options](#providing-the-wallet). ```bash tradetrust title-escrow accept-returned --token-registry 0x4933e30eF8A083f49d14759b2eafC94E56F0b3A7 --tokenId 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 --network sepolia ✔ success Returned transferable record with hash 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 has been accepted. ``` ## Help Run the command with `--help` to get additional information ``` tradetrust deploy tradetrust document-store tradetrust encrypt tradetrust filter tradetrust verify tradetrust wrap tradetrust sign ``` ## Development To run on local ``` npm run dev -- ``` To run tests ``` npm run test ``` ## Performance testing To run performance testing for TradeTrust functionality ### Wrap Monitor the response time for batched documents wrapping. The Default command will testing: 2 documents without base64 image in 1 iteration. ``` npm run benchmark ``` The number of documents and iteration can be modified using these options. - First argument : Number of document for batched wrapping - Second argument : Number of performance test iteration to achieve higher accuracy - Third argument : File path for testing ( For window user, please encase the path in " " quotation marks ) Example: ``` npm run benchmark 4 1 performance-tests/unwrapped_document_wImage.json ```