@trustvc/trustvc 2.6.1 → 2.7.0

package/dist/esm/document-store/tt-document-store-abi.js

@@ -0,0 +1,229 @@
+const TT_DOCUMENT_STORE_ABI = [
+  // TODO: Replace with the actual full ABI
+  // Minimal ABI for issue function (0x0f75e81f)
+  {
+    inputs: [
+      { internalType: "string", name: "_name", type: "string" },
+      { internalType: "address", name: "owner", type: "address" }
+    ],
+    stateMutability: "nonpayable",
+    type: "constructor"
+  },
+  {
+    anonymous: false,
+    inputs: [{ indexed: true, internalType: "bytes32", name: "document", type: "bytes32" }],
+    name: "DocumentIssued",
+    type: "event"
+  },
+  {
+    anonymous: false,
+    inputs: [{ indexed: true, internalType: "bytes32", name: "document", type: "bytes32" }],
+    name: "DocumentRevoked",
+    type: "event"
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, internalType: "bytes32", name: "role", type: "bytes32" },
+      { indexed: true, internalType: "bytes32", name: "previousAdminRole", type: "bytes32" },
+      { indexed: true, internalType: "bytes32", name: "newAdminRole", type: "bytes32" }
+    ],
+    name: "RoleAdminChanged",
+    type: "event"
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, internalType: "bytes32", name: "role", type: "bytes32" },
+      { indexed: true, internalType: "address", name: "account", type: "address" },
+      { indexed: true, internalType: "address", name: "sender", type: "address" }
+    ],
+    name: "RoleGranted",
+    type: "event"
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, internalType: "bytes32", name: "role", type: "bytes32" },
+      { indexed: true, internalType: "address", name: "account", type: "address" },
+      { indexed: true, internalType: "address", name: "sender", type: "address" }
+    ],
+    name: "RoleRevoked",
+    type: "event"
+  },
+  {
+    inputs: [],
+    name: "DEFAULT_ADMIN_ROLE",
+    outputs: [{ internalType: "bytes32", name: "", type: "bytes32" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [],
+    name: "ISSUER_ROLE",
+    outputs: [{ internalType: "bytes32", name: "", type: "bytes32" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [],
+    name: "REVOKER_ROLE",
+    outputs: [{ internalType: "bytes32", name: "", type: "bytes32" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [{ internalType: "bytes32[]", name: "documents", type: "bytes32[]" }],
+    name: "bulkIssue",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function"
+  },
+  {
+    inputs: [{ internalType: "bytes32[]", name: "documents", type: "bytes32[]" }],
+    name: "bulkRevoke",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function"
+  },
+  {
+    inputs: [{ internalType: "bytes32", name: "", type: "bytes32" }],
+    name: "documentIssued",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [{ internalType: "bytes32", name: "", type: "bytes32" }],
+    name: "documentRevoked",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [{ internalType: "bytes32", name: "document", type: "bytes32" }],
+    name: "getIssuedBlock",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [{ internalType: "bytes32", name: "role", type: "bytes32" }],
+    name: "getRoleAdmin",
+    outputs: [{ internalType: "bytes32", name: "", type: "bytes32" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [
+      { internalType: "bytes32", name: "role", type: "bytes32" },
+      { internalType: "address", name: "account", type: "address" }
+    ],
+    name: "grantRole",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function"
+  },
+  {
+    inputs: [
+      { internalType: "bytes32", name: "role", type: "bytes32" },
+      { internalType: "address", name: "account", type: "address" }
+    ],
+    name: "hasRole",
+    outputs: [{ internalType: "bool", name: "", type: "bool" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [{ internalType: "bytes32", name: "document", type: "bytes32" }],
+    name: "isIssued",
+    outputs: [{ internalType: "bool", name: "", type: "bool" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [
+      { internalType: "bytes32", name: "document", type: "bytes32" },
+      { internalType: "uint256", name: "blockNumber", type: "uint256" }
+    ],
+    name: "isIssuedBefore",
+    outputs: [{ internalType: "bool", name: "", type: "bool" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [{ internalType: "bytes32", name: "document", type: "bytes32" }],
+    name: "isRevoked",
+    outputs: [{ internalType: "bool", name: "", type: "bool" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [
+      { internalType: "bytes32", name: "document", type: "bytes32" },
+      { internalType: "uint256", name: "blockNumber", type: "uint256" }
+    ],
+    name: "isRevokedBefore",
+    outputs: [{ internalType: "bool", name: "", type: "bool" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [{ internalType: "bytes32", name: "document", type: "bytes32" }],
+    name: "issue",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function"
+  },
+  {
+    inputs: [],
+    name: "name",
+    outputs: [{ internalType: "string", name: "", type: "string" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [
+      { internalType: "bytes32", name: "role", type: "bytes32" },
+      { internalType: "address", name: "account", type: "address" }
+    ],
+    name: "renounceRole",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function"
+  },
+  {
+    inputs: [{ internalType: "bytes32", name: "document", type: "bytes32" }],
+    name: "revoke",
+    outputs: [{ internalType: "bool", name: "", type: "bool" }],
+    stateMutability: "nonpayable",
+    type: "function"
+  },
+  {
+    inputs: [
+      { internalType: "bytes32", name: "role", type: "bytes32" },
+      { internalType: "address", name: "account", type: "address" }
+    ],
+    name: "revokeRole",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function"
+  },
+  {
+    inputs: [{ internalType: "bytes4", name: "interfaceId", type: "bytes4" }],
+    name: "supportsInterface",
+    outputs: [{ internalType: "bool", name: "", type: "bool" }],
+    stateMutability: "view",
+    type: "function"
+  },
+  {
+    inputs: [],
+    name: "version",
+    outputs: [{ internalType: "string", name: "", type: "string" }],
+    stateMutability: "view",
+    type: "function"
+  }
+  // Add other functions from the ABI here (name, isIssued, isRevoked, etc.)
+];
+
+export { TT_DOCUMENT_STORE_ABI };

package/dist/esm/index.js

@@ -1,5 +1,6 @@
 export { v4ComputeInterfaceId, v4ComputeTitleEscrowAddress, v4ContractAddress, v4Contracts, v4EncodeInitParams, v4GetEventFromReceipt, v4RoleHash, v4SupportInterfaceIds, v4Utils } from './token-registry-v4';
 export { v5ComputeInterfaceId, v5ContractAddress, v5Contracts, v5EncodeInitParams, v5GetEventFromReceipt, v5RoleHash, v5SupportInterfaceIds, v5Utils } from './token-registry-v5';
+export { DocumentStore__factory, TransferableDocumentStore__factory, deployDocumentStore, documentStoreIssue, documentStoreRevoke } from './document-store';
 export * from './token-registry-functions';
 export * from './core';
 export * from './open-attestation';

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

@@ -0,0 +1,14 @@
+declare const contractInterfaces: {
+    /**
+     * IDocumentStore interface functions
+     * Functions: isActive, isIssued, isRevoked, name, revoke
+     */
+    DocumentStore: string[];
+    /**
+     * ITransferableDocumentStore interface functions
+     * Functions: isActive, isIssued, isRevoked, issue, name, revoke
+     */
+    TransferableDocumentStore: string[];
+};
+
+export { contractInterfaces };

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

@@ -0,0 +1,29 @@
+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 };

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

@@ -0,0 +1,14 @@
+import { Provider } from 'ethersV6';
+import { providers } from 'ethers';
+import { CHAIN_ID } from '../utils/supportedChains/index.js';
+import '../utils/gasStation/index.js';
+import '../utils/network/index.js';
+
+interface CallOptions {
+    chainId?: CHAIN_ID;
+    provider?: Provider | providers.Provider;
+}
+declare const getRoleString: (documentStoreAddress: string, role: string, options?: CallOptions) => Promise<string>;
+declare const rolesList: string[];
+
+export { getRoleString, rolesList };

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

@@ -0,0 +1,11 @@
+export { IssueOptions, documentStoreIssue } from './issue.js';
+export { RevokeOptions, documentStoreRevoke } from './revoke.js';
+export { DeployOptions, deployDocumentStore } from './deploy.js';
+export { supportInterfaceIds } from './supportInterfaceIds.js';
+export { DocumentStore__factory, TransferableDocumentStore__factory } from '@trustvc/document-store';
+import 'ethersV6';
+import 'ethers';
+import '../utils/supportedChains/index.js';
+import '../utils/gasStation/index.js';
+import '../utils/network/index.js';
+import '../token-registry-functions/types.js';

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

@@ -0,0 +1,32 @@
+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 '../utils/gasStation/index.js';
+import '../utils/network/index.js';
+
+/**
+ * Issues a document hash to 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} 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.
+ * @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>;
+
+export { type IssueOptions, documentStoreIssue };

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

@@ -0,0 +1,32 @@
+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 '../utils/gasStation/index.js';
+import '../utils/network/index.js';
+
+/**
+ * Revokes a document hash from 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} documentHash - The hash of the document to revoke (must be a valid hex string).
+ * @param {SignerV5 | SignerV6} signer - Signer instance (Ethers v5 or v6) that authorizes the revoke transaction.
+ * @param {RevokeOptions} options - Optional transaction metadata including gas values and chain ID.
+ * @returns {Promise<ContractTransactionV5 | ContractTransactionV6>} A promise resolving to the transaction result from the revoke 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.revoke` fails as a pre-check.
+ */
+interface RevokeOptions {
+    chainId?: CHAIN_ID;
+    maxFeePerGas?: GasValue;
+    maxPriorityFeePerGas?: GasValue;
+    isTransferable?: boolean;
+}
+declare const documentStoreRevoke: (documentStoreAddress: string, documentHash: string, signer: Signer | Signer$1, options?: RevokeOptions) => Promise<ContractTransaction | ContractTransactionResponse>;
+
+export { type RevokeOptions, documentStoreRevoke };

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

@@ -0,0 +1,16 @@
+declare const supportInterfaceIds: {
+    /**
+     * IDocumentStore interface ID
+     * Functions: isActive, isIssued, isRevoked, name, revoke
+     * Computed: 0xb9391097
+     */
+    IDocumentStore: string;
+    /**
+     * ITransferableDocumentStore interface ID
+     * Functions: isActive, isIssued, isRevoked, issue, name, revoke
+     * Computed: 0xc2cb4227
+     */
+    ITransferableDocumentStore: string;
+};
+
+export { supportInterfaceIds };