@campnetwork/origin 1.2.1 → 1.2.3

package/dist/react/index.esm.d.ts

@@ -168,6 +168,52 @@ declare function hasAccess(this: Origin, user: Address, tokenId: bigint): Promis
 
 declare function subscriptionExpiry(this: Origin, tokenId: bigint, user: Address): Promise<bigint>;
 
+/**
+ * Response from getDataWithX402 when payment is required
+ */
+interface X402Response {
+    error: string;
+    marketplaceAction?: {
+        kind: string;
+        contract: Address;
+        network: string;
+        chainId: number;
+        method: string;
+        payer: Address;
+        payTo: Address;
+        tokenId: string;
+        duration: number;
+        asset: Address;
+        amount: string;
+        amountFormatted: string;
+    };
+}
+interface TransactionResult {
+    txHash: string;
+    receipt?: any;
+}
+/**
+ * Settles an X402 payment response by purchasing access if needed.
+ * This method checks if the user already has access to the item, and if not,
+ * it calls buyAccess with the parameters from the X402 response.
+ * Supports viem WalletClient, ethers Signer, and custom signer implementations.
+ *
+ * @param x402Response - The response from getDataWithX402 containing payment details.
+ * @param signer - Optional signer object used to interact with the blockchain. If not provided, uses the connected wallet client.
+ * @returns A promise that resolves with the transaction hash and receipt, or null if access already exists.
+ * @throws {Error} If the response doesn't contain marketplace action or if the method is not buyAccess.
+ */
+declare function settleX402(this: Origin, x402Response: X402Response, signer?: any): Promise<TransactionResult | null>;
+
+/**
+ * Fetch data with X402 payment handling.
+ * @param {bigint} tokenId The token ID to fetch data for.
+ * @param {any} [signer] Optional signer object for signing the X402 intent.
+ * @returns {Promise<any>} A promise that resolves with the fetched data.
+ * @throws {Error} Throws an error if the data cannot be fetched or if no signer/wallet client is provided.
+ */
+declare function getDataWithX402(this: Origin, tokenId: bigint, signer?: any): Promise<any>;
+
 interface RoyaltyInfo {
     tokenBoundAccount: Address;
     balance: bigint;
@@ -203,12 +249,14 @@ declare class Origin {
     buyAccess: typeof buyAccess;
     hasAccess: typeof hasAccess;
     subscriptionExpiry: typeof subscriptionExpiry;
-    private jwt;
+    settleX402: typeof settleX402;
+    getDataWithX402: typeof getDataWithX402;
+    private jwt?;
     environment: Environment;
     private viemClient?;
     baseParentId?: bigint;
-    constructor(jwt: string, environment: Environment, viemClient?: WalletClient, baseParentId?: bigint);
-    getJwt(): string;
+    constructor(environment: Environment | string, jwt?: string, viemClient?: WalletClient, baseParentId?: bigint);
+    getJwt(): string | undefined;
     setViemClient(client: WalletClient): void;
     mintFile(file: File, metadata: Record<string, unknown>, license: LicenseTerms, parents?: bigint[], options?: {
         progressCallback?: (percent: number) => void;
@@ -231,6 +279,12 @@ declare class Origin {
      * @returns {Promise<any>} The result of the buyAccess call.
      */
     buyAccessSmart(tokenId: bigint): Promise<any>;
+    /**
+     * Fetch the underlying data associated with a specific token ID.
+     * @param {bigint} tokenId - The token ID to fetch data for.
+     * @returns {Promise<any>} A promise that resolves with the fetched data.
+     * @throws {Error} Throws an error if the data cannot be fetched.
+     */
     getData(tokenId: bigint): Promise<any>;
     /**
      * Get the Token Bound Account (TBA) address for a specific token ID.