@veridex/sdk 1.0.0-beta.1

package/dist/types.d.mts

@@ -0,0 +1,407 @@
+/**
+ * Veridex Protocol SDK - Type Definitions
+ */
+interface VeridexConfig {
+    hubChainId: number;
+    hubRpcUrl: string;
+    hubContractAddress: string;
+    relayerUrl?: string;
+}
+interface ChainConfig {
+    name: string;
+    chainId: number;
+    wormholeChainId: number;
+    hubChainId?: number;
+    rpcUrl: string;
+    explorerUrl: string;
+    isEvm: boolean;
+    contracts: {
+        hub?: string;
+        vaultFactory?: string;
+        vaultImplementation?: string;
+        wormholeCoreBridge: string;
+        tokenBridge?: string;
+    };
+}
+interface PasskeyCredential {
+    credentialId: string;
+    publicKeyX: bigint;
+    publicKeyY: bigint;
+    keyHash: string;
+}
+interface WebAuthnSignature {
+    authenticatorData: string;
+    clientDataJSON: string;
+    challengeIndex: number;
+    typeIndex: number;
+    r: bigint;
+    s: bigint;
+}
+interface TransferParams {
+    targetChain: number;
+    token: string;
+    recipient: string;
+    amount: bigint;
+}
+interface ExecuteParams {
+    targetChain: number;
+    target: string;
+    value: bigint;
+    data: string;
+}
+interface BridgeParams {
+    sourceChain: number;
+    token: string;
+    amount: bigint;
+    destinationChain: number;
+    recipient: string;
+}
+interface DispatchResult {
+    transactionHash: string;
+    sequence: bigint;
+    userKeyHash: string;
+    targetChain: number;
+}
+interface TransferAction {
+    type: 'transfer';
+    token: string;
+    recipient: string;
+    amount: bigint;
+}
+interface BridgeAction {
+    type: 'bridge';
+    token: string;
+    amount: bigint;
+    targetChain: number;
+    recipient: string;
+}
+/**
+ * Wormhole Query proof for optimistic execution
+ * Allows ~5-7 second latency vs ~120+ seconds for VAA
+ */
+interface QueryProof {
+    /** Raw query response bytes from Wormhole Guardians */
+    queryResponse: string;
+    /** Guardian signatures (13/19 quorum) */
+    signatures: string;
+}
+/**
+ * User preference for execution path
+ */
+type ExecutionPath = 'query' | 'vaa' | 'auto';
+/**
+ * Result from query-based submission
+ */
+interface QuerySubmissionResult {
+    /** Whether submission succeeded */
+    success: boolean;
+    /** Transaction hash on spoke chain */
+    txHash?: string;
+    /** Execution path used ('query' or 'vaa') */
+    path: ExecutionPath;
+    /** Latency in milliseconds */
+    latencyMs?: number;
+    /** Error message if failed */
+    error?: string;
+    /** Whether fallback to VAA was triggered */
+    fellBack?: boolean;
+}
+/**
+ * Session key structure for temporary authentication
+ * Enables native L1 speed for repeat transactions without biometric auth
+ */
+interface SessionKey {
+    /** Hash of the temporary session public key */
+    sessionKeyHash: string;
+    /** Unix timestamp when session expires */
+    expiry: number;
+    /** Maximum transaction value for this session (0 = unlimited) */
+    maxValue: bigint;
+    /** Whether session was manually revoked */
+    revoked: boolean;
+}
+/**
+ * Result from session validation query
+ */
+interface SessionValidationResult {
+    /** Whether session is currently active */
+    active: boolean;
+    /** Session expiry timestamp (0 if inactive) */
+    expiry: number;
+    /** Maximum transaction value (0 if inactive) */
+    maxValue: bigint;
+    /** Index in sessions array */
+    sessionIndex: number;
+}
+/**
+ * Parameters for registering a new session
+ */
+interface RegisterSessionParams {
+    /** Signature for Passkey authentication */
+    signature: WebAuthnSignature;
+    /** User's Passkey public key X coordinate */
+    publicKeyX: bigint;
+    /** User's Passkey public key Y coordinate */
+    publicKeyY: bigint;
+    /** Hash of the temporary session public key */
+    sessionKeyHash: string;
+    /** Session duration in seconds (max 24 hours) */
+    duration: number;
+    /** Maximum transaction value (0 = unlimited) */
+    maxValue: bigint;
+    /** Whether to require user verification */
+    requireUV: boolean;
+}
+/**
+ * Parameters for revoking a session
+ */
+interface RevokeSessionParams {
+    /** Signature for Passkey authentication */
+    signature: WebAuthnSignature;
+    /** User's Passkey public key X coordinate */
+    publicKeyX: bigint;
+    /** User's Passkey public key Y coordinate */
+    publicKeyY: bigint;
+    /** Hash of the session key to revoke */
+    sessionKeyHash: string;
+    /** Whether to require user verification */
+    requireUV: boolean;
+}
+/**
+ * Identity state for multi-key management
+ * First passkey registered becomes the immutable identity root
+ */
+interface IdentityState {
+    /** Identity key hash (first passkey's keyHash) */
+    identity: string;
+    /** Number of authorized keys */
+    keyCount: number;
+    /** Maximum allowed keys per identity */
+    maxKeys: number;
+    /** Whether the specified key is the root identity */
+    isRoot: boolean;
+}
+/**
+ * Result from registering a backup passkey
+ */
+interface AddBackupKeyResult {
+    /** Transaction hash on Hub chain */
+    transactionHash: string;
+    /** Wormhole sequence number for cross-chain sync */
+    sequence: bigint;
+    /** The identity the key was added to */
+    identity: string;
+    /** The new key hash that was added */
+    newKeyHash: string;
+    /** Total number of keys after addition */
+    keyCount: number;
+}
+/**
+ * Result from removing a passkey
+ */
+interface RemoveKeyResult {
+    /** Transaction hash on Hub chain */
+    transactionHash: string;
+    /** Wormhole sequence number for cross-chain sync */
+    sequence: bigint;
+    /** The identity the key was removed from */
+    identity: string;
+    /** The key hash that was removed */
+    removedKeyHash: string;
+    /** Remaining number of keys after removal */
+    keyCount: number;
+}
+/**
+ * Authorized key information
+ */
+interface AuthorizedKey {
+    /** Key hash of the authorized passkey */
+    keyHash: string;
+    /** Whether this key is the root identity key */
+    isRoot: boolean;
+}
+/**
+ * Guardian configuration for an identity
+ */
+interface GuardianConfig {
+    /** Array of guardian key hashes */
+    guardians: string[];
+    /** Required approvals for recovery (M-of-N) */
+    threshold: bigint;
+    /** Whether guardians have been configured */
+    isConfigured: boolean;
+}
+/**
+ * Recovery status for an identity
+ */
+interface RecoveryStatus {
+    /** Whether a recovery is currently active */
+    isActive: boolean;
+    /** Proposed new owner key hash */
+    newOwnerKeyHash: string;
+    /** Timestamp when recovery was initiated */
+    initiatedAt: bigint;
+    /** Current number of guardian approvals */
+    approvalCount: bigint;
+    /** Required approvals for recovery */
+    threshold: bigint;
+    /** Timestamp when recovery can be executed (after timelock) */
+    canExecuteAt: bigint;
+    /** Timestamp when recovery expires */
+    expiresAt: bigint;
+}
+/**
+ * Result from setting up guardians
+ */
+interface SetupGuardiansResult {
+    /** Transaction hash on Hub chain */
+    transactionHash: string;
+    /** Wormhole sequence number for cross-chain sync */
+    sequence: bigint;
+    /** The identity guardians were set up for */
+    identity: string;
+    /** Array of guardian key hashes */
+    guardians: string[];
+    /** Required approvals for recovery */
+    threshold: bigint;
+}
+/**
+ * Result from adding a guardian
+ */
+interface AddGuardianResult {
+    /** Transaction hash on Hub chain */
+    transactionHash: string;
+    /** Wormhole sequence number for cross-chain sync */
+    sequence: bigint;
+    /** The identity the guardian was added to */
+    identity: string;
+    /** The guardian key hash that was added */
+    guardianKeyHash: string;
+}
+/**
+ * Result from removing a guardian
+ */
+interface RemoveGuardianResult {
+    /** Transaction hash on Hub chain */
+    transactionHash: string;
+    /** Wormhole sequence number for cross-chain sync */
+    sequence: bigint;
+    /** The identity the guardian was removed from */
+    identity: string;
+    /** The guardian key hash that was removed */
+    guardianKeyHash: string;
+}
+/**
+ * Result from initiating recovery
+ */
+interface InitiateRecoveryResult {
+    /** Transaction hash on Hub chain */
+    transactionHash: string;
+    /** Wormhole sequence number for cross-chain sync */
+    sequence: bigint;
+    /** The identity being recovered */
+    identity: string;
+    /** Proposed new owner key hash */
+    newOwnerKeyHash: string;
+    /** Timestamp when recovery can be executed */
+    canExecuteAt: bigint;
+}
+/**
+ * Result from approving recovery
+ */
+interface ApproveRecoveryResult {
+    /** Transaction hash on Hub chain */
+    transactionHash: string;
+    /** Wormhole sequence number for cross-chain sync */
+    sequence: bigint;
+    /** The identity being recovered */
+    identity: string;
+    /** The guardian who approved */
+    guardianKeyHash: string;
+    /** Current approval count */
+    approvalCount: bigint;
+    /** Required approvals */
+    threshold: bigint;
+}
+/**
+ * Result from executing recovery
+ */
+interface ExecuteRecoveryResult {
+    /** Transaction hash on Hub chain */
+    transactionHash: string;
+    /** Wormhole sequence number for cross-chain sync */
+    sequence: bigint;
+    /** The identity that was recovered */
+    identity: string;
+    /** The new owner key hash */
+    newOwnerKeyHash: string;
+}
+/**
+ * Result from cancelling recovery
+ */
+interface CancelRecoveryResult {
+    /** Transaction hash on Hub chain */
+    transactionHash: string;
+    /** Wormhole sequence number for cross-chain sync */
+    sequence: bigint;
+    /** The identity whose recovery was cancelled */
+    identity: string;
+}
+interface ExecuteAction {
+    type: 'execute';
+    target: string;
+    value: bigint;
+    data: string;
+}
+interface ConfigAction {
+    type: 'config';
+    configType: number;
+    configData: string;
+}
+type ActionPayload = TransferAction | BridgeAction | ExecuteAction | ConfigAction | {
+    type: string;
+    raw: string;
+};
+interface VAA {
+    version: number;
+    guardianSetIndex: number;
+    signatures: VAASignature[];
+    timestamp: number;
+    nonce: number;
+    emitterChain: number;
+    emitterAddress: string;
+    sequence: bigint;
+    consistencyLevel: number;
+    payload: string;
+    hash: string;
+}
+interface VAASignature {
+    guardianIndex: number;
+    signature: string;
+}
+interface VeridexPayload {
+    version: number;
+    userKeyHash: string;
+    targetChain: number;
+    nonce: bigint;
+    publicKeyX: bigint;
+    publicKeyY: bigint;
+    actionPayload: string;
+}
+interface VaultInfo {
+    address: string;
+    ownerKeyHash: string;
+    chain: string;
+    wormholeChainId: number;
+}
+interface TestResult {
+    success: boolean;
+    sourceChain: string;
+    targetChain: string;
+    txHash?: string;
+    vaaSequence?: bigint;
+    error?: string;
+    duration?: number;
+}
+
+export type { ActionPayload, AddBackupKeyResult, AddGuardianResult, ApproveRecoveryResult, AuthorizedKey, BridgeAction, BridgeParams, CancelRecoveryResult, ChainConfig, ConfigAction, DispatchResult, ExecuteAction, ExecuteParams, ExecuteRecoveryResult, ExecutionPath, GuardianConfig, IdentityState, InitiateRecoveryResult, PasskeyCredential, QueryProof, QuerySubmissionResult, RecoveryStatus, RegisterSessionParams, RemoveGuardianResult, RemoveKeyResult, RevokeSessionParams, SessionKey, SessionValidationResult, SetupGuardiansResult, TestResult, TransferAction, TransferParams, VAA, VAASignature, VaultInfo, VeridexConfig, VeridexPayload, WebAuthnSignature };