@0xmonaco/core 0.1.5 → 0.1.7

package/dist/api/vault/api.d.ts

@@ -27,24 +27,51 @@
  * console.log(`Deposit transaction: ${result.hash}`);
  * ```
  */
-import { type VaultAPI, type Balance, type TransactionResult } from "@0xmonaco/types";
+import type { Balance, TransactionResult, VaultAPI, MarketAPI, ApplicationsAPI } from "@0xmonaco/types";
 import { type Address, type Chain, type PublicClient, type WalletClient } from "viem";
 import { BaseAPI } from "../base";
 export declare class VaultAPIImpl extends BaseAPI implements VaultAPI {
     private readonly publicClient;
     private readonly walletClient;
-    private readonly vaultAddress;
     private readonly chain;
+    private marketAPI;
+    private applicationsAPI;
     /**
      * Creates a new VaultAPI instance.
      *
      * @param publicClient - The viem public client for reading blockchain state
      * @param walletClient - The viem wallet client for signing transactions
-     * @param vaultAddress - The address of the Monaco vault contract
-     * @param apiUrl - The base URL for the Monaco API Gateway
      * @param chain - The blockchain network configuration
+     * @param marketAPI - The market API instance for token validation
+     * @param applicationsAPI - The applications API instance for fetching vault address
+     * @param apiUrl - The base URL for the Monaco API Gateway
+     */
+    constructor(publicClient: PublicClient, walletClient: WalletClient, chain: Chain, marketAPI: MarketAPI, applicationsAPI: ApplicationsAPI, apiUrl: string);
+    /**
+     * Fetches the vault contract address from the applications API.
+     *
+     * @returns Promise resolving to the vault contract address
+     * @throws {APIError} When vault address cannot be retrieved
+     * @private
+     */
+    getVaultAddress(): Promise<Address>;
+    /**
+     * Maps a token symbol to its contract address.
+     *
+     * Looks up the token symbol in active trading pairs to find the corresponding
+     * contract address. Supports both base and quote token symbols.
+     *
+     * @param tokenSymbol - The token symbol to map (e.g., "USDC", "ETH", "MockUSDC")
+     * @returns Promise mapping to the token contract address
+     * @throws {APIError} When token symbol is not found or not supported
+     *
+     * @example
+     * ```typescript
+     * const address = await vaultAPI.mapTokenSymbolToAddress("USDC");
+     * console.log(address); // "0x6A86dA986797D59A839D136dB490292Cd560C131"
+     * ```
      */
-    constructor(publicClient: PublicClient, walletClient: WalletClient, vaultAddress: Address, apiUrl: string, chain: Chain);
+    private mapTokenSymbolToAddress;
     /**
      * Approves the vault contract to spend tokens on behalf of the user.
      *
@@ -52,8 +79,9 @@ export declare class VaultAPIImpl extends BaseAPI implements VaultAPI {
      * to transfer tokens from the user's wallet. Approval is required before any
      * deposit operations can be performed.
      *
-     * @param token - The ERC20 token contract address to approve
+     * @param tokenSymbol - The token symbol to approve (e.g., "USDC", "ETH", "MockUSDC")
      * @param amount - The maximum amount of tokens the vault can spend (as bigint)
+     * @param autoWait - Whether to automatically wait for transaction confirmation (defaults to true)
      * @returns Promise resolving to TransactionResult with transaction details
      * @throws {ContractError} When approval transaction fails
      * @throws {InvalidConfigError} When wallet account is not available
@@ -61,15 +89,25 @@ export declare class VaultAPIImpl extends BaseAPI implements VaultAPI {
      *
      * @example
      * ```typescript
-     * // Approve vault to spend up to 1000 USDC
+     * // Approve vault to spend up to 1000 USDC (auto-waits by default)
      * const result = await vaultAPI.approve(
-     *   usdcAddress,
+     *   "USDC",
      *   parseUnits("1000", 6)
      * );
      * console.log(`Approval transaction: ${result.hash}`);
+     * console.log(`Status: ${result.status}`); // "confirmed" if successful
+     *
+     * // Or skip auto-waiting
+     * const result = await vaultAPI.approve(
+     *   "MockUSDC",
+     *   parseUnits("1000", 6),
+     *   false
+     * );
+     * // Then manually wait later if needed
+     * const receipt = await sdk.waitForTransaction(result.hash);
      * ```
      */
-    approve(token: string, amount: bigint): Promise<TransactionResult>;
+    approve(tokenSymbol: string, amount: bigint, autoWait?: boolean): Promise<TransactionResult>;
     /**
      * Deposits tokens into the Monaco vault.
      *
@@ -79,25 +117,35 @@ export declare class VaultAPIImpl extends BaseAPI implements VaultAPI {
      *
      * Note: This method requires prior approval via the approve() method.
      *
-     * @param token - The ERC20 token contract address to deposit
+     * @param tokenSymbol - The token symbol to deposit (e.g., "USDC", "ETH", "MockUSDC")
      * @param amount - The amount of tokens to deposit (as bigint)
+     * @param autoWait - Whether to automatically wait for transaction confirmation (defaults to true)
      * @returns Promise resolving to TransactionResult with transaction details
      * @throws {ContractError} When deposit fails or approval is insufficient
-     * @throws {APIError} When signature retrieval fails
      * @throws {InvalidConfigError} When wallet account is not available
      * @throws {TransactionError} When transaction signing fails
      *
      * @example
      * ```typescript
-     * // Deposit 100 USDC into the vault
+     * // Deposit 100 USDC into the vault (auto-waits by default)
      * const result = await vaultAPI.deposit(
-     *   usdcAddress,
+     *   "USDC",
      *   parseUnits("100", 6)
      * );
      * console.log(`Deposit transaction: ${result.hash}`);
+     * console.log(`Status: ${result.status}`); // "confirmed" if successful
+     *
+     * // Or skip auto-waiting
+     * const result = await vaultAPI.deposit(
+     *   "MockUSDC",
+     *   parseUnits("100", 6),
+     *   false
+     * );
+     * // Then manually wait later if needed
+     * const receipt = await sdk.waitForTransaction(result.hash);
      * ```
      */
-    deposit(token: string, amount: bigint): Promise<TransactionResult>;
+    deposit(tokenSymbol: string, amount: bigint, autoWait?: boolean): Promise<TransactionResult>;
     /**
      * Withdraws tokens from the Monaco vault.
      *
@@ -105,8 +153,9 @@ export declare class VaultAPIImpl extends BaseAPI implements VaultAPI {
      * user's wallet. The method obtains a signature from the API Gateway and then
      * executes the withdrawal transaction on-chain.
      *
-     * @param token - The ERC20 token contract address to withdraw
+     * @param tokenSymbol - The token symbol to withdraw (e.g., "USDC", "ETH", "MockUSDC")
      * @param amount - The amount of tokens to withdraw (as bigint)
+     * @param autoWait - Whether to automatically wait for transaction confirmation (defaults to true)
      * @returns Promise resolving to TransactionResult with transaction details
      * @throws {ContractError} When withdrawal fails
      * @throws {APIError} When signature retrieval fails
@@ -115,57 +164,67 @@ export declare class VaultAPIImpl extends BaseAPI implements VaultAPI {
      *
      * @example
      * ```typescript
-     * // Withdraw 50 USDC from the vault
+     * // Withdraw 50 USDC from the vault (auto-waits by default)
      * const result = await vaultAPI.withdraw(
-     *   usdcAddress,
+     *   "USDC",
      *   parseUnits("50", 6)
      * );
      * console.log(`Withdrawal transaction: ${result.hash}`);
+     * console.log(`Status: ${result.status}`); // "confirmed" if successful
+     *
+     * // Or skip auto-waiting
+     * const result = await vaultAPI.withdraw(
+     *   "MockUSDC",
+     *   parseUnits("50", 6),
+     *   false
+     * );
+     * // Then manually wait later if needed
+     * const receipt = await sdk.waitForTransaction(result.hash);
      * ```
      */
-    withdraw(token: string, amount: bigint): Promise<TransactionResult>;
+    withdraw(tokenSymbol: string, amount: bigint, autoWait?: boolean): Promise<TransactionResult>;
     /**
      * Retrieves the user's token balance in the vault.
      *
      * Queries the vault contract to get the current balance of a specific token
      * for the connected wallet. Returns both raw amount and formatted display values.
      *
-     * @param token - The ERC20 token contract address to check balance for
+     * @param tokenSymbol - The token symbol to check balance for (e.g., "USDC", "ETH", "MockUSDC")
      * @returns Promise resolving to Balance with token balance details
      * @throws {ContractError} When balance retrieval fails
      *
      * @example
      * ```typescript
-     * const balance = await vaultAPI.getBalance(usdcAddress);
+     * const balance = await vaultAPI.getBalance("USDC");
      * console.log(`Vault balance: ${balance.formatted} ${balance.symbol}`);
      * console.log(`Raw amount: ${balance.amount}`);
      * ```
      */
-    getBalance(token: string): Promise<Balance>;
+    getBalance(tokenSymbol: string): Promise<Balance>;
     /**
      * Retrieves the current allowance for a token.
      *
      * Queries the ERC20 token contract to get the current allowance granted to the
      * vault contract for spending tokens on behalf of the user.
      *
-     * @param token - The ERC20 token contract address to check allowance for
+     * @param tokenSymbol - The token symbol to check allowance for (e.g., "USDC", "ETH", "MockUSDC")
      * @returns Promise resolving to the current allowance amount as bigint
      * @throws {ContractError} When allowance retrieval fails
      *
      * @example
      * ```typescript
-     * const allowance = await vaultAPI.getAllowance(usdcAddress);
+     * const allowance = await vaultAPI.getAllowance("USDC");
      * console.log(`Current allowance: ${formatUnits(allowance, 6)} USDC`);
      * ```
      */
-    getAllowance(token: string): Promise<bigint>;
+    getAllowance(tokenSymbol: string): Promise<bigint>;
     /**
      * Checks if approval is needed for a specific amount.
      *
      * Compares the current allowance with the requested amount to determine if
      * the user needs to approve more tokens before performing operations.
      *
-     * @param token - The ERC20 token contract address to check
+     * @param tokenSymbol - The token symbol to check (e.g., "USDC", "ETH", "MockUSDC")
      * @param amount - The amount to check approval for (as bigint)
      * @returns Promise resolving to true if approval is needed, false otherwise
      * @throws {ContractError} When approval check fails
@@ -173,17 +232,17 @@ export declare class VaultAPIImpl extends BaseAPI implements VaultAPI {
      * @example
      * ```typescript
      * const needsApproval = await vaultAPI.needsApproval(
-     *   usdcAddress,
+     *   "USDC",
      *   parseUnits("100", 6)
      * );
      *
      * if (needsApproval) {
      *   console.log("Approval required before deposit");
-     *   await vaultAPI.approve(usdcAddress, parseUnits("100", 6));
+     *   await vaultAPI.approve("USDC", parseUnits("100", 6));
      * }
      * ```
      */
-    needsApproval(token: string, amount: bigint): Promise<boolean>;
+    needsApproval(tokenSymbol: string, amount: bigint): Promise<boolean>;
     /**
      * Retrieves a deposit signature from the API Gateway.
      *
@@ -191,7 +250,7 @@ export declare class VaultAPIImpl extends BaseAPI implements VaultAPI {
      * the cryptographic signature required for deposit transactions. The signature
      * validates the deposit request and ensures proper authorization.
      *
-     * @param token - The ERC20 token contract address
+     * @param tokenSymbol - The token symbol to deposit (e.g., "USDC", "ETH", "MockUSDC")
      * @param amount - The amount to deposit (as bigint)
      * @param userAddress - The user's wallet address
      * @returns Promise resolving to object containing seed and signature
@@ -206,7 +265,7 @@ export declare class VaultAPIImpl extends BaseAPI implements VaultAPI {
      * the cryptographic signature required for withdrawal transactions. The signature
      * validates the withdrawal request and ensures proper authorization.
      *
-     * @param token - The ERC20 token contract address
+     * @param tokenSymbol - The token symbol to withdraw (e.g., "USDC", "ETH", "MockUSDC")
      * @param amount - The amount to withdraw (as bigint)
      * @param userAddress - The user's wallet address
      * @returns Promise resolving to object containing seed and signature
@@ -214,5 +273,6 @@ export declare class VaultAPIImpl extends BaseAPI implements VaultAPI {
      * @private
      */
     private getWithdrawSignature;
+    private waitForTransaction;
 }
 //# sourceMappingURL=api.d.ts.map

package/dist/api/vault/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/api/vault/api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAGH,OAAO,EACN,KAAK,QAAQ,EACb,KAAK,OAAO,EACZ,KAAK,iBAAiB,EACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACN,KAAK,OAAO,EACZ,KAAK,KAAK,EAMV,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,MAAM,MAAM,CAAC;AAOd,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,qBAAa,YAAa,SAAQ,OAAQ,YAAW,QAAQ;IAW3D,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAE7B,OAAO,CAAC,QAAQ,CAAC,KAAK;IAdvB;;;;;;;;OAQG;gBAEe,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,OAAO,EACtC,MAAM,EAAE,MAAM,EACG,KAAK,EAAE,KAAK;IAK9B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAmExE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAgGxE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA6EzE;;;;;;;;;;;;;;;;OAgBG;IACG,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAwCjD;;;;;;;;;;;;;;;OAeG;IACG,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAqBlD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAapE;;;;;;;;;;;;;OAaG;YACW,mBAAmB;IAsCjC;;;;;;;;;;;;;OAaG;YACW,oBAAoB;CAiClC"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/api/vault/api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAGH,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACxG,OAAO,EACN,KAAK,OAAO,EACZ,KAAK,KAAK,EAMV,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,MAAM,MAAM,CAAC;AAOd,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,qBAAa,YAAa,SAAQ,OAAQ,YAAW,QAAQ;IAe3D,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,KAAK;IAhBvB,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,eAAe,CAAkB;IAEzC;;;;;;;;;OASG;gBAEe,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,YAAY,EAC1B,KAAK,EAAE,KAAK,EAC7B,SAAS,EAAE,SAAS,EACpB,eAAe,EAAE,eAAe,EAChC,MAAM,EAAE,MAAM;IAOf;;;;;;OAMG;IACG,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC;IAazC;;;;;;;;;;;;;;;OAeG;YACW,uBAAuB;IAiCrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAE,OAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA2ExG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACG,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAE,OAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAwGxG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACG,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAE,OAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAoFzG;;;;;;;;;;;;;;;;OAgBG;IACG,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA4CvD;;;;;;;;;;;;;;;OAeG;IACG,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAyBxD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAa1E;;;;;;;;;;;;;OAaG;YACW,mBAAmB;IA2CjC;;;;;;;;;;;;;OAaG;YACW,oBAAoB;YAuCpB,kBAAkB;CA8BhC"}