Deployment

Beta

Obligation Registry support (including the bill-of-exchange profile) is currently in beta. APIs, contract addresses, and behavior may change before the stable release. Use on testnet only and do not rely on this feature in production.

Obligation Registry

The Obligation Registry contract (TrustVCToken) is deployed together with its own ObligationEscrowFactory, which creates a new ObligationEscrow for each minted document.

Installing TrustVC CLI

Binary

To install the binary, simply download the binary from the CLI release page for your OS.

NPM

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 @trustvc/trustvc-cli@beta

The above command will install the TrustVC CLI to your machine. You will need to have Node.js v22.19.5 or later installed to be able to run the command.

You can also opt to use npx:

npx @trustvc/trustvc-cli@beta <arguments>

Deploying via CLI

trustvc obligation-registry deploy

The CLI will interactively prompt you for:

1. Network selection: Choose from available networks (e.g., sepolia, polygon-amoy)
2. Registry name and symbol: e.g. "My Obligation Registry", "MOR"
3. ObligationEscrowFactory address (optional): reuse an existing factory, or let the CLI deploy a new one
4. Wallet selection: Choose between encrypted wallet, private key file, or environment variable
5. Dry-run confirmation before broadcasting

Save your Obligation Registry address. You'll need it for credentialStatus.obligationRegistry when signing Bill of Exchange documents, and for every obligation-registry / obligation-escrow command afterwards.

Deploying via Code

Installation

npm install --save  @trustvc/trustvc@beta

This requires Node.js v20.0.0 or later.

---

Usage

To use the package, you will need to provide your own Web3 provider or signer (if you are writing to the blockchain).

Full function reference: TrustVC SDK README — Obligation Registry (BoE).

The quickest way to deploy is the SDK's convenience function, which deploys a new ObligationEscrowFactory and TrustVCToken for you in a single call:

import { deployObligationRegistry } from "@trustvc/trustvc";

const { obligationRegistry, obligationEscrowFactoryAddress } = await deployObligationRegistry(
  "My Obligation Registry",
  "MOR",
  signer,
  { chainId },
);

If you'd rather deploy — or reuse — the two contracts yourself (for example, to share one ObligationEscrowFactory across multiple registries), deploy them directly. Unlike the SDK convenience function above (which works with any ethers v5/v6 provider or signer), this snippet uses Hardhat's ethers re-export and needs to run inside a Hardhat project configured with the ethers v6 plugin (@nomicfoundation/hardhat-ethers) -- e.g. the token-registry contracts repo itself, not a plain Node script:

import { ethers } from "hardhat";

const escrowFactory = await (await ethers.getContractFactory("ObligationEscrowFactory")).deploy();
await escrowFactory.waitForDeployment();

const token = await (
  await ethers.getContractFactory("TrustVCToken")
).deploy("My Obligation Registry", "MOR", await escrowFactory.getAddress());
await token.waitForDeployment();

The deployer becomes the default admin of the Obligation Registry.