@trustvc/trustvc 1.6.0-alpha.1 → 1.6.0-alpha.3

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

@@ -1,43 +1,82 @@
-import { CHAIN_ID } from '@tradetrust-tt/tradetrust-utils';
-import { Signer as Signer$1, BigNumberish } from 'ethersV6';
-import { Signer, BigNumber } from 'ethers';
+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';
 
-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 TransferOptions {
-    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;
-};
-declare const transferHolder: (contractOptions: ContractOptions, signer: Signer | Signer$1, params: TransferHolderParams, options: TransferOptions) => Promise<ContractTransactionResponse>;
-declare const transferBeneficiary: (contractOptions: ContractOptions, signer: Signer | Signer$1, params: TransferBeneficiaryParams, options: TransferOptions) => Promise<any>;
-declare const transferOwners: (contractOptions: ContractOptions, signer: Signer | Signer$1, params: TransferOwnersParams, options: TransferOptions) => Promise<any>;
-declare const nominate: (contractOptions: ContractOptions, signer: Signer | Signer$1, params: NominateParams, options: TransferOptions) => Promise<any>;
+/**
+ * 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.6.0-alpha.1",
+  "version": "1.6.0-alpha.3",
   "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",
@@ -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"