@1stdex/first-sdk 1.0.83 → 1.0.84

package/dist/types/calls/batch/prepare-claim-real-tokens.d.ts

@@ -1,6 +1,14 @@
 import { CHAIN_IDS } from '../../constants/chain-configs/chain';
 import { DefaultWriteContractOptions } from '../../types';
 import { BatchCall } from './prepare-limit-order-with-setup';
+/**
+ * Error thrown when there are insufficient claimable funds in vault and mirror token combined.
+ */
+export declare class NotEnoughClaimableError extends Error {
+    readonly required: bigint;
+    readonly available: bigint;
+    constructor(message: string, required: bigint, available: bigint);
+}
 /**
  * Prepares transactions to claim real tokens from a mirror token system.
  * Checks vault claimable assets and mirror token claimable assets, then creates
@@ -36,14 +44,16 @@ export declare const prepareClaimRealTokensSameChain: ({ chainId, userAddress, m
 }) => Promise<BatchCall[]>;
 /**
  * Prepares transactions to claim real tokens and bridge them cross-chain via LayerZero.
- * Claims all available assets to the user address, then bridges them to a receiving
- * address on the destination chain using LayerZero's OFT protocol.
+ * Claims the specified amount optimally (from mirror token and/or vault) to the user address,
+ * then bridges them to a receiving address on the destination chain using LayerZero's OFT protocol.
+ * Throws NotEnoughClaimableError if combined claimable amount is insufficient.
  *
  * @param chainId The source chain ID.
  * @param destinationChainId The destination chain ID.
  * @param userAddress The user address.
  * @param mirrorTokenAddress The mirror token address (OFT contract).
  * @param receivingAddress The address to receive the tokens on destination chain.
+ * @param amount The amount to claim and send (in token base units, e.g., wei).
  * @param options Optional parameters.
  * @returns Promise resolving to array of batch calls.
  * @example
@@ -55,19 +65,21 @@ export declare const prepareClaimRealTokensSameChain: ({ chainId, userAddress, m
  *   destinationChainId: 8453,
  *   userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69',
  *   mirrorTokenAddress: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
- *   receivingAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb'
+ *   receivingAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
+ *   amount: 1000000000000000000n // 1 token (18 decimals)
  * })
  *
  * // Send all calls in one batched transaction
  * const { client } = useSmartWallets()
  * const txHash = await client.sendUserOperation({ calls })
  */
-export declare const prepareClaimRealTokensCrossChainLZ: ({ chainId, destinationChainId, userAddress, mirrorTokenAddress, receivingAddress, options, }: {
+export declare const prepareClaimRealTokensCrossChainLZ: ({ chainId, destinationChainId, userAddress, mirrorTokenAddress, receivingAddress, amount, options, }: {
     chainId: CHAIN_IDS;
     destinationChainId: CHAIN_IDS;
     userAddress: `0x${string}`;
     mirrorTokenAddress: `0x${string}`;
     receivingAddress: `0x${string}`;
+    amount: bigint;
     options?: DefaultWriteContractOptions;
 }) => Promise<BatchCall[]>;
 //# sourceMappingURL=prepare-claim-real-tokens.d.ts.map

package/dist/types/calls/batch/prepare-claim-real-tokens.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prepare-claim-real-tokens.d.ts","sourceRoot":"","sources":["../../../../src/calls/batch/prepare-claim-real-tokens.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAa,MAAM,qCAAqC,CAAC;AAM3E,OAAO,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAE1D,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,+BAA+B,6EAMzC;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,kBAAkB,EAAE,KAAK,MAAM,EAAE,CAAC;IAClC,gBAAgB,EAAE,KAAK,MAAM,EAAE,CAAC;IAChC,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,SAAS,EAAE,CAkEtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,kCAAkC,iGAO5C;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,kBAAkB,EAAE,SAAS,CAAC;IAC9B,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,kBAAkB,EAAE,KAAK,MAAM,EAAE,CAAC;IAClC,gBAAgB,EAAE,KAAK,MAAM,EAAE,CAAC;IAChC,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,SAAS,EAAE,CA2GtB,CAAC"}
+{"version":3,"file":"prepare-claim-real-tokens.d.ts","sourceRoot":"","sources":["../../../../src/calls/batch/prepare-claim-real-tokens.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAa,MAAM,qCAAqC,CAAC;AAM3E,OAAO,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAE1D,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAE7D;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,KAAK;aAG9B,QAAQ,EAAE,MAAM;aAChB,SAAS,EAAE,MAAM;gBAFjC,OAAO,EAAE,MAAM,EACC,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM;CAMpC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,+BAA+B,6EAMzC;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,kBAAkB,EAAE,KAAK,MAAM,EAAE,CAAC;IAClC,gBAAgB,EAAE,KAAK,MAAM,EAAE,CAAC;IAChC,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,SAAS,EAAE,CAkEtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,kCAAkC,yGAQ5C;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,kBAAkB,EAAE,SAAS,CAAC;IAC9B,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,kBAAkB,EAAE,KAAK,MAAM,EAAE,CAAC;IAClC,gBAAgB,EAAE,KAAK,MAAM,EAAE,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,SAAS,EAAE,CAkItB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1stdex/first-sdk",
-  "version": "1.0.83",
+  "version": "1.0.84",
   "description": "🛠 An SDK for building applications on top of 1st V2",
   "files": [
     "dist"