emblem-vault-sdk 2.9.0 → 2.9.2

package/src/types.ts

@@ -27,6 +27,14 @@ export type Collection = {
     balanceCheckers: string[] | null;
     tokenIdScheme: string | null;
     generateVaultBody: Function;
+    /**
+     * Returns a template ready to send to the create vault API
+     *
+     * @param {FillCreateVaultTemplateArgs} args - Arguments to fill the template
+     * @param {_this: Collection} _this - The collection context
+     * @returns {Object} - Filled create vault template
+     */
+    fillCreateVaultTemplate: (args: FillCreateVaultTemplateArgs, _this: Collection) => Object;
     generateCreateTemplate: Function;
 };
 
@@ -142,3 +150,91 @@ export type Ownership = {
 }
 
 export type CuratedCollectionsResponse = Collection[];
+
+// ============================================================================
+// Remote Signer Types (for EmblemVaultClient integration)
+// ============================================================================
+
+export type ChainIdentifier = number | 'solana';
+
+export type ProgressCallback = (message: string, data?: unknown) => void;
+
+export interface MintResult {
+    txHash: string;
+    tokenId: string;
+    chainId: ChainIdentifier;
+}
+
+export interface ClaimResult {
+    phrase?: string;
+    privateKey?: string;
+}
+
+export interface RemoteMintSignature {
+    _nftAddress: string;
+    _price: { hex: string } | string | number;
+    _to: string;
+    _tokenId: { hex: string } | string | number;
+    _nonce: { hex: string } | string | number;
+    _signature: string;
+    serialNumber: string;
+    error?: string;
+}
+
+export interface RemoteUnvaultSignature {
+    success: boolean;
+    _nftAddress: string;
+    _tokenId: { hex: string } | string | number;
+    _nonce: { hex: string } | string | number;
+    _price: { hex: string } | string | number;
+    _timestamp: { hex: string } | string | number;
+    _signature: string;
+    msg?: string;
+    err?: string;
+}
+
+// ============================================================================
+// EVM Signer Interface (matches emblem-vault-ai-signers EmblemEthersWallet)
+// ============================================================================
+
+export interface EvmSigner {
+    getAddress(): Promise<string>;
+    signMessage(message: string | Uint8Array): Promise<string>;
+    sendTransaction(tx: unknown): Promise<{ hash: string; wait(): Promise<unknown> }>;
+    setChainId?(chainId: number): void;
+}
+
+// ============================================================================
+// EmblemVaultClient Interface - matches emblem-vault-ai-signers
+// ============================================================================
+
+export interface EmblemVaultClient {
+    toEthersWallet(provider?: unknown): Promise<EvmSigner>;
+}
+
+// ============================================================================
+// SDK Context for operations modules
+// ============================================================================
+
+export interface SdkContext {
+    apiKey: string;
+    baseUrl: string;
+    v3Url: string;
+    sigUrl: string;
+    fetchMetadata: (tokenId: string, callback?: ProgressCallback) => Promise<MetaData>;
+    requestRemoteKey: (tokenId: string, jwt: unknown, callback?: ProgressCallback) => Promise<unknown>;
+    decryptVaultKeys: (tokenId: string, dkeys: unknown, callback?: ProgressCallback) => Promise<ClaimResult>;
+}
+
+export interface FillCreateVaultTemplateArgs {
+    fromAddress: string,
+    toAddress: string,
+    targetAsset: {
+        name: string,
+        image: string,
+        description?: string,
+        ownedImage?: string,
+        projectName?: string
+    },
+    chainId: number,
+}

package/src/utils.ts

@@ -1,5 +1,5 @@
 import CryptoJS from 'crypto-js'
-import { MetaData } from "./types";
+import { MetaData, FillCreateVaultTemplateArgs } from "./types";
 import metadataJson from './curated/metadata.json';
 import darkfarmsMetadataJson from './curated/darkfarms-metadata.json';
 import dot_idMetadataJson from './curated/dot_id.json';
@@ -552,6 +552,40 @@ export function generateTemplate(record: any) {
             
             return nameAndImage
         },
+        fillCreateVaultTemplate: (args: FillCreateVaultTemplateArgs, _this: any) => {
+            const template = _this.generateCreateTemplate(_this)
+
+            if (args.fromAddress) {
+                template.fromAddress = args.fromAddress
+            } else {
+                throw new Error("fromAddress is required to create vault")
+            }
+
+            if (args.toAddress) {
+                template.toAddress = args.toAddress
+            } else {
+                throw new Error("toAddress is required to create vault")
+            }
+
+            if (args.chainId) {
+                const chainIdAsString = String(args.chainId)
+                template.targetContract = {
+                    name: template.targetContract.name,
+                    [chainIdAsString]: template.targetContract[chainIdAsString]
+                }
+                template.chainId = args.chainId
+            } else {
+                throw new Error("chainId is required to create vault")
+            }
+
+            if (args.targetAsset) {
+                Object.assign(template.targetAsset, args.targetAsset)
+            } else {
+                template.targetAsset = undefined
+            }
+
+            return template
+        },
         generateCreateTemplate: (_this: any) =>{
             let template = {
                 fromAddress: { type: "user-provided" },
@@ -914,4 +948,9 @@ export async function signPSBT(psbtBase64: any, paymentAddress: any, indexes: nu
     });
 }
 
-
+export function parseBigIntValue(value: unknown): bigint {
+    if (typeof value === 'object' && value !== null && 'hex' in value) {
+        return BigInt((value as { hex: string }).hex);
+    }
+    return BigInt(String(value));
+}

package/src/vault-utils.ts

@@ -0,0 +1,89 @@
+import { ChainConfig, SUPPORTED_CHAINS } from "./constants";
+
+export function isV2Vault(metadata: { targetContract?: { name?: string } }): boolean {
+    return Boolean(metadata.targetContract?.name);
+}
+
+export function requiresOnChainUnvault(metadata: { status?: string; sealed?: boolean; live?: boolean }): boolean {
+    return metadata.status === 'unclaimed' && !metadata.sealed && Boolean(metadata.live);
+}
+
+/**
+ * Get the claim identifier for signing claim messages.
+ * This MUST match VaultActions.vue's getSerialNumber() logic:
+ * - ERC1155: use targetContract.serialNumber
+ * - ERC721a: use tokenId
+ * - Legacy: use tokenId
+ */
+export function getClaimIdentifier(metadata: { 
+    ownershipInfo?: { 
+        serialNumber?: string; 
+        category?: string;
+    }; 
+    tokenId?: string;
+    targetContract?: {
+        serialNumber?: string;
+        collectionType?: string;
+        tokenId?: string;
+    };
+}): string {
+    const { targetContract, ownershipInfo, tokenId } = metadata;
+    
+    // If no targetContract, fallback to tokenId
+    if (!targetContract) {
+        return tokenId || '';
+    }
+    
+    // ERC1155: use serialNumber
+    if (
+        targetContract.collectionType === 'ERC1155' ||
+        ownershipInfo?.category === 'erc1155'
+    ) {
+        return targetContract.serialNumber || tokenId || '';
+    }
+    
+    // ERC721a: use tokenId (NOT serialNumber!)
+    if (
+        targetContract.collectionType === 'ERC721a' ||
+        ownershipInfo?.category === 'erc721a'
+    ) {
+        return tokenId || '';
+    }
+    
+    // Default: use targetContract.tokenId or tokenId
+    return targetContract.tokenId || tokenId || '';
+}
+
+export function getHandlerContractAddress(chainId: number): string {
+    const config = getChainConfig(chainId);
+    if (!config.handlerContract) {
+        throw new Error(`No handler contract configured for chain ${chainId}`);
+    }
+    return config.handlerContract;
+}
+
+export function getUnvaultingContractAddress(chainId: number): string {
+    const config = getChainConfig(chainId);
+    if (!config.unvaultingContract) {
+        throw new Error(`No unvaulting contract configured for chain ${chainId}`);
+    }
+    return config.unvaultingContract;
+}
+
+export function getChainConfig(chainId: number | string): ChainConfig {
+    const config = SUPPORTED_CHAINS[chainId];
+    if (!config) {
+        const supportedList = Object.entries(SUPPORTED_CHAINS)
+            .map(([id, cfg]) => `${cfg.name} (${id})`)
+            .join(', ');
+        throw new Error(
+            `Unsupported chain: ${chainId}. Supported chains: ${supportedList}`
+        );
+    }
+    return config;
+}
+
+export function isEvmChain(chainId: number | string): boolean {
+    const config = SUPPORTED_CHAINS[chainId];
+    return config?.type === 'evm';
+}

package/types/constants.d.ts

@@ -0,0 +1,17 @@
+export declare const ETHEREUM_MAINNET_CHAIN_ID = 1;
+export declare const POLYGON_MAINNET_CHAIN_ID = 137;
+export declare const SOLANA_CHAIN_IDENTIFIER = "solana";
+export type ChainType = 'evm' | 'solana';
+export interface ChainConfig {
+    type: ChainType;
+    name: string;
+    handlerContract?: string;
+    unvaultingContract?: string;
+}
+export declare const SUPPORTED_CHAINS: Record<number | string, ChainConfig>;
+export declare const HANDLER_CONTRACT_ADDRESS = "0x23859b51117dbFBcdEf5b757028B18d7759a4460";
+export declare const UNVAULTING_DIAMOND_ADDRESS = "0x214C964bBd3640971E111d3a994CbB89b296a9ad";
+export declare const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
+export declare const EMBLEM_API_V2 = "https://v2.emblemvault.io";
+export declare const EMBLEM_API_2 = "https://api2.emblemvault.io";
+export declare const TORUS_SIGNER_API = "https://tor-us-signer-coval.vercel.app";

package/types/derive.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 declare global {
     interface Window {
         bitcoin: any;

package/types/evm-operations.d.ts

@@ -0,0 +1,4 @@
+import type { EmblemVaultClient, ProgressCallback, MintResult, ClaimResult, MetaData, SdkContext } from './types';
+export declare function performMintEvm(ctx: SdkContext, client: EmblemVaultClient, tokenId: string, chainId: number, callback?: ProgressCallback): Promise<MintResult>;
+export declare function performClaimEvm(ctx: SdkContext, client: EmblemVaultClient, tokenId: string, chainId: number, metadata: MetaData, claimIdentifier: string, vaultIsV2: boolean, needsOnChainUnvault: boolean, callback?: ProgressCallback): Promise<ClaimResult>;
+export declare function deleteVaultEvm(client: EmblemVaultClient, tokenId: string, chainId: number, callback?: ProgressCallback): Promise<boolean>;

package/types/index.d.ts

@@ -1,5 +1,5 @@
 import { BigNumber } from '@ethersproject/bignumber';
-import { Collection, CuratedCollectionsResponse, MetaData, Ownership, Vault } from './types';
+import type { Collection, CuratedCollectionsResponse, MetaData, Ownership, Vault, ProgressCallback, MintResult, ClaimResult, EmblemVaultClient } from './types';
 declare class EmblemVaultSDK {
     private apiKey;
     private baseUrl;
@@ -45,6 +45,10 @@ declare class EmblemVaultSDK {
     refreshLegacyOwnership(web3: any, address: string): Promise<void>;
     checkLiveliness(tokenId: string, chainId?: number): Promise<any>;
     checkLivelinessBulk(tokenIds: string[], chainId?: number): Promise<any[]>;
+    private getSdkContext;
+    performMintChainWithClient(client: EmblemVaultClient, tokenId: string, chainId?: number | 'solana', callback?: ProgressCallback): Promise<MintResult>;
+    performClaimChainWithClient(client: EmblemVaultClient, tokenId: string, chainId?: number | 'solana', callback?: ProgressCallback): Promise<ClaimResult>;
+    deleteVaultWithClient(client: EmblemVaultClient, tokenId: string, chainId?: number | 'solana', callback?: ProgressCallback): Promise<boolean>;
     sweepVaultUsingPhrase(phrase: string, satsPerByte?: number, broadcast?: boolean): Promise<unknown>;
 }
 declare global {

package/types/signing-messages.d.ts

@@ -0,0 +1,4 @@
+export declare function buildMintMessage(tokenId: string): string;
+export declare function buildClaimMessage(identifier: string, isV2Vault: boolean): string;
+export declare function buildUnvaultMessage(identifier: string): string;
+export declare function buildDeleteMessage(tokenId: string): string;

package/types/types.d.ts

@@ -26,6 +26,14 @@ export type Collection = {
     balanceCheckers: string[] | null;
     tokenIdScheme: string | null;
     generateVaultBody: Function;
+    /**
+     * Returns a template ready to send to the create vault API
+     *
+     * @param {FillCreateVaultTemplateArgs} args - Arguments to fill the template
+     * @param {_this: Collection} _this - The collection context
+     * @returns {Object} - Filled create vault template
+     */
+    fillCreateVaultTemplate: (args: FillCreateVaultTemplateArgs, _this: Collection) => Object;
     generateCreateTemplate: Function;
 };
 export interface MetaData {
@@ -133,3 +141,82 @@ export type Ownership = {
     network: string;
 };
 export type CuratedCollectionsResponse = Collection[];
+export type ChainIdentifier = number | 'solana';
+export type ProgressCallback = (message: string, data?: unknown) => void;
+export interface MintResult {
+    txHash: string;
+    tokenId: string;
+    chainId: ChainIdentifier;
+}
+export interface ClaimResult {
+    phrase?: string;
+    privateKey?: string;
+}
+export interface RemoteMintSignature {
+    _nftAddress: string;
+    _price: {
+        hex: string;
+    } | string | number;
+    _to: string;
+    _tokenId: {
+        hex: string;
+    } | string | number;
+    _nonce: {
+        hex: string;
+    } | string | number;
+    _signature: string;
+    serialNumber: string;
+    error?: string;
+}
+export interface RemoteUnvaultSignature {
+    success: boolean;
+    _nftAddress: string;
+    _tokenId: {
+        hex: string;
+    } | string | number;
+    _nonce: {
+        hex: string;
+    } | string | number;
+    _price: {
+        hex: string;
+    } | string | number;
+    _timestamp: {
+        hex: string;
+    } | string | number;
+    _signature: string;
+    msg?: string;
+    err?: string;
+}
+export interface EvmSigner {
+    getAddress(): Promise<string>;
+    signMessage(message: string | Uint8Array): Promise<string>;
+    sendTransaction(tx: unknown): Promise<{
+        hash: string;
+        wait(): Promise<unknown>;
+    }>;
+    setChainId?(chainId: number): void;
+}
+export interface EmblemVaultClient {
+    toEthersWallet(provider?: unknown): Promise<EvmSigner>;
+}
+export interface SdkContext {
+    apiKey: string;
+    baseUrl: string;
+    v3Url: string;
+    sigUrl: string;
+    fetchMetadata: (tokenId: string, callback?: ProgressCallback) => Promise<MetaData>;
+    requestRemoteKey: (tokenId: string, jwt: unknown, callback?: ProgressCallback) => Promise<unknown>;
+    decryptVaultKeys: (tokenId: string, dkeys: unknown, callback?: ProgressCallback) => Promise<ClaimResult>;
+}
+export interface FillCreateVaultTemplateArgs {
+    fromAddress: string;
+    toAddress: string;
+    targetAsset: {
+        name: string;
+        image: string;
+        description?: string;
+        ownedImage?: string;
+        projectName?: string;
+    };
+    chainId: number;
+}

package/types/utils.d.ts

@@ -40,4 +40,5 @@ interface SatsConnectAddress {
 }
 export declare function getSatsConnectAddress(): Promise<SatsConnectAddress>;
 export declare function signPSBT(psbtBase64: any, paymentAddress: any, indexes: number[], broadcast?: boolean): Promise<unknown>;
+export declare function parseBigIntValue(value: unknown): bigint;
 export {};

package/types/vault-utils.d.ts

@@ -0,0 +1,34 @@
+import { ChainConfig } from "./constants";
+export declare function isV2Vault(metadata: {
+    targetContract?: {
+        name?: string;
+    };
+}): boolean;
+export declare function requiresOnChainUnvault(metadata: {
+    status?: string;
+    sealed?: boolean;
+    live?: boolean;
+}): boolean;
+/**
+ * Get the claim identifier for signing claim messages.
+ * This MUST match VaultActions.vue's getSerialNumber() logic:
+ * - ERC1155: use targetContract.serialNumber
+ * - ERC721a: use tokenId
+ * - Legacy: use tokenId
+ */
+export declare function getClaimIdentifier(metadata: {
+    ownershipInfo?: {
+        serialNumber?: string;
+        category?: string;
+    };
+    tokenId?: string;
+    targetContract?: {
+        serialNumber?: string;
+        collectionType?: string;
+        tokenId?: string;
+    };
+}): string;
+export declare function getHandlerContractAddress(chainId: number): string;
+export declare function getUnvaultingContractAddress(chainId: number): string;
+export declare function getChainConfig(chainId: number | string): ChainConfig;
+export declare function isEvmChain(chainId: number | string): boolean;

package/utils/emblem-site-metadata.json

@@ -668164,7 +668164,7 @@
       "lastPrice": 1314.8618656640904
     },
     "projectProtocol": "Counterparty",
-    "video": "https://arweave.net/Fb7BMNWJQwNCrRxdw_dbMC01t6iSVUytBtg5LziOOlI/2o51ir_video.mp4\\"
+    "video": "https://arweave.net/Fb7BMNWJQwNCrRxdw_dbMC01t6iSVUytBtg5LziOOlI/2o51ir_video.mp4"
   },
   "DGAPEPE": {
     "image": "https://raw.githubusercontent.com/EmblemCompany/vaultImages/master/collection/fake-rares/DGAPEPE.gif",

package/utils/sdk-metadata.json

@@ -668143,7 +668143,7 @@
       "price": 1040.9323103174047,
       "lastPrice": 1314.8618656640904
     },
-    "video": "https://arweave.net/Fb7BMNWJQwNCrRxdw_dbMC01t6iSVUytBtg5LziOOlI/2o51ir_video.mp4\\",
+    "video": "https://arweave.net/Fb7BMNWJQwNCrRxdw_dbMC01t6iSVUytBtg5LziOOlI/2o51ir_video.mp4",
     "projectProtocol": "Counterparty"
   },
   "DGAPEPE": {