@trustvc/trustvc 2.7.0 → 2.9.0

package/dist/types/document-store/issue.d.ts

@@ -1,9 +1,10 @@
 import { Signer as Signer$1, ContractTransactionResponse } from 'ethersV6';
 import { Signer, ContractTransaction } from 'ethers';
-import { CHAIN_ID } from '../utils/supportedChains/index.js';
-import { GasValue } from '../token-registry-functions/types.js';
+import { CommandOptions } from './types.js';
+import '../utils/supportedChains/index.js';
 import '../utils/gasStation/index.js';
 import '../utils/network/index.js';
+import '../token-registry-functions/types.js';
 
 /**
  * Issues a document hash to the DocumentStore contract.
@@ -15,18 +16,12 @@ import '../utils/network/index.js';
  * @param {string} documentStoreAddress - The address of the DocumentStore contract.
  * @param {string} documentHash - The hash of the document to issue (must be a valid hex string).
  * @param {SignerV5 | SignerV6} signer - Signer instance (Ethers v5 or v6) that authorizes the issue transaction.
- * @param {IssueOptions} options - Optional transaction metadata including gas values and chain ID.
+ * @param {CommandOptions} options - Optional transaction metadata including gas values and chain ID.
  * @returns {Promise<ContractTransactionV5 | ContractTransactionV6>} A promise resolving to the transaction result from the issue call.
  * @throws {Error} If the document store address or signer provider is not provided.
  * @throws {Error} If the document hash is invalid.
  * @throws {Error} If the `callStatic.issue` fails as a pre-check.
  */
-interface IssueOptions {
-    chainId?: CHAIN_ID;
-    maxFeePerGas?: GasValue;
-    maxPriorityFeePerGas?: GasValue;
-    isTransferable?: boolean;
-}
-declare const documentStoreIssue: (documentStoreAddress: string, documentHash: string, signer: Signer | Signer$1, options?: IssueOptions) => Promise<ContractTransaction | ContractTransactionResponse>;
+declare const documentStoreIssue: (documentStoreAddress: string, documentHash: string, signer: Signer | Signer$1, options?: CommandOptions) => Promise<ContractTransaction | ContractTransactionResponse>;
 
-export { type IssueOptions, documentStoreIssue };
+export { documentStoreIssue };

package/dist/types/document-store/revoke-role.d.ts

@@ -0,0 +1,28 @@
+import { Signer as Signer$1, ContractTransactionResponse } from 'ethersV6';
+import { Signer, ContractTransaction } from 'ethers';
+import { CommandOptions } from './types.js';
+import '../utils/supportedChains/index.js';
+import '../utils/gasStation/index.js';
+import '../utils/network/index.js';
+import '../token-registry-functions/types.js';
+
+/**
+ * Revokes a role from an account on the DocumentStore contract.
+ * Supports both Ethers v5 and v6 signers.
+ * Supports three types of document stores:
+ * 1. DocumentStore (ERC-165 compliant)
+ * 2. TransferableDocumentStore (ERC-165 compliant)
+ * 3. TT Document Store (legacy, no ERC-165 support - used as fallback)
+ * @param {string} documentStoreAddress - The address of the DocumentStore contract.
+ * @param {string} role - The role to revoke (e.g., 'ISSUER', 'REVOKER', 'ADMIN').
+ * @param {string} account - The account to revoke the role from.
+ * @param {SignerV5 | SignerV6} signer - Signer instance (Ethers v5 or v6) that authorizes the revoke role transaction.
+ * @param {CommandOptions} options - Optional transaction metadata including gas values and chain ID.
+ * @returns {Promise<ContractTransactionV5 | ContractTransactionV6>} A promise resolving to the transaction result from the revoke role call.
+ * @throws {Error} If the document store address or signer provider is not provided.
+ * @throws {Error} If the role is invalid.
+ * @throws {Error} If the `callStatic.revokeRole` fails as a pre-check.
+ */
+declare const documentStoreRevokeRole: (documentStoreAddress: string, role: string, account: string, signer: Signer | Signer$1, options?: CommandOptions) => Promise<ContractTransaction | ContractTransactionResponse>;
+
+export { documentStoreRevokeRole };

package/dist/types/document-store/transferOwnership.d.ts

@@ -0,0 +1,30 @@
+import { Signer as Signer$1, ContractTransactionResponse } from 'ethersV6';
+import { Signer, ContractTransaction } from 'ethers';
+import { CommandOptions } from './types.js';
+import '../utils/supportedChains/index.js';
+import '../utils/gasStation/index.js';
+import '../utils/network/index.js';
+import '../token-registry-functions/types.js';
+
+/**
+ * Transfers ownership of a DocumentStore contract to a new owner.
+ * Supports both Ethers v5 and v6 signers.
+ * Supports three types of document stores:
+ * 1. DocumentStore (ERC-165 compliant)
+ * 2. TransferableDocumentStore (ERC-165 compliant)
+ * 3. TT Document Store (legacy, no ERC-165 support - used as fallback)
+ * @param {string} documentStoreAddress - The address of the DocumentStore contract.
+ * @param {string} account - The account to transfer ownership to.
+ * @param {SignerV5 | SignerV6} signer - Signer instance (Ethers v5 or v6) that authorizes the transfer ownership transaction.
+ * @param {CommandOptions} options - Optional transaction metadata including gas values and chain ID.
+ * @returns {Promise<{grantTransaction: Promise<ContractTransactionV5 | ContractTransactionV6>; revokeTransaction: Promise<ContractTransactionV5 | ContractTransactionV6>}>} A promise resolving to the transaction result from the grant and revoke role calls.
+ * @throws {Error} If the document store address or signer provider is not provided.
+ * @throws {Error} If the role is invalid.
+ * @throws {Error} If the `callStatic.revokeRole` fails as a pre-check.
+ */
+declare const documentStoreTransferOwnership: (documentStoreAddress: string, account: string, signer: Signer | Signer$1, options?: CommandOptions) => Promise<{
+    grantTransaction: Promise<ContractTransaction | ContractTransactionResponse>;
+    revokeTransaction: Promise<ContractTransaction | ContractTransactionResponse>;
+}>;
+
+export { documentStoreTransferOwnership };

package/dist/types/document-store/types.d.ts

@@ -0,0 +1,15 @@
+import { CHAIN_ID } from '../utils/supportedChains/index.js';
+import { GasValue } from '../token-registry-functions/types.js';
+import '../utils/gasStation/index.js';
+import 'ethers';
+import '../utils/network/index.js';
+import 'ethersV6';
+
+interface CommandOptions {
+    chainId?: CHAIN_ID;
+    maxFeePerGas?: GasValue;
+    maxPriorityFeePerGas?: GasValue;
+    isTransferable?: boolean;
+}
+
+export type { CommandOptions };

package/dist/types/index.d.ts

@@ -3,22 +3,35 @@ export { contractAddress as v4ContractAddress } from './token-registry-v4/contra
 export { supportInterfaceIds as v4SupportInterfaceIds } from './token-registry-v4/supportInterfaceIds.js';
 export { c as v4Contracts } from './contracts-BEtjrEPE.js';
 export { computeInterfaceId as v4ComputeInterfaceId, computeTitleEscrowAddress as v4ComputeTitleEscrowAddress, encodeInitParams as v4EncodeInitParams, getEventFromReceipt as v4GetEventFromReceipt } from './token-registry-v4/utils.js';
-export { utils as v4Utils, utils as v5Utils } from '@tradetrust-tt/token-registry-v4';
+export { utils as v4Utils } from '@tradetrust-tt/token-registry-v4';
 export { contractAddress as v5ContractAddress } from './token-registry-v5/contractAddress.js';
 export { roleHash as v5RoleHash } from './token-registry-v5/roleHash.js';
 export { supportInterfaceIds as v5SupportInterfaceIds } from './token-registry-v5/supportInterfaceIds.js';
 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 { utils as v5Utils } from '@tradetrust-tt/token-registry-v5';
 export { TypedContractMethod } from '@tradetrust-tt/token-registry-v5/contracts/common';
 export { documentStoreIssue } from './document-store/issue.js';
 export { documentStoreRevoke } from './document-store/revoke.js';
-export { deployDocumentStore } from './document-store/deploy.js';
+export { documentStoreRevokeRole } from './document-store/revoke-role.js';
+export { documentStoreGrantRole } from './document-store/grant-role.js';
+export { OAErrorMessageHandling, errorMessageHandling, interpretFragments, w3cCredentialStatusRevoked, w3cCredentialStatusSuspended } from './utils/fragment/index.js';
+export { networkCurrency, networkName, networkType, networks } from './utils/network/index.js';
+export { generate12ByteNonce, generate32ByteKey, stringToUint8Array } from './utils/stringUtils/index.js';
+export { CHAIN_ID, SUPPORTED_CHAINS, chainInfo } from './utils/supportedChains/index.js';
+export { errorMessages } from './utils/errorMessages/index.js';
+export { WrappedOrSignedOpenAttestationDocument, getChainId, getObfuscatedData, getTokenId, getTokenRegistryAddress, getTransferableRecordsCredentialStatus, isObfuscated, isTransferableRecord } from './utils/documents/index.js';
+export { GasStationFeeData, GasStationFunction, calculateMaxFee, gasStation, scaleBigNumber } from './utils/gasStation/index.js';
+export { AwsKmsSigner, AwsKmsSignerCredentials } from '@tradetrust-tt/ethers-aws-kms-signer';
+export { gaEvent, gaPageView, validateGaEvent, validateGtag, validatePageViewEvent } from './utils/analytics/analytics.js';
+export { deployDocumentStore } from './deploy/document-store.js';
 export { DocumentStore__factory, TransferableDocumentStore__factory } from '@trustvc/document-store';
 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 { DeployOptions, TransactionReceipt, deployTokenRegistry } from './deploy/token-registry.js';
 export { decrypt } from './core/decrypt.js';
 export { encrypt } from './core/encrypt.js';
 export { verifyDocument } from './core/verify.js';
@@ -46,15 +59,6 @@ export { PrivateKeyPair } from '@trustvc/w3c-issuer';
 export { i as vc } from './index-1ws_BWZW.js';
 export { verifyW3CSignature } from './w3c/verify.js';
 export { deriveW3C } from './w3c/derive.js';
-export { OAErrorMessageHandling, errorMessageHandling, interpretFragments, w3cCredentialStatusRevoked, w3cCredentialStatusSuspended } from './utils/fragment/index.js';
-export { networkCurrency, networkName, networkType, networks } from './utils/network/index.js';
-export { generate12ByteNonce, generate32ByteKey, stringToUint8Array } from './utils/stringUtils/index.js';
-export { CHAIN_ID, SUPPORTED_CHAINS, chainInfo } from './utils/supportedChains/index.js';
-export { errorMessages } from './utils/errorMessages/index.js';
-export { WrappedOrSignedOpenAttestationDocument, getChainId, getObfuscatedData, getTokenId, getTokenRegistryAddress, getTransferableRecordsCredentialStatus, isObfuscated, isTransferableRecord } from './utils/documents/index.js';
-export { GasStationFeeData, GasStationFunction, calculateMaxFee, gasStation, scaleBigNumber } from './utils/gasStation/index.js';
-export { AwsKmsSigner, AwsKmsSignerCredentials } from '@tradetrust-tt/ethers-aws-kms-signer';
-export { gaEvent, gaPageView, validateGaEvent, validateGtag, validatePageViewEvent } from './utils/analytics/analytics.js';
 export { CustomDnsResolver, IDNSQueryResponse, IDNSRecord, OpenAttestationDNSTextRecord, OpenAttestationDnsDidRecord, defaultDnsResolvers, getDnsDidRecords, getDocumentStoreRecords, parseDnsDidResults, parseDocumentStoreResults, parseOpenAttestationRecord, queryDns } from '@tradetrust-tt/dnsprove';
 export { OpenAttestationDocument, SUPPORTED_SIGNING_ALGORITHM, SchemaId, SignedWrappedDocument, WrappedDocument, getData as getDataV2, isSchemaValidationError, obfuscateDocument, v2, v3, validateSchema, __unsafe__use__it__at__your__own__risks__wrapDocument as wrapOADocumentV3, __unsafe__use__it__at__your__own__risks__wrapDocuments as wrapOADocumentsV3 } from '@tradetrust-tt/tradetrust';
 export { DiagnoseError } from '@tradetrust-tt/tradetrust/dist/types/shared/utils';
@@ -65,9 +69,10 @@ import '@tradetrust-tt/token-registry-v4/contracts';
 import 'ethers';
 import '@typechain/ethers-v5/static/common';
 import '@tradetrust-tt/token-registry-v5/contracts';
-import '@tradetrust-tt/token-registry-v5';
 import 'ethersV6';
+import './document-store/types.js';
 import './token-registry-functions/types.js';
+import '@trustvc/w3c-credential-status';
 import '@ethersproject/abstract-provider';
 import 'ethers/lib/utils';
 import '@ethersproject/abstract-signer';
@@ -85,4 +90,3 @@ import './verify/fragments/issuer-identity/w3cIssuerIdentity.js';
 import './verify/fragments/document-status/w3cEmptyCredentialStatus/index.js';
 import 'runtypes';
 import '@trustvc/w3c-context';
-import '@trustvc/w3c-credential-status';

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

@@ -3,6 +3,7 @@ export { rejectTransferBeneficiary, rejectTransferHolder, rejectTransferOwners }
 export { acceptReturned, rejectReturned, returnToIssuer } from './returnToken.js';
 export { mint } from './mint.js';
 export { ownerOf } from './ownerOf.js';
+export { DeployOptions, TransactionReceipt, deployTokenRegistry } from '../deploy/token-registry.js';
 import 'ethersV6';
 import 'ethers';
 import './types.js';

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

@@ -9,7 +9,7 @@ import '../utils/network/index.js';
  * 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 {SignerV5 | 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.

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

@@ -4,6 +4,12 @@ import { BigNumberish, Provider } from 'ethersV6';
 import '../utils/gasStation/index.js';
 import '../utils/network/index.js';
 
+interface GasPriceScale {
+    maxPriorityFeePerGasScale: number;
+}
+interface GasOption extends GasPriceScale {
+    dryRun: boolean;
+}
 type GasValue = BigNumber | BigNumberish | string | number;
 interface RejectTransferParams {
     remarks?: string;
@@ -78,5 +84,24 @@ interface ProviderInfo {
     ethersVersion: 'v5' | 'v6';
     titleEscrowVersion: 'v4' | 'v5';
 }
+interface NetworkOption {
+    network: string;
+}
+type WalletOption = {
+    encryptedWalletPath: string;
+};
+type PrivateKeyOption = {
+    key?: string;
+    keyFile?: never;
+} | {
+    key?: never;
+    keyFile?: string;
+};
+type NetworkAndWalletSignerOption = NetworkOption & (Partial<WalletOption> | Partial<PrivateKeyOption>);
+interface DeployContractAddress {
+    TitleEscrowFactory?: string;
+    TokenImplementation?: string;
+    Deployer?: string;
+}
 
-export type { AcceptReturnedOptions, AcceptReturnedParams, ContractOptions, GasValue, MintTokenOptions, MintTokenParams, NominateParams, OwnerOfTokenOptions, OwnerOfTokenParams, ProviderInfo, RejectReturnedOptions, RejectReturnedParams, RejectTransferParams, ReturnToIssuerParams, TransactionOptions, TransferBeneficiaryParams, TransferHolderParams, TransferOwnersParams };
+export type { AcceptReturnedOptions, AcceptReturnedParams, ContractOptions, DeployContractAddress, GasOption, GasPriceScale, GasValue, MintTokenOptions, MintTokenParams, NetworkAndWalletSignerOption, NetworkOption, NominateParams, OwnerOfTokenOptions, OwnerOfTokenParams, PrivateKeyOption, ProviderInfo, RejectReturnedOptions, RejectReturnedParams, RejectTransferParams, ReturnToIssuerParams, TransactionOptions, TransferBeneficiaryParams, TransferHolderParams, TransferOwnersParams, WalletOption };

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

@@ -1,7 +1,7 @@
-import { GasValue } from './types.js';
+import { GasValue, DeployContractAddress } from './types.js';
 import { CHAIN_ID } from '../utils/supportedChains/index.js';
-import { Signer as Signer$1 } from 'ethers';
-import { Signer } from 'ethersV6';
+import { Signer as Signer$1, providers } from 'ethers';
+import { Signer, Provider } from 'ethersV6';
 import '../utils/gasStation/index.js';
 import '../utils/network/index.js';
 
@@ -14,5 +14,8 @@ declare const getTxOptions: (signer: Signer | Signer$1, chainId: CHAIN_ID, maxFe
 }>;
 declare const getChainIdSafe: (signer: Signer | Signer$1) => Promise<bigint | number>;
 declare const getSignerAddressSafe: (signer: Signer | Signer$1) => Promise<string>;
+declare const getDefaultContractAddress: (chainId: CHAIN_ID) => DeployContractAddress;
+declare const isValidAddress: (address?: string) => boolean;
+declare const isSupportedTitleEscrowFactory: (factoryAddress: string, provider: providers.Provider | Provider) => Promise<boolean>;
 
-export { getChainIdSafe, getSignerAddressSafe, getTxOptions };
+export { getChainIdSafe, getDefaultContractAddress, getSignerAddressSafe, getTxOptions, isSupportedTitleEscrowFactory, isValidAddress };

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

@@ -3,7 +3,6 @@ export { roleHash as v5RoleHash } from './roleHash.js';
 export { supportInterfaceIds as v5SupportInterfaceIds } from './supportInterfaceIds.js';
 export { c as v5Contracts } from '../contracts-BaIGKzNt.js';
 export { computeInterfaceId as v5ComputeInterfaceId, encodeInitParams as v5EncodeInitParams, getEventFromReceipt as v5GetEventFromReceipt } from './utils.js';
-export { constants, utils, utils as v5Utils } from '@tradetrust-tt/token-registry-v4';
+export { constants, utils, utils as v5Utils } from '@tradetrust-tt/token-registry-v5';
 export { TypedContractMethod } from '@tradetrust-tt/token-registry-v5/contracts/common';
 import '@tradetrust-tt/token-registry-v5/contracts';
-import '@tradetrust-tt/token-registry-v5';

package/dist/types/utils/ethers/index.d.ts

@@ -1,8 +1,9 @@
-import { ethers as ethers$1 } from 'ethers';
-import { ethers } from 'ethersV6';
-import { Provider } from '@ethersproject/abstract-provider';
+import { Provider, Contract as Contract$1, ContractFactory as ContractFactory$1 } from 'ethersV6';
+import { providers, Contract, ContractFactory } from 'ethers';
 
+type ProviderV5 = providers.Provider;
 declare const isV6EthersProvider: (provider: any) => boolean;
-declare const getEthersContractFromProvider: (provider: Provider | ethers.Provider) => typeof ethers$1.Contract | typeof ethers.Contract;
+declare const getEthersContractFromProvider: (provider: ProviderV5 | Provider) => typeof Contract | typeof Contract$1;
+declare const getEthersContractFactoryFromProvider: (provider: ProviderV5 | Provider) => typeof ContractFactory | typeof ContractFactory$1;
 
-export { getEthersContractFromProvider, isV6EthersProvider };
+export { getEthersContractFactoryFromProvider, getEthersContractFromProvider, isV6EthersProvider };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trustvc/trustvc",
-  "version": "2.7.0",
+  "version": "2.9.0",
   "description": "TrustVC library",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/dist/types/document-store/deploy.d.ts

@@ -1,29 +0,0 @@
-import { Signer as Signer$1, ContractTransactionReceipt } from 'ethersV6';
-import { Signer, ContractReceipt } from 'ethers';
-import { CHAIN_ID } from '../utils/supportedChains/index.js';
-import { GasValue } from '../token-registry-functions/types.js';
-import '../utils/gasStation/index.js';
-import '../utils/network/index.js';
-
-/**
- * Deploys a new DocumentStore contract.
- * Supports both Ethers v5 and v6 signers.
- * @param {string} storeName - The name of the document store.
- * @param {string} owner - The owner address of the document store.
- * @param {SignerV5 | SignerV6} signer - Signer instance (Ethers v5 or v6) that authorizes the deployment.
- * @param {DeployOptions} options - Optional transaction metadata including gas values and chain ID.
- * @returns {Promise<TransactionReceipt>} A promise resolving to the deployed contract address and transaction hash.
- * @throws {Error} If the signer provider is not provided.
- * @throws {Error} If the store name or owner address is not provided.
- * @throws {Error} If deployment fails.
- */
-interface DeployOptions {
-    chainId?: CHAIN_ID;
-    maxFeePerGas?: GasValue;
-    maxPriorityFeePerGas?: GasValue;
-    isTransferable?: boolean;
-}
-type TransactionReceipt = ContractReceipt | ContractTransactionReceipt;
-declare const deployDocumentStore: (storeName: string, owner: string, signer: Signer | Signer$1, options?: DeployOptions) => Promise<TransactionReceipt>;
-
-export { type DeployOptions, type TransactionReceipt, deployDocumentStore };