Skip to content

fix: update with trustvc commands #243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RishabhS7 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: update with trustvc commands #243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 156 additions & 40 deletions docs/how-tos/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,89 @@ title: Deployment
sidebar_label: Deployment
---

### TDocDeployer

TDocDeployer is a **deployer** contract for transferable documents using minimal proxy clones. It allows the deployment of contract instances based on predefined implementations while associating each implementation with a **titleEscrowFactory**.

#### Key Features

- Cloning Mechanism: Uses OpenZeppelin’s Clones library for efficient contract deployment.
- Implementation Management: Allows the owner to register, update, and remove implementations.
- Deployment Control: Ensures only registered implementations can be deployed.
- Upgradeability: Supports UUPS proxy pattern for future upgrades.

#### deploy Function Explanation

The **deploy** function creates a new contract instance by cloning an existing implementation of **Token Registry**.

### Installing tradetrust-cli
### Installing TrustVC CLI

> **⚠️ DISCLAIMER**
>
> The TradeTrust CLI helps developers prototype and test how document issuance and verification work before integrating the TrustVC core into their own systems.
> The TrustVC CLI helps developers prototype and test how document issuance and verification work before integrating the TrustVC core into their own systems.
>
> It should not be used for production issuance or live document management, as it lacks security, scalability, and operational controls required for real-world environments.

#### Binary

To install the binary, simply download the binary from the [CLI release page](https://github.com/TradeTrust/tradetrust-cli/releases) for your OS.
To install the binary, simply download the binary from the [CLI release page](https://github.com/TrustVC/trustvc-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. 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:
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
npm install -g @trustvc/trustvc-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.
The above command will install the TrustVC 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 <arguments>
npx @trustvc/trustvc-cli <arguments>
```

## Document Store

The document store is a smart contract on the blockchain that records the issuance and revocation status of verifiable documents. You can deploy a document store contract using the TrustVC CLI.

### Deploying via CLI

```bash
trustvc deploy document-store
```

The CLI will interactively prompt you for:

1. **Store name**: Enter the name of the document store (e.g., "My First Document Store")
2. **Network selection**: Choose from available networks (e.g., sepolia, polygon-amoy)
3. **Owner address**: Enter the owner address (optional - uses deployer address if not provided)
4. **Wallet selection**: Choose between encrypted wallet, private key file, or environment variable

Example session:

```bash
trustvc deploy document-store

? Enter the name of the document store: My First Document Store
? Select a network: sepolia
? Enter the owner address (optional, press Enter to use deployer address):
? Select wallet type: Environment Variable (OA_PRIVATE_KEY)

ℹ info Deploying document store My First Document Store
✔ success Document store My First Document Store deployed at 0xBBb55Bd1D709955241CAaCb327A765e2b6D69c8b
ℹ info Find more details at https://sepolia.etherscan.io/tx/0x...
```

**Save the document store address.** You will need this address for issuing and revoking documents.

## TDocDeployer

TDocDeployer is a **deployer** contract for transferable documents using minimal proxy clones. It allows the deployment of contract instances based on predefined implementations while associating each implementation with a **titleEscrowFactory**.

### Key Features

- Cloning Mechanism: Uses OpenZeppelin's Clones library for efficient contract deployment.
- Implementation Management: Allows the owner to register, update, and remove implementations.
- Deployment Control: Ensures only registered implementations can be deployed.
- Upgradeability: Supports UUPS proxy pattern for future upgrades.

### deploy Function Explanation

The **deploy** function creates a new contract instance by cloning an existing implementation of **Token Registry**.

## TitleEscrowFactory

The **TitleEscrowFactory** contract is responsible for deploying and managing instances of **TitleEscrow** contracts. It follows a factory pattern that enables the deterministic creation of title escrow instances using the Clones library from OpenZeppelin. This approach ensures gas efficiency and allows for easy management of multiple title escrow contracts.
Expand All @@ -58,9 +96,14 @@ The Title Escrow Factory contract is already registered in our **TDocDeployer**
Here's how:

```bash
tradetrust deploy title-escrow-factory --network sepolia
trustvc deploy title-escrow-factory
```

The CLI will interactively prompt you for:

- **Network selection**: Choose from available networks (e.g., sepolia, polygon-amoy)
- **Wallet selection**: Choose between encrypted wallet, private key file, or environment variable

## Token Registry

You can deploy a Token Registry contract on the blockchain either as a standalone deployment or through a Factory Contract(tDocDeployer). If a Factory Contract has been deployed using the Token Registry, you can use the factory address flag to interact with it. Additionally, you have the flexibility to deploy the Token Registry using both the CLI and code, depending on your preferred approach.
Expand All @@ -69,23 +112,49 @@ You can deploy a Token Registry contract on the blockchain either as a standalon

#### 1) Deploying via CLI

Now we will see performing the deployment using tDocDeployer via the command line -
Now we will see performing the deployment using tDocDeployer via the command line.

- tDocDeployer can have multiple implementations added as option. The `--token-implementation-address` flag explicitly provides a custom token implementation address. It will look for this implementation address inside tDocDeployer.
- If no implementation is passed, **tDocDeployer** will automatically pick the **default implementation**.
The TrustVC CLI uses an interactive prompt system that guides you through the deployment process:

```bash
tradetrust deploy token-registry <registry-name> <registry-symbol> --token-implementation-address <token-implementation-address> --network <network-name>
trustvc deploy token-registry
```

Example - with private key set in OA_PRIVATE_KEY environment variable (recommended).
The CLI will interactively prompt you for:

```bash
tradetrust deploy token-registry "My Sample Token" MST --network sepolia
1. **Network selection**: Choose from available networks (e.g., sepolia, polygon-amoy)
2. **Registry name**: Enter the name of the token registry (e.g., "My Sample Token")
3. **Registry symbol**: Enter the symbol of the token registry (e.g., "MST")
4. **Deployment type**: Choose between standalone or factory deployment
- If **factory deployment** (default): You can optionally provide:
- Token registry implementation address (optional - uses default if not provided)
- Deployer contract address (optional - uses default if not provided)
5. **Wallet selection**: Choose between encrypted wallet, private key file, or environment variable

✔ success Token registry deployed at 0x4B127b8d5e53872d403ce43414afeb1db67B1842
Example session:

```bash
trustvc deploy token-registry

? Select a network: sepolia
? Enter the name of the token registry: My Sample Token
? Enter the symbol of the token registry: MST
? Is this a standalone deployment? No
? Enter the token registry implementation address (optional, press Enter to use default):
? Enter the deployer contract address (optional, press Enter to use default):
? Select wallet type: Environment Variable (OA_PRIVATE_KEY)

ℹ info Deploying token registry My Sample Token
✔ success Token registry deployed at 0x4B127b8d5e53872d403ce43414afeb1db67B1842
ℹ info Find more details at https://sepolia.etherscan.io/tx/0x...
```

**Notes:**

- tDocDeployer can have multiple implementations added as options
- If no implementation address is provided, **tDocDeployer** will automatically pick the **default implementation**
- The CLI will perform a dry run on Ethereum and Polygon networks to estimate gas costs before deployment

#### 2) Deploying via code

##### Installation
Expand Down Expand Up @@ -130,36 +199,83 @@ const initParam = v5Utils.encodeInitParams({
const tx = await connectedDeployer.deploy(implAddress, initParam);
```

### StandAlone
### Standalone Deployment

If you want to deploy the Token Registry as a standalone contract instead of using TDocDeployer, you will need the Title Escrow Factory contract address. Below is the CLI command for deployment:
If you want to deploy the Token Registry as a standalone contract instead of using TDocDeployer, you will need the Title Escrow Factory contract address.

```bash
tradetrust deploy token-registry <registry-name> <registry-symbol> --factory-address <factory-address> --standalone --network <network-name>
trustvc deploy token-registry
```

Example - with private key set in OA_PRIVATE_KEY environment variable (recommended).
The CLI will interactively prompt you for:

```bash
tradetrust deploy token-registry "My Sample Token" MST --factory-address 0xfcafea839e576967b96ad1FBFB52b5CA26cd1D25 --standalone --network sepolia
1. **Network selection**: Choose from available networks (e.g., sepolia, polygon-amoy)
2. **Registry name**: Enter the name of the token registry (e.g., "My Sample Token")
3. **Registry symbol**: Enter the symbol of the token registry (e.g., "MST")
4. **Deployment type**: Choose **Yes** for standalone deployment
- If **standalone**: You can optionally provide:
- Factory address (optional - uses default Title Escrow Factory if not provided)
5. **Wallet selection**: Choose between encrypted wallet, private key file, or environment variable

Example session:

✔ success Token registry deployed at 0x4B127b8d5e53872d403ce43414afeb1db67B1842
```bash
trustvc deploy token-registry

? Select a network: sepolia
? Enter the name of the token registry: My Sample Token
? Enter the symbol of the token registry: MST
? Is this a standalone deployment? Yes
? Enter the factory address (optional, press Enter to use default): 0xfcafea839e576967b96ad1FBFB52b5CA26cd1D25
? Select wallet type: Environment Variable (OA_PRIVATE_KEY)

ℹ info Deploying token registry My Sample Token
✔ success Token registry deployed at 0x4B127b8d5e53872d403ce43414afeb1db67B1842
ℹ info Find more details at https://sepolia.etherscan.io/tx/0x...
```

## TitleEscrow

### 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. Every minting of a new document will also create a new Title Escrow Contract .
Mint a hash to a token registry deployed on the blockchain. The tokenId is used to indicate the document hash, and the beneficiary and holder options indicate the title escrow ownership. Every minting of a new document will also create a new Title Escrow Contract.

```bash
tradetrust token-registry mint --network <NETWORK> --address <TOKEN_REGISTRY_ADDRESS> --tokenId <TOKEN_ID> --beneficiary <BENEFICIARY> --holder <HOLDER>
trustvc token-registry mint
```

Example - with private key set in OA_PRIVATE_KEY environment variable (recommended).
The CLI will interactively prompt you for:

```bash
tradetrust token-registry mint --network sepolia --address 0x6133f580aE903b8e79845340375cCfd78a45FF35 --tokenId 0x10ee711d151bc2139473a57531f91d961b639affb876b350c31d031059cdcc2c --beneficiary 0xB26B4941941C51a4885E5B7D3A1B861E54405f90 --holder 0xB26B4941941C51a4885E5B7D3A1B861E54405f90
1. **Document path**: Path to the wrapped document file (JSON)
- The CLI automatically extracts the token registry address, token ID, and network from the document
- Verifies the document signature before proceeding
2. **Beneficiary address**: The initial recipient/owner of the document
3. **Holder address**: The initial holder of the document (can be the same as beneficiary)
4. **Wallet selection**: Choose between encrypted wallet, private key file, or environment variable
5. **Remark** (optional, V5 only): Additional remarks to be encrypted and stored with the token

Example session:

✔ success Token with hash 0x10ee711d151bc2139473a57531f91d961b639affb876b350c31d031059cdcc2c has been issued on 0x6133f580aE903b8e79845340375cCfd78a45FF35 with the initial recipient being 0xB26B4941941C51a4885E5B7D3A1B861E54405f90 and initial holder 0xB26B4941941C51a4885E5B7D3A1B861E54405f90
```bash
trustvc token-registry mint

? Enter the path to the wrapped document: ./wrapped-documents/document-1.json
ℹ info Document signature verified successfully
? Enter the beneficiary address: 0xB26B4941941C51a4885E5B7D3A1B861E54405f90
? Enter the holder address: 0xB26B4941941C51a4885E5B7D3A1B861E54405f90
? Select wallet type: Environment Variable (OA_PRIVATE_KEY)
? Enter remarks (optional, press Enter to skip):

ℹ info Issuing 0x10ee711d151bc2139473a57531f91d961b639affb876b350c31d031059cdcc2c to the initial recipient 0xB26B4941941C51a4885E5B7D3A1B861E54405f90 and initial holder 0xB26B4941941C51a4885E5B7D3A1B861E54405f90 in the registry 0x6133f580aE903b8e79845340375cCfd78a45FF35
⠋ awaiting Waiting for transaction 0x... to be mined
✔ success Token with hash 0x10ee711d151bc2139473a57531f91d961b639affb876b350c31d031059cdcc2c has been minted on 0x6133f580aE903b8e79845340375cCfd78a45FF35 with the initial recipient being 0xB26B4941941C51a4885E5B7D3A1B861E54405f90 and initial holder 0xB26B4941941C51a4885E5B7D3A1B861E54405f90
ℹ info Find more details at https://sepolia.etherscan.io/tx/0x...
```

**Key Features:**

- **Automatic extraction**: Token registry address, token ID, and network are automatically extracted from the wrapped document
- **Document verification**: The CLI verifies the document signature before minting
- **Encrypted remarks**: Remarks (if provided) are encrypted using the document ID as the encryption key
- **Gas estimation**: Automatic dry run on Ethereum and Polygon networks to estimate gas costs
- **Title Escrow creation**: A new Title Escrow contract is automatically created during the minting process
Loading
Loading