@trustvc/trustvc 1.7.3 → 1.8.0

package/dist/esm/token-registry-functions/utils.js

@@ -0,0 +1,33 @@
+import { isV6EthersProvider } from '../utils/ethers';
+import { SUPPORTED_CHAINS } from '@tradetrust-tt/tradetrust-utils';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+const getTxOptions = /* @__PURE__ */ __name(async (signer, chainId, maxFeePerGas, maxPriorityFeePerGas) => {
+  if (!maxFeePerGas || !maxPriorityFeePerGas) {
+    chainId = chainId ?? await getChainIdSafe(signer);
+    const gasStation = SUPPORTED_CHAINS[chainId]?.gasStation;
+    if (gasStation) {
+      const gasFees = await gasStation();
+      maxFeePerGas = gasFees?.maxFeePerGas ?? 0;
+      maxPriorityFeePerGas = gasFees?.maxPriorityFeePerGas ?? 0;
+    }
+  }
+  return maxFeePerGas && maxPriorityFeePerGas ? { maxFeePerGas, maxPriorityFeePerGas } : {};
+}, "getTxOptions");
+const getChainIdSafe = /* @__PURE__ */ __name(async (signer) => {
+  if (isV6EthersProvider(signer.provider)) {
+    const network = await signer.provider?.getNetwork();
+    if (!network?.chainId) throw new Error("Cannot determine chainId: provider is missing");
+    return network.chainId;
+  }
+  return await signer.getChainId();
+}, "getChainIdSafe");
+const getSignerAddressSafe = /* @__PURE__ */ __name(async (signer) => {
+  if (isV6EthersProvider(signer.provider)) {
+    return await signer.getAddress();
+  }
+  return await signer.getAddress();
+}, "getSignerAddressSafe");
+
+export { getChainIdSafe, getSignerAddressSafe, getTxOptions };

package/dist/types/core/endorsement-chain/index.d.ts

@@ -3,7 +3,7 @@ export { fetchTokenTransfers } from './fetchTokenTransfer.js';
 export { fetchEventTime, mergeTransfersV4, mergeTransfersV5, sortLogChain } from './helpers.js';
 export { getEndorsementChain } from './retrieveEndorsementChain.js';
 export { EndorsementChain, ParsedLog, TitleEscrowTransferEvent, TitleEscrowTransferEventType, TokenTransferEvent, TokenTransferEventType, TradeTrustTokenEventType, TransferBaseEvent, TransferEvent, TransferEventType, TypedEvent } from './types.js';
-export { TitleEscrowInterface, fetchEndorsementChain, getDocumentOwner, getTitleEscrowAddress, isTitleEscrowVersion } from './useEndorsementChain.js';
+export { TitleEscrowInterface, checkSupportsInterface, fetchEndorsementChain, getDocumentOwner, getTitleEscrowAddress, isTitleEscrowVersion } from './useEndorsementChain.js';
 import 'ethersV6';
 import '@ethersproject/abstract-provider';
 import 'ethers';

package/dist/types/core/endorsement-chain/useEndorsementChain.d.ts

@@ -12,6 +12,7 @@ declare const getTitleEscrowAddress: (tokenRegistryAddress: string, tokenId: str
     titleEscrowVersion?: "v4" | "v5";
 }) => Promise<string>;
 declare const getDocumentOwner: (tokenRegistryAddress: string, tokenId: string, provider: Provider | ethers.Provider) => Promise<string>;
+declare const checkSupportsInterface: (contractAddress: string, interfaceId: string, provider: Provider | ethers.Provider) => Promise<boolean>;
 interface TitleEscrowVersionParams {
     tokenRegistryAddress?: string;
     tokenId?: string;
@@ -27,4 +28,4 @@ interface TitleEscrowVersionParams {
 declare const isTitleEscrowVersion: ({ tokenRegistryAddress, tokenId, titleEscrowAddress, versionInterface, provider, }: TitleEscrowVersionParams) => Promise<boolean>;
 declare const fetchEndorsementChain: (tokenRegistryAddress: string, tokenId: string, provider: Provider | ethers.Provider, keyId?: string, titleEscrowAddress?: string) => Promise<EndorsementChain>;
 
-export { TitleEscrowInterface, fetchEndorsementChain, getDocumentOwner, getTitleEscrowAddress, isTitleEscrowVersion };
+export { TitleEscrowInterface, checkSupportsInterface, fetchEndorsementChain, getDocumentOwner, getTitleEscrowAddress, isTitleEscrowVersion };

package/dist/types/core/index.d.ts

@@ -6,7 +6,7 @@ export { fetchTokenTransfers } from './endorsement-chain/fetchTokenTransfer.js';
 export { fetchEventTime, mergeTransfersV4, mergeTransfersV5, sortLogChain } from './endorsement-chain/helpers.js';
 export { getEndorsementChain } from './endorsement-chain/retrieveEndorsementChain.js';
 export { EndorsementChain, ParsedLog, TitleEscrowTransferEvent, TitleEscrowTransferEventType, TokenTransferEvent, TokenTransferEventType, TradeTrustTokenEventType, TransferBaseEvent, TransferEvent, TransferEventType, TypedEvent } from './endorsement-chain/types.js';
-export { TitleEscrowInterface, fetchEndorsementChain, getDocumentOwner, getTitleEscrowAddress, isTitleEscrowVersion } from './endorsement-chain/useEndorsementChain.js';
+export { TitleEscrowInterface, checkSupportsInterface, fetchEndorsementChain, getDocumentOwner, getTitleEscrowAddress, isTitleEscrowVersion } from './endorsement-chain/useEndorsementChain.js';
 export { DocumentBuilder, RenderMethod, W3CTransferableRecordsConfig, W3CVerifiableDocumentConfig, qrCode } from './documentBuilder.js';
 import '@trustvc/w3c-vc';
 import 'ethers';

package/dist/types/index.d.ts

@@ -10,6 +10,11 @@ export { supportInterfaceIds as v5SupportInterfaceIds } from './token-registry-v
 export { c as v5Contracts } from './contracts-BaIGKzNt.js';
 export { computeInterfaceId as v5ComputeInterfaceId, encodeInitParams as v5EncodeInitParams, getEventFromReceipt as v5GetEventFromReceipt } from './token-registry-v5/utils.js';
 export { TypedContractMethod } from '@tradetrust-tt/token-registry-v5/contracts/common';
+export { nominate, transferBeneficiary, transferHolder, transferOwners } from './token-registry-functions/transfer.js';
+export { rejectTransferBeneficiary, rejectTransferHolder, rejectTransferOwners } from './token-registry-functions/rejectTransfers.js';
+export { acceptReturned, rejectReturned, returnToIssuer } from './token-registry-functions/returnToken.js';
+export { mint } from './token-registry-functions/mint.js';
+export { ownerOf } from './token-registry-functions/ownerOf.js';
 export { decrypt } from './core/decrypt.js';
 export { encrypt } from './core/encrypt.js';
 export { verifyDocument } from './core/verify.js';
@@ -18,7 +23,7 @@ export { fetchTokenTransfers } from './core/endorsement-chain/fetchTokenTransfer
 export { fetchEventTime, mergeTransfersV4, mergeTransfersV5, sortLogChain } from './core/endorsement-chain/helpers.js';
 export { getEndorsementChain } from './core/endorsement-chain/retrieveEndorsementChain.js';
 export { EndorsementChain, ParsedLog, TitleEscrowTransferEvent, TitleEscrowTransferEventType, TokenTransferEvent, TokenTransferEventType, TradeTrustTokenEventType, TransferBaseEvent, TransferEvent, TransferEventType, TypedEvent } from './core/endorsement-chain/types.js';
-export { TitleEscrowInterface, fetchEndorsementChain, getDocumentOwner, getTitleEscrowAddress, isTitleEscrowVersion } from './core/endorsement-chain/useEndorsementChain.js';
+export { TitleEscrowInterface, checkSupportsInterface, fetchEndorsementChain, getDocumentOwner, getTitleEscrowAddress, isTitleEscrowVersion } from './core/endorsement-chain/useEndorsementChain.js';
 export { DocumentBuilder, RenderMethod, W3CTransferableRecordsConfig, W3CVerifiableDocumentConfig, qrCode } from './core/documentBuilder.js';
 export { signOA } from './open-attestation/sign.js';
 export { KeyPair } from './open-attestation/types.js';
@@ -55,6 +60,7 @@ import '@typechain/ethers-v5/static/common';
 import '@tradetrust-tt/token-registry-v5/contracts';
 import '@tradetrust-tt/token-registry-v5';
 import 'ethersV6';
+import './token-registry-functions/types.js';
 import '@ethersproject/abstract-provider';
 import 'ethers/lib/utils';
 import '@ethersproject/abstract-signer';

package/dist/types/token-registry-functions/index.d.ts

@@ -0,0 +1,9 @@
+export { nominate, transferBeneficiary, transferHolder, transferOwners } from './transfer.js';
+export { rejectTransferBeneficiary, rejectTransferHolder, rejectTransferOwners } from './rejectTransfers.js';
+export { acceptReturned, rejectReturned, returnToIssuer } from './returnToken.js';
+export { mint } from './mint.js';
+export { ownerOf } from './ownerOf.js';
+import 'ethersV6';
+import 'ethers';
+import './types.js';
+import '@tradetrust-tt/tradetrust-utils';

package/dist/types/token-registry-functions/mint.d.ts

@@ -0,0 +1,20 @@
+import { Signer as Signer$1 } from 'ethersV6';
+import { Signer, ContractTransaction } from 'ethers';
+import { MintTokenOptions, MintTokenParams, TransactionOptions } from './types.js';
+import '@tradetrust-tt/tradetrust-utils';
+
+/**
+ * Mints a new token into the TradeTrustToken registry with the specified beneficiary and holder.
+ * Supports both Token Registry V4 and V5 contracts.
+ * @param {MintTokenOptions} contractOptions - Contains the `tokenRegistryAddress` for the minting contract.
+ * @param {Signer | SignerV6} signer - Signer instance (Ethers v5 or v6) that authorizes the mint transaction.
+ * @param {MintTokenParams} params - Parameters for minting, including `beneficiaryAddress`, `holderAddress`, `tokenId`, and optional `remarks`.
+ * @param {TransactionOptions} options - Transaction metadata including gas values, version detection, chain ID, and optional encryption ID.
+ * @returns {Promise<ContractTransaction>} A promise resolving to the transaction result from the mint call.
+ * @throws {Error} If the token registry address or signer provider is not provided.
+ * @throws {Error} If neither V4 nor V5 interfaces are supported.
+ * @throws {Error} If the `callStatic.mint` fails as a pre-check.
+ */
+declare const mint: (contractOptions: MintTokenOptions, signer: Signer | Signer$1, params: MintTokenParams, options: TransactionOptions) => Promise<ContractTransaction>;
+
+export { mint };

package/dist/types/token-registry-functions/ownerOf.d.ts

@@ -0,0 +1,19 @@
+import { Signer as Signer$1 } from 'ethersV6';
+import { Signer } from 'ethers';
+import { OwnerOfTokenOptions, OwnerOfTokenParams, TransactionOptions } from './types.js';
+import '@tradetrust-tt/tradetrust-utils';
+
+/**
+ * Retrieves the owner of a given token from the TradeTrustToken contract.
+ * Supports both Token Registry V4 and V5 implementations.
+ * @param {OwnerOfTokenOptions} contractOptions - Options containing the token registry address.
+ * @param {Signer | SignerV6} signer - Signer instance (v5 or v6) used to query the blockchain.
+ * @param {OwnerOfTokenParams} params - Contains the `tokenId` of the token to query ownership for.
+ * @param {TransactionOptions} options - Includes the `titleEscrowVersion` and other optional metadata for interface detection.
+ * @returns {Promise<string>} A promise that resolves to the owner address of the specified token.
+ * @throws {Error} If token registry address or signer provider is not provided.
+ * @throws {Error} If the token registry does not support V4 or V5 interfaces.
+ */
+declare const ownerOf: (contractOptions: OwnerOfTokenOptions, signer: Signer | Signer$1, params: OwnerOfTokenParams, options: TransactionOptions) => Promise<string>;
+
+export { ownerOf };

package/dist/types/token-registry-functions/rejectTransfers.d.ts

@@ -0,0 +1,43 @@
+import { Signer as Signer$1 } from 'ethersV6';
+import { Signer, ContractTransaction } from 'ethers';
+import { ContractOptions, RejectTransferParams, TransactionOptions } from './types.js';
+import '@tradetrust-tt/tradetrust-utils';
+
+/**
+ * Rejects the transfer of holder for a title escrow contract.
+ * @param {ContractOptions} contractOptions - Contract-related options including the token registry address, and optionally, token ID and the title escrow address.
+ * @param {Signer | SignerV6} signer - Ethers signer (V5 or V6) used to sign and send the transaction.
+ * @param {RejectTransferParams} params - Contains the `remarks` field which is an optional string that will be encrypted and sent with the transaction.
+ * @param {TransactionOptions} options - Transfer options including optional `chainId`, `titleEscrowVersion`,  `maxFeePerGas`, `maxPriorityFeePerGas`, and an `id` used for encryption.
+ * @throws error if the title escrow address or signer provider is missing.
+ * @throws if the version is not V5 compatible.
+ * @throws if the dry-run (`callStatic`) fails.
+ * @returns {Promise<ContractTransaction>} The transaction response of the rejectTransferHolder call.
+ */
+declare const rejectTransferHolder: (contractOptions: ContractOptions, signer: Signer | Signer$1, params: RejectTransferParams, options: TransactionOptions) => Promise<ContractTransaction>;
+/**
+ * Rejects the transfer of beneficiary for a title escrow contract.
+ * @param {ContractOptions} contractOptions - Contract-related options including the token registry address, and optionally, token ID and the title escrow address.
+ * @param {Signer | SignerV6} signer - Ethers signer (V5 or V6) used to sign and send the transaction.
+ * @param {RejectTransferParams} params - Contains the `remarks` field which is an optional string that will be encrypted and sent with the transaction.
+ * @param {TransactionOptions} options - Transfer options including optional `chainId`, `titleEscrowVersion`,  `maxFeePerGas`, `maxPriorityFeePerGas`, and an `id` used for encryption.
+ * @throws error if the title escrow address or signer provider is missing.
+ * @throws error if the version is not V5 compatible.
+ * @throws error if the dry-run (`callStatic`) fails.
+ * @returns {Promise<ContractTransaction>} The transaction response of the rejectTransferBeneficiary call.
+ */
+declare const rejectTransferBeneficiary: (contractOptions: ContractOptions, signer: Signer | Signer$1, params: RejectTransferParams, options: TransactionOptions) => Promise<ContractTransaction>;
+/**
+ * Rejects the transfer of ownership for a title escrow contract.
+ * @param {ContractOptions} contractOptions - Contract-related options including the token registry address, and optionally, token ID and the title escrow address.
+ * @param {Signer | SignerV6} signer - Ethers signer (V5 or V6) used to sign and send the transaction.
+ * @param {RejectTransferParams} params - Contains the `remarks` field which is an optional string that will be encrypted and sent with the transaction.
+ * @param {TransactionOptions} options - Transfer options including optional `chainId`, `titleEscrowVersion`,  `maxFeePerGas`, `maxPriorityFeePerGas`, and an `id` used for encryption.
+ * @throws error if the title escrow address or signer provider is missing.
+ * @throws an error if the version is not V5 compatible.
+ * @throws an error if the dry-run (`callStatic`) fails.
+ * @returns {Promise<ContractTransaction>} The transaction response of the rejectTransferOwners call.
+ */
+declare const rejectTransferOwners: (contractOptions: ContractOptions, signer: Signer | Signer$1, params: RejectTransferParams, options: TransactionOptions) => Promise<ContractTransaction>;
+
+export { rejectTransferBeneficiary, rejectTransferHolder, rejectTransferOwners };

package/dist/types/token-registry-functions/returnToken.d.ts

@@ -0,0 +1,44 @@
+import { Signer as Signer$1 } from 'ethersV6';
+import { Signer, ContractTransaction } from 'ethers';
+import { ContractOptions, ReturnToIssuerParams, TransactionOptions, RejectReturnedOptions, AcceptReturnedParams, AcceptReturnedOptions, RejectReturnedParams } from './types.js';
+import '@tradetrust-tt/tradetrust-utils';
+
+/**
+ * Returns the token to the original issuer from the Title Escrow contract.
+ * @param {ContractOptions} contractOptions - Options including token ID, registry address, and optionally title escrow address.
+ * @param {Signer | SignerV6} signer - Signer instance (Ethers v5 or v6) that will execute the transaction.
+ * @param {ReturnToIssuerParams} params - Contains optional remarks to be encrypted and attached to the transaction.
+ * @param {TransactionOptions} options - Transaction settings including gas fees, escrow version, chain ID, and optional encryption ID.
+ * @returns {Promise<ContractTransaction>} Promise that resolves to the transaction response from the `returnToIssuer` function.
+ * @throws {Error} If title escrow address or provider is not provided or if version is unsupported.
+ * @throws {Error} If the `callStatic.returnToIssuer` fails as a pre-check.
+ */
+declare const returnToIssuer: (contractOptions: ContractOptions, signer: Signer | Signer$1, params: ReturnToIssuerParams, options: TransactionOptions) => Promise<ContractTransaction>;
+/**
+ * Rejects a previously returned token by restoring it back to the token registry.
+ * This is only supported on Token Registry V5 contracts with the `restore` functionality.
+ * @param {AcceptReturnedOptions} contractOptions - Contains the `tokenRegistryAddress` used to locate the TradeTrustToken contract.
+ * @param {Signer | SignerV6} signer - Signer instance (v5 or v6) used to authorize the transaction.
+ * @param {AcceptReturnedParams} params - Includes the `tokenId` to restore and optional `remarks` to encrypt.
+ * @param {TransactionOptions} options - Configuration for the transaction including version, gas fees, and optional `id` used for encryption.
+ * @returns {Promise<ContractTransaction>} A promise that resolves to the transaction result of the `restore` call.
+ * @throws {Error} If the token registry address or provider is missing.
+ * @throws {Error} If the token registry version is unsupported.
+ * @throws {Error} If the callStatic pre-check fails.
+ */
+declare const rejectReturned: (contractOptions: AcceptReturnedOptions, signer: Signer | Signer$1, params: RejectReturnedParams, options: TransactionOptions) => Promise<ContractTransaction>;
+/**
+ * Accepts the returned token by burning it from the TradeTrustToken contract.
+ * Only supported on Token Registry V5 contracts that implement the burnable interface.
+ * @param {RejectReturnedOptions} contractOptions - Contains the `tokenRegistryAddress` from which the token will be burned.
+ * @param {Signer | SignerV6} signer - Signer instance (v5 or v6) used to authorize and send the burn transaction.
+ * @param {AcceptReturnedParams} params - Includes the `tokenId` to burn and optional `remarks` for audit trail.
+ * @param {TransactionOptions} options - Transaction settings including chain ID, gas fee values, escrow version, and encryption ID for remarks.
+ * @returns {Promise<ContractTransaction>} A promise resolving to the transaction result of the burn call.
+ * @throws {Error} If token registry address or signer provider is not provided.
+ * @throws {Error} If the contract does not support Token Registry V5.
+ * @throws {Error} If `callStatic.burn` fails as a pre-check.
+ */
+declare const acceptReturned: (contractOptions: RejectReturnedOptions, signer: Signer | Signer$1, params: AcceptReturnedParams, options: TransactionOptions) => Promise<ContractTransaction>;
+
+export { acceptReturned, rejectReturned, returnToIssuer };

package/dist/types/token-registry-functions/transfer.d.ts

@@ -0,0 +1,82 @@
+import { Signer as Signer$1 } from 'ethersV6';
+import { Signer, ContractTransaction } from 'ethers';
+import { ContractOptions, TransferHolderParams, TransactionOptions, TransferBeneficiaryParams, TransferOwnersParams, NominateParams } from './types.js';
+import '@tradetrust-tt/tradetrust-utils';
+
+/**
+ * Transfers holder role of a Title Escrow contract to a new address.
+ * The caller of this function must be the current holder.
+ * @param {ContractOptions} contractOptions - Contains `tokenRegistryAddress` and optionally `tokenId` and  `titleEscrowAddress`.
+ * @param {Signer | SignerV6} signer - The signer (ethers v5 or v6) who initiates the transaction.
+ * @param {TransferHolderParams} params - Object containing `holderAddress` (address to transfer to) and optional `remarks`.
+ * @param {TransactionOptions} options - Transaction options including:
+ *   - `titleEscrowVersion` (optional): Either "v4" or "v5"
+ *   - `chainId` (optional): Used for gas station lookup
+ *   - `maxFeePerGas` (optional), `maxPriorityFeePerGas` (optional): EIP-1559 gas fee configuration
+ *   - `id` (optional): ID used for encrypting remarks
+ * @throws If required fields like `titleEscrowAddress` or `signer.provider` are missing.
+ * @throws If the version is unsupported (neither v4 nor v5).
+ * @throws If the dry-run via `callStatic` fails.
+ * @returns {Promise<ContractTransaction>} The transaction response for `transferHolder`.
+ */
+declare const transferHolder: (contractOptions: ContractOptions, signer: Signer | Signer$1, params: TransferHolderParams, options: TransactionOptions) => Promise<ContractTransaction>;
+/**
+ * Transfers the beneficiary role of a Title Escrow contract to a new beneficiary address.
+ * The caller of this function must be the current holder.
+ * @param {ContractOptions}  contractOptions - Contains `tokenRegistryAddress` and optionally `tokenId` and  `titleEscrowAddress`.
+ * @param {Signer | SignerV6} signer - The signer (ethers v5 or v6) who initiates and signs the transaction.
+ * @param {TransferBeneficiaryParams} params - Object containing:
+ *   - `newBeneficiaryAddress`: Address to which the beneficiary role is being transferred.
+ *   - `remarks` (optional): Optional encrypted message attached with the transaction.
+ * @param {TransactionOptions} options - Transaction configuration options:
+ *   - `titleEscrowVersion` (optional): Token registry version, either `'v4'` or `'v5'`.
+ *   - `chainId` (optional): Used to query gas station info if gas fee values are missing.
+ *   - `maxFeePerGas`(optional), `maxPriorityFeePerGas`(optional): EIP-1559 gas fee parameters.
+ *   - `id`(optional): Used for encryption of remarks.
+ * @throws If required values like `titleEscrowAddress` or `signer.provider` are missing.
+ * @throws If the version is unsupported (neither v4 nor v5).
+ * @throws If the dry-run `callStatic` fails for pre-checking the transaction.
+ * @returns {Promise<ContractTransaction>} The transaction response for the `transferBeneficiary` call.
+ */
+declare const transferBeneficiary: (contractOptions: ContractOptions, signer: Signer | Signer$1, params: TransferBeneficiaryParams, options: TransactionOptions) => Promise<ContractTransaction>;
+/**
+ * Transfers both the holder and beneficiary roles of a Title Escrow contract to new addresses.
+ * The caller of this function must be the current holder and beneficiary both.
+ * @param {ContractOptions} contractOptions - Contains `tokenRegistryAddress` and optionally `tokenId` and  `titleEscrowAddress`.
+ * @param {Signer | SignerV6} signer - The signer (ethers v5 or v6) who initiates and signs the transaction.
+ * @param {TransferOwnersParams} params - Object containing:
+ *   - `newBeneficiaryAddress`: The new beneficiary address.
+ *   - `newHolderAddress`: The new holder address.
+ *   - `remarks` (optional): Optional remarks that will be encrypted and included with the transaction.
+ * @param {TransactionOptions} options - Transaction configuration options:
+ *   - `titleEscrowVersion` (optional): Token registry version, either `'v4'` or `'v5'`.
+ *   - `chainId` (optional): Used for gas station lookup if gas fee values are not provided.
+ *   - `maxFeePerGas`(optional), `maxPriorityFeePerGas`(optional): EIP-1559 gas fee parameters.
+ *   - `id`(optional): Used for encrypting remarks.
+ * @throws If required fields like `titleEscrowAddress` or `signer.provider` are missing.
+ * @throws If the title escrow version is unsupported.
+ * @throws If the pre-check `callStatic.transferOwners` fails.
+ * @returns {Promise<ContractTransaction>} The transaction response from the `transferOwners` call.
+ */
+declare const transferOwners: (contractOptions: ContractOptions, signer: Signer | Signer$1, params: TransferOwnersParams, options: TransactionOptions) => Promise<ContractTransaction>;
+/**
+ * Nominates a new beneficiary on the Title Escrow contract.
+ * The caller of this function must be the current beneficiary.
+ * @param {ContractOptions} contractOptions - Contains `tokenRegistryAddress` and optionally `tokenId` and  `titleEscrowAddress`.
+ * @param {Signer | SignerV6} signer - The signer (ethers v5 or v6) who will sign and send the transaction.
+ * @param {NominateParams} params - Nomination parameters:
+ *   - `newBeneficiaryAddress`: The Ethereum address to nominate as the new beneficiary.
+ *   - `remarks` (optional): Remarks to include with the transaction (will be encrypted).
+ * @param {TransactionOptions} options - Transaction-level configuration:
+ *   - `titleEscrowVersion` (optional): Specifies token registry version, either `'v4'` or `'v5'`.
+ *   - `chainId` (optional): Chain ID used for querying gas stations if fees are not set.
+ *   - `maxFeePerGas`(optional), `maxPriorityFeePerGas`(optional): EIP-1559-compatible gas fee settings.
+ *   - `id`(optional): Used for encrypting the remarks string.
+ * @throws If required inputs like `titleEscrowAddress` or `signer.provider` are missing.
+ * @throws If token registry version is unsupported.
+ * @throws If the dry-run `callStatic.nominate()` fails.
+ * @returns {Promise<ContractTransaction>} The transaction response from the `nominate` method.
+ */
+declare const nominate: (contractOptions: ContractOptions, signer: Signer | Signer$1, params: NominateParams, options: TransactionOptions) => Promise<ContractTransaction>;
+
+export { nominate, transferBeneficiary, transferHolder, transferOwners };

package/dist/types/token-registry-functions/types.d.ts

@@ -0,0 +1,80 @@
+import { CHAIN_ID } from '@tradetrust-tt/tradetrust-utils';
+import { BigNumber, providers } from 'ethers';
+import { BigNumberish, Provider } from 'ethersV6';
+
+type GasValue = BigNumber | BigNumberish | string | number;
+interface RejectTransferParams {
+    remarks?: string;
+}
+interface ReturnToIssuerParams {
+    remarks?: string;
+}
+interface AcceptReturnedParams {
+    tokenId: string | number;
+    remarks?: string;
+}
+interface RejectReturnedParams {
+    tokenId: string | number;
+    remarks?: string;
+}
+interface MintTokenParams {
+    beneficiaryAddress: string;
+    holderAddress: string;
+    tokenId: string | number;
+    remarks?: string;
+}
+interface OwnerOfTokenParams {
+    tokenId: string | number;
+}
+interface TransactionOptions {
+    chainId?: CHAIN_ID;
+    titleEscrowVersion?: 'v4' | 'v5';
+    maxFeePerGas?: BigNumberish | string | number | BigNumber;
+    maxPriorityFeePerGas?: BigNumberish | string | number | BigNumber;
+    id?: string;
+}
+type ContractOptions = {
+    titleEscrowAddress: string;
+    tokenId?: string | number;
+    tokenRegistryAddress?: string;
+} | {
+    titleEscrowAddress?: undefined;
+    tokenId: string | number;
+    tokenRegistryAddress: string;
+};
+type AcceptReturnedOptions = {
+    tokenRegistryAddress: string;
+};
+type RejectReturnedOptions = {
+    tokenRegistryAddress: string;
+};
+type MintTokenOptions = {
+    tokenRegistryAddress: string;
+};
+type OwnerOfTokenOptions = {
+    tokenRegistryAddress: string;
+};
+interface TransferHolderParams {
+    holderAddress: string;
+    remarks?: string;
+}
+interface TransferBeneficiaryParams {
+    newBeneficiaryAddress: string;
+    remarks?: string;
+}
+interface NominateParams {
+    newBeneficiaryAddress: string;
+    remarks?: string;
+}
+interface TransferOwnersParams {
+    newHolderAddress: string;
+    newBeneficiaryAddress: string;
+    remarks?: string;
+}
+interface ProviderInfo {
+    Provider: providers.Provider | Provider;
+    ethersVersion: 'v5' | 'v6';
+    titleEscrowVersion: 'v4' | 'v5';
+}
+
+export type { AcceptReturnedOptions, AcceptReturnedParams, ContractOptions, GasValue, MintTokenOptions, MintTokenParams, NominateParams, OwnerOfTokenOptions, OwnerOfTokenParams, ProviderInfo, RejectReturnedOptions, RejectReturnedParams, RejectTransferParams, ReturnToIssuerParams, TransactionOptions, TransferBeneficiaryParams, TransferHolderParams, TransferOwnersParams };

package/dist/types/token-registry-functions/utils.d.ts

@@ -0,0 +1,16 @@
+import { GasValue } from './types.js';
+import { CHAIN_ID } from '@tradetrust-tt/tradetrust-utils';
+import { Signer as Signer$1 } from 'ethers';
+import { Signer } from 'ethersV6';
+
+declare const getTxOptions: (signer: Signer | Signer$1, chainId: CHAIN_ID, maxFeePerGas: GasValue, maxPriorityFeePerGas: GasValue) => Promise<{
+    maxFeePerGas: GasValue;
+    maxPriorityFeePerGas: GasValue;
+} | {
+    maxFeePerGas?: undefined;
+    maxPriorityFeePerGas?: undefined;
+}>;
+declare const getChainIdSafe: (signer: Signer | Signer$1) => Promise<bigint | number>;
+declare const getSignerAddressSafe: (signer: Signer | Signer$1) => Promise<string>;
+
+export { getChainIdSafe, getSignerAddressSafe, getTxOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trustvc/trustvc",
-  "version": "1.7.3",
+  "version": "1.8.0",
   "description": "TrustVC library",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -10,6 +10,10 @@
   ],
   "scripts": {
     "test": "npx vitest --run --test-timeout=15000",
+    "test:e2e": "concurrently -k \"npm run e2e:node\" \"npm run wait-and-test\"",
+    "e2e:node": "npx hardhat node",
+    "wait-and-test": "wait-on tcp:8545 && npm run e2e:test",
+    "e2e:test": "npx hardhat test src/__tests__/e2e/**/*.test.ts --network hardhat",
     "type-check": "tsc --noEmit",
     "lint": "npx eslint . --color --format=table --max-warnings=0",
     "lint:fix": "npx eslint . --fix",
@@ -115,7 +119,7 @@
     "@tradetrust-tt/token-registry-v4": "npm:@tradetrust-tt/token-registry@^4.16.0",
     "@tradetrust-tt/token-registry-v5": "npm:@tradetrust-tt/token-registry@^5.5.0",
     "@tradetrust-tt/tradetrust": "^6.10.2",
-    "@tradetrust-tt/tradetrust-utils": "^2.4.1",
+    "@tradetrust-tt/tradetrust-utils": "^2.4.2",
     "@tradetrust-tt/tt-verify": "^9.5.1",
     "@trustvc/w3c-context": "^1.2.13",
     "@trustvc/w3c-credential-status": "^1.2.13",
@@ -131,13 +135,18 @@
     "@commitlint/config-conventional": "^19.8.0",
     "@commitlint/config-nx-scopes": "^19.8.0",
     "@commitlint/prompt": "^19.8.0",
+    "@nomicfoundation/hardhat-chai-matchers": "^1.0.6",
+    "@nomiclabs/hardhat-ethers": "^2.2.3",
+    "@openzeppelin/contracts": "^5.3.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/npm": "^9.0.2",
     "@types/conventional-commits-parser": "^5.0.1",
     "@types/lodash": "^4.17.16",
+    "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.86",
     "@vitest/coverage-v8": "^1.6.1",
+    "concurrently": "^9.2.0",
     "cpy": "^11.1.0",
     "dotenv": "^16.5.0",
     "eslint": "^9.25.1",
@@ -149,17 +158,20 @@
     "eslint-plugin-promise": "^7.2.1",
     "eth-testing": "^1.14.0",
     "execa": "^9.5.2",
+    "hardhat": "^2.25.0",
     "husky": "^9.1.7",
     "lint-staged": "^15.5.1",
     "prettier": "^3.5.3",
     "rimraf": "^5.0.10",
     "semantic-release": "^20.1.3",
     "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
     "tsup": "^8.4.0",
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.31.0",
     "vite-plugin-dts": "^3.9.1",
-    "vitest": "^1.6.1"
+    "vitest": "^1.6.1",
+    "wait-on": "^8.0.3"
   },
   "overrides": {
     "ethers": "^5.8.0"