@dcentralab/d402-client 0.3.3 → 0.3.4

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Traia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/dist/index.d.mts

@@ -187,11 +187,6 @@ declare function sortPaymentRequirements(requirements: PaymentRequirement[], pre
  */
 declare function findMatchingPaymentRequirement(requirements: PaymentRequirement[], scheme?: string, network?: string): PaymentRequirement | undefined;
 
-/**
- * D402 Client - Main client class for handling HTTP 402 payments
- *
- */
-
 /**
  * D402 Client configuration.
  *
@@ -333,9 +328,12 @@ declare class D402Client {
      *
      * @param publicClient - Viem PublicClient
      * @param tokenAddress - Token contract address
-     * @returns Withdrawal request: [amount, unlockTimestamp] or null if no request exists
+     * @returns Withdrawal request details (request + unlockTime) or null if no request exists
      */
-    getWithdrawalRequest(publicClient: PublicClient, tokenAddress: `0x${string}`): Promise<[bigint, bigint] | null>;
+    getWithdrawalRequest(publicClient: PublicClient, tokenAddress: `0x${string}`): Promise<{
+        request: WithdrawalRequest;
+        unlockTime: bigint;
+    } | null>;
     /**
      * Request a withdrawal from the IATP wallet.
      *
@@ -565,6 +563,15 @@ interface WalletCreationResult {
     /** Chain ID */
     chainId: number;
 }
+/**
+ * Withdrawal request from an IATPWallet.
+ */
+interface WithdrawalRequest {
+    token: Address;
+    amount: bigint;
+    requestedAt: bigint;
+    executed: boolean;
+}
 
 /**
  * IATPWallet creation functions
@@ -697,28 +704,34 @@ declare function getWalletsByOwner(params: {
  * Get withdrawal request for a token in an IATPWallet.
  *
  * Queries the IATPWallet contract to get the current withdrawal request
- * (amount and unlock timestamp) for a specific token.
+ * including all details: token, amount, requestedAt, executed status, and unlockTime.
  *
  * @param params - Query parameters
  * @param params.publicClient - Viem PublicClient
  * @param params.walletAddress - IATPWallet contract address
  * @param params.tokenAddress - Token contract address
  * @param params.network - Network to query (default: "sepolia")
- * @returns Withdrawal request: [amount, unlockTimestamp] or null if no request exists
+ * @returns Withdrawal request details or null if no request exists
  *
  * @example
  * ```ts
  * import { getWithdrawalRequest } from '@dcentralab/d402-client'
  *
- * const request = await getWithdrawalRequest({
+ * const result = await getWithdrawalRequest({
  *   publicClient,
  *   walletAddress: '0xUserIATPWallet...',
  *   tokenAddress: '0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238',
  * })
  *
- * if (request) {
- *   const [amount, unlockTimestamp] = request
- *   const isUnlocked = Date.now() >= Number(unlockTimestamp) * 1000
+ * if (result) {
+ *   const { request, unlockTime } = result
+ *   console.log('Token:', request.token)
+ *   console.log('Amount:', request.amount)
+ *   console.log('Requested at:', new Date(Number(request.requestedAt) * 1000))
+ *   console.log('Executed:', request.executed)
+ *   console.log('Unlocks at:', new Date(Number(unlockTime) * 1000))
+ *
+ *   const isUnlocked = Date.now() >= Number(unlockTime) * 1000
  * }
  * ```
  */
@@ -727,7 +740,10 @@ declare function getWithdrawalRequest(params: {
     walletAddress: Address;
     tokenAddress: Address;
     network?: 'sepolia';
-}): Promise<[bigint, bigint] | null>;
+}): Promise<{
+    request: WithdrawalRequest;
+    unlockTime: bigint;
+} | null>;
 /**
  * Request a withdrawal from an IATPWallet.
  *
@@ -1156,4 +1172,4 @@ declare class UnsupportedNetworkError extends PaymentError {
     constructor(network: string);
 }
 
-export { ContractName, D402Client, type D402ClientConfig, type D402Response, type EIP712Domain, Invalid402ResponseError, MissingRequestConfigError, PaymentAlreadyAttemptedError, PaymentAmountExceededError, type PaymentAuthorization, PaymentError, type PaymentRequirement, type PaymentSelector, type PaymentSelectorOptions, PaymentVerificationError, type SignedPayment, type SupportedNetwork, UnsupportedNetworkError, UnsupportedSchemeError, type WalletCreationResult, createIATPWallet, createPaymentSelector, decodePayment, decodePaymentResponse, encodePayment, executeWithdrawal, findMatchingPaymentRequirement, formatMoney, generateNonce, getAvailableBalance, getChainId, getContractAbi, getContractAddress, getContractConfig, getCurrentTimestamp, getLockedBalanceForProvider, getUnlockedBalanceForProvider, getUsdcAddress, getWalletsByOwner, getWithdrawalRequest, isValidAddress, normalizeAddress, parseAllPaymentRequirements, parseMoney, parsePaymentRequirement, requestWithdrawal, selectPaymentRequirement, signD402Payment, sortPaymentRequirements, usdToUsdc, withdrawAllAvailableEpochs };
+export { ContractName, D402Client, type D402ClientConfig, type D402Response, type EIP712Domain, Invalid402ResponseError, MissingRequestConfigError, PaymentAlreadyAttemptedError, PaymentAmountExceededError, type PaymentAuthorization, PaymentError, type PaymentRequirement, type PaymentSelector, type PaymentSelectorOptions, PaymentVerificationError, type SignedPayment, type SupportedNetwork, UnsupportedNetworkError, UnsupportedSchemeError, type WalletCreationResult, type WithdrawalRequest, createIATPWallet, createPaymentSelector, decodePayment, decodePaymentResponse, encodePayment, executeWithdrawal, findMatchingPaymentRequirement, formatMoney, generateNonce, getAvailableBalance, getChainId, getContractAbi, getContractAddress, getContractConfig, getCurrentTimestamp, getLockedBalanceForProvider, getUnlockedBalanceForProvider, getUsdcAddress, getWalletsByOwner, getWithdrawalRequest, isValidAddress, normalizeAddress, parseAllPaymentRequirements, parseMoney, parsePaymentRequirement, requestWithdrawal, selectPaymentRequirement, signD402Payment, sortPaymentRequirements, usdToUsdc, withdrawAllAvailableEpochs };

package/dist/index.d.ts

@@ -187,11 +187,6 @@ declare function sortPaymentRequirements(requirements: PaymentRequirement[], pre
  */
 declare function findMatchingPaymentRequirement(requirements: PaymentRequirement[], scheme?: string, network?: string): PaymentRequirement | undefined;
 
-/**
- * D402 Client - Main client class for handling HTTP 402 payments
- *
- */
-
 /**
  * D402 Client configuration.
  *
@@ -333,9 +328,12 @@ declare class D402Client {
      *
      * @param publicClient - Viem PublicClient
      * @param tokenAddress - Token contract address
-     * @returns Withdrawal request: [amount, unlockTimestamp] or null if no request exists
+     * @returns Withdrawal request details (request + unlockTime) or null if no request exists
      */
-    getWithdrawalRequest(publicClient: PublicClient, tokenAddress: `0x${string}`): Promise<[bigint, bigint] | null>;
+    getWithdrawalRequest(publicClient: PublicClient, tokenAddress: `0x${string}`): Promise<{
+        request: WithdrawalRequest;
+        unlockTime: bigint;
+    } | null>;
     /**
      * Request a withdrawal from the IATP wallet.
      *
@@ -565,6 +563,15 @@ interface WalletCreationResult {
     /** Chain ID */
     chainId: number;
 }
+/**
+ * Withdrawal request from an IATPWallet.
+ */
+interface WithdrawalRequest {
+    token: Address;
+    amount: bigint;
+    requestedAt: bigint;
+    executed: boolean;
+}
 
 /**
  * IATPWallet creation functions
@@ -697,28 +704,34 @@ declare function getWalletsByOwner(params: {
  * Get withdrawal request for a token in an IATPWallet.
  *
  * Queries the IATPWallet contract to get the current withdrawal request
- * (amount and unlock timestamp) for a specific token.
+ * including all details: token, amount, requestedAt, executed status, and unlockTime.
  *
  * @param params - Query parameters
  * @param params.publicClient - Viem PublicClient
  * @param params.walletAddress - IATPWallet contract address
  * @param params.tokenAddress - Token contract address
  * @param params.network - Network to query (default: "sepolia")
- * @returns Withdrawal request: [amount, unlockTimestamp] or null if no request exists
+ * @returns Withdrawal request details or null if no request exists
  *
  * @example
  * ```ts
  * import { getWithdrawalRequest } from '@dcentralab/d402-client'
  *
- * const request = await getWithdrawalRequest({
+ * const result = await getWithdrawalRequest({
  *   publicClient,
  *   walletAddress: '0xUserIATPWallet...',
  *   tokenAddress: '0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238',
  * })
  *
- * if (request) {
- *   const [amount, unlockTimestamp] = request
- *   const isUnlocked = Date.now() >= Number(unlockTimestamp) * 1000
+ * if (result) {
+ *   const { request, unlockTime } = result
+ *   console.log('Token:', request.token)
+ *   console.log('Amount:', request.amount)
+ *   console.log('Requested at:', new Date(Number(request.requestedAt) * 1000))
+ *   console.log('Executed:', request.executed)
+ *   console.log('Unlocks at:', new Date(Number(unlockTime) * 1000))
+ *
+ *   const isUnlocked = Date.now() >= Number(unlockTime) * 1000
  * }
  * ```
  */
@@ -727,7 +740,10 @@ declare function getWithdrawalRequest(params: {
     walletAddress: Address;
     tokenAddress: Address;
     network?: 'sepolia';
-}): Promise<[bigint, bigint] | null>;
+}): Promise<{
+    request: WithdrawalRequest;
+    unlockTime: bigint;
+} | null>;
 /**
  * Request a withdrawal from an IATPWallet.
  *
@@ -1156,4 +1172,4 @@ declare class UnsupportedNetworkError extends PaymentError {
     constructor(network: string);
 }
 
-export { ContractName, D402Client, type D402ClientConfig, type D402Response, type EIP712Domain, Invalid402ResponseError, MissingRequestConfigError, PaymentAlreadyAttemptedError, PaymentAmountExceededError, type PaymentAuthorization, PaymentError, type PaymentRequirement, type PaymentSelector, type PaymentSelectorOptions, PaymentVerificationError, type SignedPayment, type SupportedNetwork, UnsupportedNetworkError, UnsupportedSchemeError, type WalletCreationResult, createIATPWallet, createPaymentSelector, decodePayment, decodePaymentResponse, encodePayment, executeWithdrawal, findMatchingPaymentRequirement, formatMoney, generateNonce, getAvailableBalance, getChainId, getContractAbi, getContractAddress, getContractConfig, getCurrentTimestamp, getLockedBalanceForProvider, getUnlockedBalanceForProvider, getUsdcAddress, getWalletsByOwner, getWithdrawalRequest, isValidAddress, normalizeAddress, parseAllPaymentRequirements, parseMoney, parsePaymentRequirement, requestWithdrawal, selectPaymentRequirement, signD402Payment, sortPaymentRequirements, usdToUsdc, withdrawAllAvailableEpochs };
+export { ContractName, D402Client, type D402ClientConfig, type D402Response, type EIP712Domain, Invalid402ResponseError, MissingRequestConfigError, PaymentAlreadyAttemptedError, PaymentAmountExceededError, type PaymentAuthorization, PaymentError, type PaymentRequirement, type PaymentSelector, type PaymentSelectorOptions, PaymentVerificationError, type SignedPayment, type SupportedNetwork, UnsupportedNetworkError, UnsupportedSchemeError, type WalletCreationResult, type WithdrawalRequest, createIATPWallet, createPaymentSelector, decodePayment, decodePaymentResponse, encodePayment, executeWithdrawal, findMatchingPaymentRequirement, formatMoney, generateNonce, getAvailableBalance, getChainId, getContractAbi, getContractAddress, getContractConfig, getCurrentTimestamp, getLockedBalanceForProvider, getUnlockedBalanceForProvider, getUsdcAddress, getWalletsByOwner, getWithdrawalRequest, isValidAddress, normalizeAddress, parseAllPaymentRequirements, parseMoney, parsePaymentRequirement, requestWithdrawal, selectPaymentRequirement, signD402Payment, sortPaymentRequirements, usdToUsdc, withdrawAllAvailableEpochs };

package/dist/index.js

@@ -5109,13 +5109,13 @@ async function createIATPWallet(params) {
 }
 async function getAvailableBalance(params) {
   const { publicClient, walletAddress, tokenAddress, network = "sepolia" } = params;
-  const walletConfig = getContractConfig("IATPWallet" /* IATP_WALLET */, network);
-  if (!walletConfig) {
-    throw new Error(`IATPWallet contract not found for network: ${network}`);
+  const walletAbi = getContractAbi("IATPWallet" /* IATP_WALLET */, network);
+  if (!walletAbi) {
+    throw new Error(`IATPWallet ABI not found for network: ${network}`);
   }
   const balance = await publicClient.readContract({
     address: walletAddress,
-    abi: walletConfig.abi,
+    abi: walletAbi,
     functionName: "getAvailableBalance",
     args: [tokenAddress]
   });
@@ -5145,37 +5145,41 @@ async function getWalletsByOwner(params) {
 // src/wallet/withdrawals.ts
 async function getWithdrawalRequest(params) {
   const { publicClient, walletAddress, tokenAddress, network = "sepolia" } = params;
-  const walletConfig = getContractConfig("IATPWallet" /* IATP_WALLET */, network);
-  if (!walletConfig) {
-    throw new Error(`IATPWallet contract not found for network: ${network}`);
+  const walletAbi = getContractAbi("IATPWallet" /* IATP_WALLET */, network);
+  if (!walletAbi) {
+    throw new Error(`IATPWallet ABI not found for network: ${network}`);
   }
   const result = await publicClient.readContract({
     address: walletAddress,
-    abi: walletConfig.abi,
+    abi: walletAbi,
     functionName: "getWithdrawalRequest",
     args: [tokenAddress]
   });
-  if (result[0] === 0n) {
+  const [request, unlockTime] = result;
+  if (request.amount === 0n) {
     return null;
   }
-  return result;
+  return {
+    request,
+    unlockTime
+  };
 }
 async function requestWithdrawal(params) {
   const { walletClient, publicClient, walletAddress, tokenAddress, amount, account, network = "sepolia" } = params;
-  const walletConfig = getContractConfig("IATPWallet" /* IATP_WALLET */, network);
-  if (!walletConfig) {
-    throw new Error(`IATPWallet contract not found for network: ${network}`);
+  const walletAbi = getContractAbi("IATPWallet" /* IATP_WALLET */, network);
+  if (!walletAbi) {
+    throw new Error(`IATPWallet ABI not found for network: ${network}`);
   }
   await publicClient.simulateContract({
     account,
     address: walletAddress,
-    abi: walletConfig.abi,
+    abi: walletAbi,
     functionName: "requestWithdrawal",
     args: [tokenAddress, amount]
   });
   const estimatedGas = await publicClient.estimateContractGas({
     address: walletAddress,
-    abi: walletConfig.abi,
+    abi: walletAbi,
     functionName: "requestWithdrawal",
     args: [tokenAddress, amount],
     account
@@ -5183,7 +5187,7 @@ async function requestWithdrawal(params) {
   const gasLimit = estimatedGas + estimatedGas / 5n;
   const hash = await walletClient.writeContract({
     address: walletAddress,
-    abi: walletConfig.abi,
+    abi: walletAbi,
     functionName: "requestWithdrawal",
     args: [tokenAddress, amount],
     account,
@@ -5194,20 +5198,20 @@ async function requestWithdrawal(params) {
 }
 async function executeWithdrawal(params) {
   const { walletClient, publicClient, walletAddress, tokenAddress, account, network = "sepolia" } = params;
-  const walletConfig = getContractConfig("IATPWallet" /* IATP_WALLET */, network);
-  if (!walletConfig) {
-    throw new Error(`IATPWallet contract not found for network: ${network}`);
+  const walletAbi = getContractAbi("IATPWallet" /* IATP_WALLET */, network);
+  if (!walletAbi) {
+    throw new Error(`IATPWallet ABI not found for network: ${network}`);
   }
   await publicClient.simulateContract({
     account,
     address: walletAddress,
-    abi: walletConfig.abi,
+    abi: walletAbi,
     functionName: "executeWithdrawal",
     args: [tokenAddress]
   });
   const estimatedGas = await publicClient.estimateContractGas({
     address: walletAddress,
-    abi: walletConfig.abi,
+    abi: walletAbi,
     functionName: "executeWithdrawal",
     args: [tokenAddress],
     account
@@ -5215,7 +5219,7 @@ async function executeWithdrawal(params) {
   const gasLimit = estimatedGas + estimatedGas / 5n;
   const hash = await walletClient.writeContract({
     address: walletAddress,
-    abi: walletConfig.abi,
+    abi: walletAbi,
     functionName: "executeWithdrawal",
     args: [tokenAddress],
     account,
@@ -5308,7 +5312,7 @@ var D402Client = class {
    * 
    * @param publicClient - Viem PublicClient
    * @param tokenAddress - Token contract address
-   * @returns Withdrawal request: [amount, unlockTimestamp] or null if no request exists
+   * @returns Withdrawal request details (request + unlockTime) or null if no request exists
    */
   async getWithdrawalRequest(publicClient, tokenAddress) {
     return getWithdrawalRequest({