@layerzerolabs/lz-sui-oft-sdk-v2 3.0.132 → 3.0.134-sui.0

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 import { SuiClient } from '@mysten/sui/client';
 import { Transaction, TransactionArgument, TransactionResult } from '@mysten/sui/transactions';
-import { SDK, IPTBValidator, MessagingFee, ObjectOptions } from '@layerzerolabs/lz-sui-sdk-v2';
-import { Transaction as Transaction$1, TransactionArgument as TransactionArgument$1, TransactionResult as TransactionResult$1 } from '@mysten/sui/dist/cjs/transactions';
+import { SDK, IPTBValidator, MessagingFee } from '@layerzerolabs/lz-sui-sdk-v2';
 import * as _mysten_sui_dist_cjs_bcs from '@mysten/sui/dist/cjs/bcs';
 
 declare const OFTMsgType: {
@@ -31,14 +30,16 @@ interface OFTReceipt {
 }
 
 declare const OFTErrorCode: {
-    readonly OFT_EComposeMsgNotAllowed: 1;
-    readonly OFT_EComposeMsgRequired: 2;
-    readonly OFT_EInvalidComposeQueue: 3;
-    readonly OFT_EInvalidLocalDecimals: 4;
-    readonly OFT_EPaused: 5;
-    readonly OFT_EPauseUnchanged: 6;
-    readonly OFT_ESlippageExceeded: 7;
-    readonly OFT_EInsufficientBalance: 8;
+    readonly EComposeMsgNotAllowed: 1;
+    readonly EComposeMsgRequired: 2;
+    readonly EInsufficientBalance: 3;
+    readonly EInvalidAdminCap: 4;
+    readonly EInvalidComposeQueue: 5;
+    readonly EInvalidLocalDecimals: 6;
+    readonly EInvalidMigrationCap: 7;
+    readonly EInvalidSendContext: 8;
+    readonly ESlippageExceeded: 9;
+    readonly EWrongPackageVersion: 10;
 };
 /**
  * OFT (Omnichain Fungible Token) Class
@@ -50,7 +51,7 @@ declare const OFTErrorCode: {
  * @example
  * ```typescript
  * // Initialize OFT instance
- * const oft = new OFT(protocolSDK, corePackageId, packageId, oftObjectId, coinType, adminCapId);
+ * const oft = new OFT(protocolSDK, oftPackageId, oftObjectId, coinType, oappObjectId, adminCapId);
  *
  * // Send tokens cross-chain
  * const tx = new Transaction();
@@ -67,7 +68,7 @@ declare class OFT {
     #private;
     /** Sui client for blockchain interactions */
     readonly client: SuiClient;
-    /** The package ID of the core OFT framework (shared OFT functionality) */
+    /** The package ID of the OFT */
     oftPackageId: string;
     /** LayerZero protocol object references (endpoint, messaging channels, etc.) */
     private readonly objects;
@@ -77,6 +78,8 @@ declare class OFT {
     private readonly adminCapId?;
     /** The Sui coin type this OFT represents (e.g., "0x123::mycoin::MYCOIN") */
     private readonly coinType;
+    /** The unique object ID of the associated OApp instance on Sui */
+    private oappObjectId;
     /** Reference to the LayerZero protocol SDK for cross-chain operations */
     private readonly protocolSDK;
     /**
@@ -89,36 +92,52 @@ declare class OFT {
      * @param adminCapId - Optional admin capability object ID for privileged operations (required for admin functions)
      */
     constructor(protocolSDK: SDK, oftPackageId: string, // the OFT package id
-    oftObjectId: string, coinType: string, adminCapId?: string);
+    oftObjectId: string, coinType: string, oappObjectId: string, // the associated oapp object id
+    adminCapId?: string);
     /**
-     * Register OFT as an OApp with LayerZero endpoint
+     * Updates the associated OApp object ID
+     * @param oappObjectId - The new OApp object ID
+     */
+    setOappObjectId(oappObjectId: string): void;
+    /**
+     * Initialize an OFT instance with a treasury capability
+     * Creates a new OFT that mints its own tokens
      * @param tx - The transaction to add the move call to
-     * @param lzReceiveInfo - PTB Builder lzReceiveInfoMoveCall result, used for protocol SDK to dynamically build the PTB
-     * for OFT's lzReceive operation
+     * @param ticket - The OFTCreationTicket object ID or TransactionArgument
+     * @param treasury - The TreasuryCap object ID or TransactionArgument for the coin type
+     * @param metadata - The CoinMetadata object ID or TransactionArgument for the coin type
+     * @param sharedDecimals - Number of decimals to use for cross-chain operations
+     * @returns TransactionResult array containing [AdminCap, MigrationCap] - MigrationCap must be transferred or stored
      */
-    registerOAppMoveCall(tx: Transaction, lzReceiveInfo: Uint8Array | TransactionArgument): void;
+    initOftMoveCall(tx: Transaction, ticket: string | TransactionArgument, oapp: string | TransactionArgument, treasury: string | TransactionArgument, metadata: string | TransactionArgument, sharedDecimals: number | TransactionArgument): TransactionResult;
     /**
-     * Set enforced options for OFT messaging to a destination
+     * Initialize an OFT adapter instance
+     * Creates an OFT adapter that wraps an existing coin type
      * @param tx - The transaction to add the move call to
-     * @param eid - Endpoint ID
-     * @param msgType - Message type (SEND or SEND_AND_CALL)
-     * @param options - Enforced options as bytes
+     * @param ticket - The OFTCreationTicket object ID or TransactionArgument
+     * @param metadata - The CoinMetadata object ID or TransactionArgument for the coin type
+     * @param sharedDecimals - Number of decimals to use for cross-chain operations
+     * @returns TransactionResult array containing [AdminCap, MigrationCap] - MigrationCap must be transferred or stored
      */
-    setEnforcedOptionsMoveCall(tx: Transaction, eid: number | TransactionArgument, msgType: number | TransactionArgument, options: Uint8Array | TransactionArgument): void;
+    initOftAdapterMoveCall(tx: Transaction, ticket: string | TransactionArgument, oapp: string | TransactionArgument, metadata: string | TransactionArgument, sharedDecimals: number | TransactionArgument): TransactionResult;
     /**
-     * Set peer OFT on another chain
+     * Get LayerZero receive information for OFT registration
+     *
+     * This function prepares the necessary metadata for registering an OFT
+     * with the LayerZero endpoint, enabling it to receive cross-chain messages.
+     *
      * @param tx - The transaction to add the move call to
-     * @param messagingChannel - The messaging channel object ID
-     * @param eid - Peer endpoint ID
-     * @param peer - Peer OFT address as bytes
+     * @param composerManager - The composer manager object ID for routing compose transfers
+     * @returns TransactionResult containing serialized execution metadata for endpoint registration
      */
-    setPeerMoveCall(tx: Transaction, messagingChannel: string | TransactionArgument, eid: number | TransactionArgument, peer: Uint8Array | TransactionArgument): void;
+    lzReceiveInfoMoveCall(tx: Transaction, composerManager: string | TransactionArgument): TransactionResult;
     /**
-     * Set delegate for OFT
+     * Register OFT as an OApp with LayerZero endpoint
      * @param tx - The transaction to add the move call to
-     * @param newDelegate - The new delegate address
+     * @param lzReceiveInfo - PTB Builder lzReceiveInfoMoveCall result, used for protocol SDK to dynamically build the PTB
+     * for OFT's lzReceive operation
      */
-    setDelegateMoveCall(tx: Transaction, newDelegate: string | TransactionArgument): void;
+    registerOAppMoveCall(tx: Transaction, lzReceiveInfo: Uint8Array | TransactionArgument): void;
     /**
      * Set pause state for OFT operations
      * @param tx - The transaction to add the move call to
@@ -131,12 +150,27 @@ declare class OFT {
      * @param feeDepositAddress - The new fee deposit address
      */
     setFeeDepositAddressMoveCall(tx: Transaction, feeDepositAddress: string | TransactionArgument): void;
+    setDefaultFeeBpsMoveCall(tx: Transaction, feeBps: bigint | number | string | TransactionArgument): void;
+    /**
+     * Set fee basis points for a specific destination chain
+     * @param tx - The transaction to add the move call to
+     * @param dstEid - Destination endpoint ID
+     * @param feeBps - Fee rate in basis points (0-10,000, where 10,000 = 100%)
+     */
+    setFeeBpsMoveCall(tx: Transaction, dstEid: number | TransactionArgument, feeBps: bigint | number | string | TransactionArgument): void;
+    /**
+     * Removes the fee rate for a specific destination chain
+     * @param tx - The transaction to add the move call to
+     * @param dstEid - Destination endpoint ID
+     */
+    unsetFeeBpsMoveCall(tx: Transaction, dstEid: number | TransactionArgument): void;
     /**
-     * Set fee basis points for OFT transfers
+     * Migrate OFT instance to a new contract
      * @param tx - The transaction to add the move call to
-     * @param feeBps - The fee in basis points
+     * @param migrationCap - Migration capability object ID or transaction argument
+     * @returns TransactionResult containing the migration ticket
      */
-    setFeeBpsMoveCall(tx: Transaction, feeBps: bigint | number | string | TransactionArgument): void;
+    migrateMoveCall(tx: Transaction, migrationCap: string | TransactionArgument): TransactionResult;
     /**
      * Set rate limit for OFT transfers
      * @param tx - The transaction to add the move call to
@@ -176,6 +210,29 @@ declare class OFT {
      * @returns Promise<TransactionResult> - Transaction result containing send operation and receipt objects
      */
     sendMoveCall(tx: Transaction, sender: string, sendParam: SendParam | TransactionArgument, coinProvided: string | TransactionArgument, nativeFee: bigint | TransactionArgument, zroFee: bigint | TransactionArgument, refundAddress: string | TransactionArgument, validators?: IPTBValidator[], maxSimulationTimes?: number): Promise<void>;
+    /**
+     * Process inbound cross-chain token transfers
+     * @param tx - The transaction to add the move call to
+     * @param call - LayerZero receive call containing the verified cross-chain message
+     * @returns TransactionResult containing the processed transfer
+     */
+    lzReceiveMoveCall(tx: Transaction, call: string | TransactionArgument): TransactionResult;
+    /**
+     * Process inbound cross-chain token transfers with compose functionality
+     * @param tx - The transaction to add the move call to
+     * @param composeQueue - The composer's message queue for sequencing operations
+     * @param composerManager - Manager managing token deposits for composers
+     * @param call - LayerZero receive call containing the verified cross-chain message
+     * @returns TransactionResult containing the processed transfer
+     */
+    lzReceiveWithComposeMoveCall(tx: Transaction, composeQueue: string | TransactionArgument, composerManager: string | TransactionArgument, call: string | TransactionArgument): TransactionResult;
+    /**
+     * Confirms and extracts results from a quote operation
+     * @param tx - The transaction to add the move call to
+     * @param call - Completed Call object from quote_send() execution
+     * @returns TransactionResult containing the messaging fee
+     */
+    confirmQuoteSendMoveCall(tx: Transaction, call: string | TransactionArgument): TransactionResult;
     /**
      * Quote OFT sending operation with detailed fee breakdown
      * @param sendParam - Send parameters for the OFT operation
@@ -194,6 +251,28 @@ declare class OFT {
      * @returns Promise<MessagingFee> - The calculated messaging fees
      */
     quoteSend(sender: string, sendParam: SendParam | TransactionArgument, payInZro: boolean | TransactionArgument, validators?: IPTBValidator[], maxSimulationTimes?: number): Promise<MessagingFee>;
+    /**
+     * Get the upgrade version of this OFT instance
+     * @param tx - The transaction to add the move call to
+     * @returns Transaction result containing the upgrade version
+     */
+    upgradeVersionMoveCall(tx: Transaction): TransactionResult;
+    /**
+     * Get the upgrade version of this OFT instance
+     * @returns Promise<bigint> - The upgrade version
+     */
+    upgradeVersion(): Promise<bigint>;
+    /**
+     * Get the associated OApp object address
+     * @param tx - The transaction to add the move call to
+     * @returns Transaction result containing the OApp object address
+     */
+    oappObjectMoveCall(tx: Transaction): TransactionResult;
+    /**
+     * Get the associated OApp object address
+     * @returns Promise<string> - The OApp object address
+     */
+    oappObject(): Promise<string>;
     /**
      * Get OFT version information
      * @param tx - The transaction to add the move call to
@@ -208,8 +287,19 @@ declare class OFT {
         major: number;
         minor: number;
     }>;
-    oftAddressMoveCall(tx: Transaction): TransactionResult;
-    oftAddress(): Promise<string>;
+    oftCapIdMoveCall(tx: Transaction): TransactionResult;
+    oftCapId(): Promise<string>;
+    /**
+     * Get the migration capability address for this OFT
+     * @param tx - The transaction to add the move call to
+     * @returns Transaction result containing the migration capability address
+     */
+    migrationCapMoveCall(tx: Transaction): TransactionResult;
+    /**
+     * Get the migration capability address for this OFT
+     * @returns Promise<string> - The migration capability address
+     */
+    migrationCap(): Promise<string>;
     messagingChannel(): Promise<string>;
     /**
      * Get coin metadata address
@@ -223,16 +313,16 @@ declare class OFT {
      */
     coinMetadata(): Promise<string>;
     /**
-     * Get OFT admin address
+     * Get OFT admin capability address
      * @param tx - The transaction to add the move call to
-     * @returns Transaction result containing the admin address
+     * @returns Transaction result containing the admin capability address
      */
-    adminMoveCall(tx: Transaction): TransactionResult;
+    adminCapMoveCall(tx: Transaction): TransactionResult;
     /**
-     * Get OFT admin address
-     * @returns Promise<string> - The admin address
+     * Get OFT admin capability address
+     * @returns Promise<string> - The admin capability address
      */
-    admin(): Promise<string>;
+    adminCap(): Promise<string>;
     /**
      * Get shared decimals for cross-chain compatibility
      * @param tx - The transaction to add the move call to
@@ -244,6 +334,17 @@ declare class OFT {
      * @returns Promise<number> - The shared decimal precision
      */
     sharedDecimals(): Promise<number>;
+    /**
+     * Get the decimal conversion rate for this OFT
+     * @param tx - The transaction to add the move call to
+     * @returns Transaction result containing the decimal conversion rate
+     */
+    decimalConversionRateMoveCall(tx: Transaction): TransactionResult;
+    /**
+     * Get the decimal conversion rate for this OFT
+     * @returns Promise<bigint> - The decimal conversion rate multiplier
+     */
+    decimalConversionRate(): Promise<bigint>;
     /**
      * Check if OFT is paused
      * @param tx - The transaction to add the move call to
@@ -267,16 +368,55 @@ declare class OFT {
      */
     isAdapter(): Promise<boolean>;
     /**
-     * Get fee basis points for OFT transfers
+     * Check if the OFT has a fee rate greater than 0 for the specified destination
      * @param tx - The transaction to add the move call to
+     * @param dstEid - Destination endpoint ID
+     * @returns Transaction result containing whether fee exists
+     */
+    hasOftFeeMoveCall(tx: Transaction, dstEid: number | TransactionArgument): TransactionResult;
+    /**
+     * Check if the OFT has a fee rate greater than 0 for the specified destination
+     * @param dstEid - Destination endpoint ID
+     * @returns Promise<boolean> - True if fee exists
+     */
+    hasOftFee(dstEid: number): Promise<boolean>;
+    /**
+     * Get the effective fee rate for a specific destination chain
+     * @param tx - The transaction to add the move call to
+     * @param dstEid - Destination endpoint ID
+     * @returns Transaction result containing the effective fee basis points
+     */
+    effectiveFeeBpsMoveCall(tx: Transaction, dstEid: number | TransactionArgument): TransactionResult;
+    /**
+     * Get the effective fee rate for a specific destination chain
+     * @param dstEid - Destination endpoint ID
+     * @returns Promise<bigint> - The effective fee in basis points
+     */
+    effectiveFeeBps(dstEid: number): Promise<bigint>;
+    /**
+     * Get the default fee rate
+     * @param tx - The transaction to add the move call to
+     * @returns Transaction result containing the default fee basis points
+     */
+    defaultFeeBpsMoveCall(tx: Transaction): TransactionResult;
+    /**
+     * Get the default fee rate
+     * @returns Promise<bigint> - The default fee in basis points
+     */
+    defaultFeeBps(): Promise<bigint>;
+    /**
+     * Get fee basis points for a specific destination chain
+     * @param tx - The transaction to add the move call to
+     * @param dstEid - Destination endpoint ID
      * @returns Transaction result containing the fee basis points
      */
-    feeBpsMoveCall(tx: Transaction): TransactionResult;
+    feeBpsMoveCall(tx: Transaction, dstEid: number | TransactionArgument): TransactionResult;
     /**
-     * Get fee basis points for OFT transfers
+     * Get fee basis points for a specific destination chain
+     * @param dstEid - Destination endpoint ID
      * @returns Promise<bigint> - The fee in basis points
      */
-    feeBps(): Promise<bigint>;
+    feeBps(dstEid: number): Promise<bigint>;
     /**
      * Get fee deposit address for OFT
      * @param tx - The transaction to add the move call to
@@ -336,78 +476,20 @@ declare class OFT {
      * @returns Promise<bigint> - Remaining rate limit capacity
      */
     rateLimitCapacity(eid: number, inbound: boolean): Promise<bigint>;
-    /**
-     * Combine enforced options with extra options
-     * @param tx - The transaction to add the move call to
-     * @param eid - Endpoint ID
-     * @param msgType - Message type
-     * @param extraOptions - Extra options to combine with enforced options
-     * @returns Transaction result containing the combined options
-     */
-    combineOptionsMoveCall(tx: Transaction, eid: number | TransactionArgument, msgType: number | TransactionArgument, extraOptions: Uint8Array | TransactionArgument): TransactionResult;
-    /**
-     * Combine enforced options with extra options
-     * @param eid - Endpoint ID
-     * @param msgType - Message type
-     * @param extraOptions - Extra options to combine with enforced options
-     * @returns Promise<Uint8Array> - The combined options as bytes
-     */
-    combineOptions(eid: number, msgType: number, extraOptions: Uint8Array): Promise<Uint8Array>;
-    /**
-     * Get enforced options for OFT messaging
-     * @param tx - The transaction to add the move call to
-     * @param eid - Endpoint ID
-     * @param msgType - Message type
-     * @returns Transaction result containing the enforced options
-     */
-    getEnforcedOptionsMoveCall(tx: Transaction, eid: number | TransactionArgument, msgType: number | TransactionArgument): TransactionResult;
-    /**
-     * Get enforced options for OFT messaging
-     * @param eid - Endpoint ID
-     * @param msgType - Message type
-     * @returns Promise<Uint8Array> - The enforced options as bytes
-     */
-    getEnforcedOptions(eid: number, msgType: number): Promise<Uint8Array>;
-    /**
-     * Check if OFT has a peer on specific endpoint
-     * @param tx - The transaction to add the move call to
-     * @param eid - Endpoint ID
-     * @returns Transaction result containing the peer existence status
-     */
-    hasPeerMoveCall(tx: Transaction, eid: number | TransactionArgument): TransactionResult;
-    /**
-     * Check if OFT has a peer on specific endpoint
-     * @param eid - Endpoint ID
-     * @returns Promise<boolean> - True if peer exists on the endpoint
-     */
-    hasPeer(eid: number): Promise<boolean>;
-    /**
-     * Get peer OFT address on specific endpoint
-     * @param tx - The transaction to add the move call to
-     * @param eid - Endpoint ID
-     * @returns Transaction result containing the peer address
-     */
-    getPeerMoveCall(tx: Transaction, eid: number | TransactionArgument): TransactionResult;
-    /**
-     * Get peer OFT address on specific endpoint
-     * @param eid - Endpoint ID
-     * @returns Promise<Uint8Array> - The peer address as bytes32
-     */
-    getPeer(eid: number): Promise<Uint8Array>;
     txSenderMoveCall(tx: Transaction): TransactionResult;
 }
 
-declare const OFTComposerRegistryErrorCode: {
+declare const OFTComposerManagerErrorCode: {
     readonly EComposeTransferNotFound: 1;
     readonly EDepositAddressNotFound: 2;
 };
 /**
- * OFT Composer Registry
+ * OFT Composer Manager
  *
  * This class manages the registry for OFT Composer operations, including
  * deposit addresses and compose transfer routing for cross-chain composition.
  */
-declare class OFTComposerRegistry {
+declare class OFTComposerManager {
     #private;
     packageId: string;
     readonly client: SuiClient;
@@ -448,33 +530,6 @@ declare class OFTComposerRegistry {
     getComposeTransfer(from: string, guid: Uint8Array, composer: string): Promise<string>;
 }
 
-/**
- * OFT PTB (Programmable Transaction Block) Builder
- *
- * This class provides utility functions for building programmable transactions
- * for OFT operations, particularly for LayerZero receive operations.
- */
-declare class OFTPtbBuilder {
-    packageId: string;
-    objectId: string;
-    readonly client: SuiClient;
-    readonly coinType: string;
-    readonly oftObjectId: string;
-    readonly objects: ObjectOptions;
-    constructor(protocolSDK: SDK, packageId: string, objectId: string, client: SuiClient, coinType: string, oftObjectId: string);
-    /**
-     * Get LayerZero receive information for OFT registration
-     *
-     * This function prepares the necessary metadata for registering an OFT
-     * with the LayerZero endpoint, enabling it to receive cross-chain messages.
-     *
-     * @param tx - The transaction to add the move call to
-     * @param composerRegistry - The composer registry object ID for routing compose transfers
-     * @returns TransactionResult containing serialized execution metadata for endpoint registration
-     */
-    lzReceiveInfoMoveCall(tx: Transaction$1, composerRegistry: string | TransactionArgument$1): TransactionResult$1;
-}
-
 declare const OFTLimitBcs: _mysten_sui_dist_cjs_bcs.BcsType<{
     min_amount_ld: string;
     max_amount_ld: string;
@@ -502,4 +557,4 @@ declare function parseOFTLimit(data: Uint8Array): OFTLimit;
 declare function parseOFTFeeDetails(data: Uint8Array): OFTFeeDetail[];
 declare function parseOFTReceipt(data: Uint8Array): OFTReceipt;
 
-export { OFT, OFTComposerRegistry, OFTComposerRegistryErrorCode, OFTErrorCode, type OFTFeeDetail, OFTFeeDetailBcs, type OFTLimit, OFTLimitBcs, OFTMsgType, OFTPtbBuilder, type OFTReceipt, OFTReceiptBcs, type SendParam, parseOFTFeeDetails, parseOFTLimit, parseOFTReceipt };
+export { OFT, OFTComposerManager, OFTComposerManagerErrorCode, OFTErrorCode, type OFTFeeDetail, OFTFeeDetailBcs, type OFTLimit, OFTLimitBcs, OFTMsgType, type OFTReceipt, OFTReceiptBcs, type SendParam, parseOFTFeeDetails, parseOFTLimit, parseOFTReceipt };