This CLI tool in the 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.
To install the binary, simply download the binary from the CLI release page for your OS.
We are aware that the size of the binaries must be reduced and we have tracked the issue in Github. We hope to find a solution in a near future and any help is welcomed.
Alternatively for Linux or MacOS users, if you have npm installed on your machine, you may install the cli using the following command:
npm install -g @tradetrust-tt/tradetrust-cliThe 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:
npx -p @tradetrust-tt/tradetrust-cli tradetrust <arguments>In all the guides, we will refer to the CLI as
tradetrustwhen 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 changetradetrustby the full path to the executable.
A configuration folder will be created in the
~/.config/tradetrust/
| 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 |
| Hedera Mainnet | hederamainnet | 295 | Hedera | Mainnet |
| Hedera Testnet | hederatestnet | 296 | Hedera | Testnet |
| Stability | stability | 101010 | Stability | Mainnet |
| Stability Testnet | stabilitytestnet | 20180427 | Stability | Testnet |
| Astron | Astron | 1338 | Astron | Mainnet |
Note: Network Name is the name used in the CLI --network options
For information on how network fees work, please refer to the ethereum documentation: https://ethereum.org/en/developers/docs/gas/
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 |
To display an estimated price of a transaction use the option of dry-run on your command.
Example:
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| Private Key | Wallet | Aws Kms | |
|---|---|---|---|
| Create config | ❎ | ✔️ | ❎ |
| Deploy document store | ✔ | ✔ | ✔ |
| Deploy token registry | ✔ | ✔ | ✔ |
| Dns txt create | ❎ | ❎ | ❎ |
| Dns txt get | ❎ | ❎ | ❎ |
| Document store issue | ✔ | ✔ | ✔ |
| Document store revoke | ✔ | ✔ | ✔ |
| Document store grant ownership | ✔ | ✔ | ✔ |
| Document store revoke ownership | ✔ | ✔ | ✔ |
| Document store transfer ownership | ✔ | ✔ | ✔ |
| Token registry issue | ✔ | ✔ | ✔ |
| Token registry mint | ✔ | ✔ | ✔ |
| Transaction cancel | ✔ | ✔ | ✔ |
| Wallet create | ❎ | ❎ | ❎ |
| Wallet decrypt | ❎ | ❎ | ❎ |
| Wallet encrypt | ✔ | ❎ | ❎ |
| Filter (obfuscate) document | ❎ | ❎ | ❎ |
| Sign document | ✔ | ❎ | ❎ |
| Encrypt document | ❎ | ❎ | ❎ |
| Decrypt document | ❎ | ❎ | ❎ |
| Wrap document | ❎ | ❎ | ❎ |
| Unwrap document | ❎ | ❎ | ❎ |
| Verify document | ❎ | ❎ | ❎ |
| Change holder (Title Escrow) | ✔ | ✔ | ✔ |
| Nominate change of owner (Title Escrow) | ✔ | ✔ | ✔ |
| Endorse transfer to owner (Title Escrow) | ✔ | ✔ | ✔ |
| Endorse change of owner (Title Escrow) | ✔ | ✔ | ✔ |
| Surrender document (Title Escrow) | ✔ | ✔ | ✔ |
| Reject surrendered document (Title Escrow) | ✔ | ✔ | ✔ |
| Accept surrendered document (Title Escrow) | ✔ | ✔ | ✔ |
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:
tradetrust wrap ./examples/raw-documents/example.0.json
✔ success Batch Document Root: 0xf51030c5751a646284c898cff0f9d833c64a50d6f307b61f2c96c3c838b13bfcThe command will display the result in the console. If you need to save the file you can use the --output-file file.
Example:
tradetrust wrap ./examples/raw-documents/example.0.json --output-file ./examples/wrapped-documents/example.0.json
✔ success Batch Document Root: 0x5d318c8083aac18f8075ca2a2eac74b06f2cc37d6ccad680c7c80c9bb36f7be1If 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:
tradetrust wrap ./examples/raw-documents --output-dir ./examples/wrapped-documents
✔ success Batch Document Root: 0x5d318c8083aac18f8075ca2a2eac74b06f2cc37d6ccad680c7c80c9bb36f7be1You can also provide an optional JSON schema document to perform extra check on the documents
Example:
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: 0xf51030c5751a646284c898cff0f9d833c64a50d6f307b61f2c96c3c838b13bfcThe JSON schema parameter also allow for http endpoint returning valid JSON schema:
Example:
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: 0xf51030c5751a646284c898cff0f9d833c64a50d6f307b61f2c96c3c838b13bfcYou can also re-wrap a document by editing a wrapped document content and using the --unwrap option:
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 --unwrapYou can disable the --batched option to wrap multiple documents individually (i.e. they will not have the same merkle root):
tradetrust wrap ./examples/raw-documents/ --output-dir ./examples/wrapped-documents/ --batched false
✔ success All documents have been individually wrappedBy default the CLI will use open-attestation schema v2 but you can opt in for open-attestation schema v3 using open-attestation-v3 option:
tradetrust wrap ./examples/raw-documents/ ./examples/wrapped-documents/ --open-attestation-v3
tradetrust wrap ./examples/raw-documents/ ./examples/wrapped-documents/ --oav3NOTE: 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.
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:
tradetrust unwrap ./examples/v2/wrapped-documents/example.0.json
✔ success The document has been unwrappedThe command will display the result in the console. If you need to save the file you can use the --output-file option.
Example:
tradetrust unwrap ./examples/v2/wrapped-documents/example.0.json --output-file ./examples/v2/raw-documents/example.0.json
✔ success The document has been unwrappedIf 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:
tradetrust unwrap ./examples/v2/wrapped-documents --output-dir ./examples/v2/raw-documents
✔ success The documents have been individually unwrapped into folder ./examples/v2/raw-documentsThis allows document holders to generate valid documents which obfuscates certain fields. For example, sensitive information that you wish not to disclose.
tradetrust filter <inputDocumentPath> <outputDocumentPath> [filters...]Example:
tradetrust filter examples/wrapped-documents/example.0.json tmp/example.0.out.json key1
✔ success Obfuscated document saved to: tmp/example.0.out.jsonThis allows you to encrypt document in order to share and store them safely.
tradetrust encrypt <inputDocumentPath> <outputEncryptedPath>Example:
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: 9bac5be27bac31d852fc1e48eb9d5249ec6ad7978da23377b5879f7a24994cb2This allows you to decrypt document encrypted using the method above.
tradetrust decrypt <input> <output> <key>Example:
tradetrust decrypt ./src/__tests__/fixture/did-dns-encrypted.json decrypted.json 88da9b9cd61cfc1677ae7e79dba9b3aeba4b40c95f94c950759e76c6210b5402
✔ success Decrypted document saved to: decrypted.jsonDeploys 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 deployment.
tradetrust deploy token-registry <registry-name> <registry-symbol> --factory-address <factory-address> [options]Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
tradetrust deploy token-registry "My Sample Token" MST --network sepolia
✔ success Token registry deployed at 0x4B127b8d5e53872d403ce43414afeb1db67B1842Mint 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.
tradetrust token-registry mint --network <NETWORK> --address <TOKEN_REGISTRY_ADDRESS> --tokenId <TOKEN_ID> --beneficiary <BENEFICIARY> --holder <HOLDER> [options]Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
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 0xB26B4941941C51a4885E5B7D3A1B861E54405f90mint can be used instead of issue and will be strictly equivalent.
Interfaces for the Assignment and Revocation of roles are available on the Token Registry repository.
Deploys a document store contract on the blockchain
tradetrust deploy document-store <store-name> [options]Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
tradetrust deploy document-store "My Name" --network sepolia
✔ success Document store deployed at 0x4B127b8d5e53872d403ce43414afeb1db67B1842By default, the owner of the document store will be the deployer. You can specify a different owner using the --owner option:
tradetrust deploy document-store "My Name" --owner 0x1234 --network sepoliaIssue a hash to a document store deployed on the blockchain
tradetrust document-store issue --address <DOCUMENT_STORE_ADDRESS> --hash <HASH> [options]Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
tradetrust document-store issue --network sepolia --address 0x19f89607b52268D0A19543e48F790c65750869c6 --hash 0x43033b53a462036304f526aeaf3aaeea8d905997d6fde3bb1a02188eadbaaec1
✔ success Document/Document Batch with hash 0x0c1a666aa55d17d26412bb57fbed96f40ec5a08e2f995a108faf45429ae3511f has been issued on 0x19f89607b52268D0A19543e48F790c65750869c6Revoke a hash to a document store deployed on the blockchain
tradetrust document-store revoke --address <DOCUMENT_STORE_ADDRESS> --hash <HASH> [options]Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
tradetrust document-store revoke --network sepolia --address 0x19f89607b52268D0A19543e48F790c65750869c6 --hash 0x43033b53a462036304f526aeaf3aaeea8d905997d6fde3bb1a02188eadbaaec1
✔ success Document/Document Batch with hash 0x0c1a666aa55d17d26412bb57fbed96f40ec5a08e2f995a108faf45429ae3511f has been revoked on 0x19f89607b52268D0A19543e48F790c65750869c6Grant role on document store deployed on the blockchain to a wallet
tradetrust document-store grant-role --address <DOCUMENT_STORE_ADDRESS> --account <ACCOUNT_ADDRESS> --role <ROLE> [options]Roles options: "admin", "issuer", "revoker"
Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
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 0xf81ea9d2c0133de728d28b8d7f186bed61079997Revoke role on document store deployed on the blockchain to a wallet
Roles options: "admin", "issuer", "revoker"
tradetrust document-store revoke-role --address <DOCUMENT_STORE_ADDRESS> --account <ACCOUNT_ADDRESS> --role <ROLE> [options]Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
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 0xf81ea9d2c0133de728d28b8d7f186bed61079997Transfer ownership of a document store deployed on the blockchain to another wallet
tradetrust document-store transfer-ownership --address <DOCUMENT_STORE_ADDRESS> --new-owner <HASH> [options]Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
tradetrust document-store transfer-ownership --address 0x80732bF5CA47A85e599f3ac9572F602c249C8A28 --new-owner 0xf81ea9d2c0133de728d28b8d7f186bed61079997 --network sepolia
✔ success Ownership of document store 0x80732bF5CA47A85e599f3ac9572F602c249C8A28 has been transferred to new wallet 0xf81ea9d2c0133de728d28b8d7f186bed61079997Verify if a document is valid.
tradetrust verify --document ./examples/wrapped-documents/example.0.json --network sepolia
… awaiting Verifying examples/wrapped-documents/example.0.json
✔ success The document is validSign on an OA document directly with a private key.
tradetrust sign ./examples/unsigned-documents -f ./examples/sample-key -p did:ethr:0x6813Eb9362372EEF6200f3b1dbC3f819671cBA69#controller --output-dir ./examples/signed-documentsCreate a temporary DNS TXT record in OpenAttestation sandbox
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
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
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 │
└─────────┴────────────┴────────────┴───────┴──────────────────────────────────────────────┴────────┘Creating a wallet
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/tmpEncrypting a wallet (see below to find out how to provide the key)
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
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 ....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:
- Using
encrypted-wallet-pathoption where you provide a path to an encrypted wallet (recommended). - Using
OA_PRIVATE_KEYenvironment variable holding the private key. - Using
--key-fileoption where you provide a path to a file containing the private key. - Using
--keyoption 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:
# 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 0000000000000000000000000000000000000000000000000000000000000003This 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-diroption specify which folder the config file will be created in. -
--encrypted-wallet-pathoption indicates a path to an encrypted wallet.
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.
These are the reference config templates:
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 </path/to>/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
Step 1: Generate a wallet.json file & add funds into wallet.json
This step is the same as Method 1.
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 </path/to>/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 </path/to>/config.json
? Select Network sepolia
This command will cancel pending transaction.
Please note that a this action is irreversible.
You will need:
-
--nonceoption specify which transaction to cancel. -
--gas-priceoption, the gas price is required to be higher than the pending transaction. -
--transaction-hashtransaction 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 <pending transaction nonce> --gas-price <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
This command will allow the owner of a transferable record to change its holder.
tradetrust title-escrow change-holder --token-registry <TOKEN_REGISTRY_ADDRESS> --tokenId <TOKEN_ID> --newHolder <NEW_HOLDER> [options]Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
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: 0xB26B4941941C51a4885E5B7D3A1B861E54405f90This 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.
tradetrust title-escrow nominate-change-owner --token-registry <TOKEN_REGISTRY_ADDRESS> --tokenId <TOKEN_ID> --newOwner <NEW_OWNER_ADDRESS> [options]Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
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: 0xB26B4941941C51a4885E5B7D3A1B861E54405f90This 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.
tradetrust title-escrow endorse-transfer-owner --token-registry <TOKEN_REGISTRY_ADDRESS> --tokenId <TOKEN_ID> --newBeneficiary <NEW_OWNER> [options]Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
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 0x2f60375e8144e16Adf1979936301D8341D58C36CThis 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.
tradetrust title-escrow endorse-change-owner --token-registry <TOKEN_REGISTRY_ADDRESS> --tokenId <TOKEN_ID> --newOwner <NEW_OWNER_ADDRESS> --newHolder <NEW_HOLDER_ADDRESS> [options]Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
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: 0xB26B4941941C51a4885E5B7D3A1B861E54405f90This command will allow the entity (who is both an owner and holder) to surrender it's transferable record to the token registry.
tradetrust title-escrow surrender --token-registry <TOKEN_REGISTRY_ADDRESS> --tokenId <TOKEN_ID> [options]Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
tradetrust title-escrow reject-surrendered --token-registry 0x4933e30eF8A083f49d14759b2eafC94E56F0b3A7 --tokenId 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 --network sepolia
✔ success Transferable record with hash 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 has been surrendered.This command will allow the token registry to reject a surrendered transferable record.
tradetrust title-escrow reject-surrendered --token-registry <TOKEN_REGISTRY_ADDRESS> --tokenId <TOKEN_ID> [options]Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
tradetrust title-escrow reject-surrendered --token-registry 0x4933e30eF8A083f49d14759b2eafC94E56F0b3A7 --tokenId 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 --network sepolia
✔ success Surrendered transferable record with hash 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 has been rejected.This command will allow the token registry to accept a surrendered transferable record.
tradetrust title-escrow accept-surrendered --token-registry <TOKEN_REGISTRY_ADDRESS> --tokenId <TOKEN_ID> [options]Example - with private key set in OA_PRIVATE_KEY environment variable (recommended). More options.
tradetrust title-escrow accept-surrendered --token-registry 0x4933e30eF8A083f49d14759b2eafC94E56F0b3A7 --tokenId 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 --network sepolia
✔ success Surrendered transferable record with hash 0x951b39bcaddc0e8882883db48ca258ca35ccb01fee328355f0dfda1ff9be9990 has been accepted.
Run the command with --help to get additional information
tradetrust deploy
tradetrust document-store
tradetrust encrypt
tradetrust filter
tradetrust verify
tradetrust wrap
tradetrust sign
To run on local
npm run dev -- <command> <options>
To run tests
npm run test
To run performance testing for TradeTrust functionality
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