@1stdex/first-sdk 1.0.82 → 1.0.84

package/dist/types/calls/batch/index.d.ts

@@ -1,5 +1,6 @@
 export { prepareLimitOrderWithSetup } from './prepare-limit-order-with-setup';
 export { prepareMarketOrderWithSetup } from './prepare-market-order-with-setup';
 export { prepareWithdraw, NotEnoughFundsError } from './prepare-withdraw';
+export { prepareClaimRealTokensSameChain, prepareClaimRealTokensCrossChainLZ, } from './prepare-claim-real-tokens';
 export type { BatchCall } from './prepare-limit-order-with-setup';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/calls/batch/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/calls/batch/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,2BAA2B,EAAE,MAAM,mCAAmC,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,YAAY,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/calls/batch/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,2BAA2B,EAAE,MAAM,mCAAmC,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EACL,+BAA+B,EAC/B,kCAAkC,GACnC,MAAM,6BAA6B,CAAC;AACrC,YAAY,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC"}

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

@@ -0,0 +1,85 @@
+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
+ * claim calls to transfer all available real tokens to the receiving address.
+ *
+ * @param chainId The chain ID.
+ * @param userAddress The user address.
+ * @param mirrorTokenAddress The mirror token address.
+ * @param receivingAddress The address to receive the claimed real tokens.
+ * @param options Optional parameters.
+ * @returns Promise resolving to array of batch calls.
+ * @example
+ * import { prepareClaimRealTokensSameChain } from '@1stdex/first-sdk'
+ * import { useSmartWallets } from '@privy-io/react-auth/smart-wallets'
+ *
+ * const calls = await prepareClaimRealTokensSameChain({
+ *   chainId: 421614,
+ *   userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69',
+ *   mirrorTokenAddress: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
+ *   receivingAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb'
+ * })
+ *
+ * // Send all calls in one batched transaction
+ * const { client } = useSmartWallets()
+ * const txHash = await client.sendUserOperation({ calls })
+ */
+export declare const prepareClaimRealTokensSameChain: ({ chainId, userAddress, mirrorTokenAddress, receivingAddress, options, }: {
+    chainId: CHAIN_IDS;
+    userAddress: `0x${string}`;
+    mirrorTokenAddress: `0x${string}`;
+    receivingAddress: `0x${string}`;
+    options?: DefaultWriteContractOptions;
+}) => Promise<BatchCall[]>;
+/**
+ * Prepares transactions to claim real tokens and bridge them cross-chain via LayerZero.
+ * 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
+ * import { prepareClaimRealTokensCrossChainLZ } from '@1stdex/first-sdk'
+ * import { useSmartWallets } from '@privy-io/react-auth/smart-wallets'
+ *
+ * const calls = await prepareClaimRealTokensCrossChainLZ({
+ *   chainId: 84532,
+ *   destinationChainId: 8453,
+ *   userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69',
+ *   mirrorTokenAddress: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
+ *   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, 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

@@ -0,0 +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;;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"}