@layerzerolabs/lz-sui-sdk-v2 3.0.73 → 3.0.75

package/dist/index.d.ts

@@ -1,24 +1,353 @@
-import { Transaction } from '@mysten/sui/transactions';
-
-declare function initEid(): Promise<Transaction>;
-declare function eid(): Promise<number>;
-declare function getSendLibrary(sender: string, dst_eid: number): Promise<string>;
-declare function getConfig(): Promise<string>;
-declare function populateQuoteTransaction(tx: Transaction): Promise<void>;
-declare function populateSendTransaction(tx: Transaction): Promise<void>;
-declare function populateGetConfigTransaction(tx: Transaction): Promise<void>;
-declare function populateSetConfigTransaction(tx: Transaction): Promise<void>;
-
-declare const endpoint_eid: typeof eid;
-  declare const endpoint_getConfig: typeof getConfig;
-  declare const endpoint_getSendLibrary: typeof getSendLibrary;
-  declare const endpoint_initEid: typeof initEid;
-  declare const endpoint_populateGetConfigTransaction: typeof populateGetConfigTransaction;
-  declare const endpoint_populateQuoteTransaction: typeof populateQuoteTransaction;
-  declare const endpoint_populateSendTransaction: typeof populateSendTransaction;
-  declare const endpoint_populateSetConfigTransaction: typeof populateSetConfigTransaction;
-  declare namespace endpoint {
-  export { endpoint_eid as eid, endpoint_getConfig as getConfig, endpoint_getSendLibrary as getSendLibrary, endpoint_initEid as initEid, endpoint_populateGetConfigTransaction as populateGetConfigTransaction, endpoint_populateQuoteTransaction as populateQuoteTransaction, endpoint_populateSendTransaction as populateSendTransaction, endpoint_populateSetConfigTransaction as populateSetConfigTransaction };
-}
-
-export { endpoint };
+import { SuiClient, SuiTransactionBlockResponse, SuiExecutionResult } from '@mysten/sui/client';
+import { Transaction, TransactionResult } from '@mysten/sui/transactions';
+import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
+import { EndpointId, Stage, Chain } from '@layerzerolabs/lz-definitions';
+import { Keypair } from '@mysten/sui/cryptography';
+import { Provider } from '@layerzerolabs/lz-core';
+import * as _mysten_sui_dist_cjs_bcs from '@mysten/sui/dist/cjs/bcs';
+
+/**
+ * Type representing the options for packages.
+ */
+type PackageOptions = {
+    /**
+     * The endpoint V2 address.
+     */
+    endpoint_v2: string;
+    /**
+     * The counter V2 address.
+     */
+    counter_v2: string;
+    /**
+     * The simple message library address.
+     */
+    simple_message_lib: string;
+    /**
+     * The zro address.
+     */
+    zro: string;
+    /**
+     * The utils address.
+     */
+    utils: string;
+} & {
+    [key: string]: string;
+};
+/**
+ * Type representing the options for objects.
+ */
+type ObjectOptions = {
+    /**
+     * The endpoint V2 object address.
+     */
+    endpoint_v2: string;
+    /**
+     * The simple message library object address.
+     */
+    simple_message_lib: string;
+    /**
+     * The ULN-302 message library object address.
+     */
+    uln_302: string;
+    /**
+     * The blocked message library object address.
+     */
+    blocked_message_lib: string;
+    /**
+     * The discovery object address for OApp discovery.
+     */
+    discovery: string;
+    /**
+     * The counter OApp object address.
+     */
+    counter: string;
+    /**
+     * The OApp core object address.
+     */
+    oapp_core: string;
+    /**
+     * The endpoint admin cap object address.
+     */
+    endpoint_admin_cap: string;
+    /**
+     * The counter admin cap object address.
+     */
+    counter_admin_cap: string;
+} & {
+    [key: string]: string;
+};
+interface Context {
+    endpoint: Endpoint;
+    counter: Counter;
+    simpleMessageLib: SimpleMessageLib;
+    utils: Utils;
+    zro: Zro;
+}
+
+declare class SimpleMessageLib {
+    private readonly context;
+    packageId: string;
+    readonly client: SuiClient;
+    private readonly objects;
+    constructor(packageId: string, client: SuiClient, objects: Pick<ObjectOptions, 'simple_message_lib' | 'endpoint_admin_cap' | 'endpoint_v2' | 'discovery'>, context: Context);
+    populateInitializeTransaction(): Transaction;
+    getNativeFee(): Promise<string>;
+    getZroFee(): Promise<string>;
+    getFeeRecipient(): Promise<string>;
+    isRegistered(): Promise<boolean>;
+    populateRegisterLibraryTransaction(): Transaction;
+    populateSetMessagingFeeTransaction(zroFee: number, nativeFee: number): Transaction;
+    populateSetDefaultConfigTransaction(eid: number, configType: number, config: Uint8Array): Transaction;
+    populateSetFeeRecipientTransaction(feeRecipient: string): Transaction;
+    populateValidatePacketTransaction(packetHeader: Uint8Array, payloadHash: Uint8Array): Transaction;
+    populateRegisterMessageLibDiscoveryTransaction(): Transaction;
+    quoteMoveCall(tx: Transaction, quoteCall: TransactionResult): TransactionResult;
+    sendMoveCall(tx: Transaction, sendCall: TransactionResult): TransactionResult;
+    populateQuoteTransaction(tx: Transaction): void;
+    populateSendTransaction(tx: Transaction): void;
+    populateSetConfigTransaction(tx: Transaction): void;
+    populateGetConfigTransaction(tx: Transaction): void;
+}
+
+declare class Endpoint {
+    private readonly context;
+    packageId: string;
+    readonly client: SuiClient;
+    private readonly objects;
+    constructor(packageId: string, client: SuiClient, objects: Pick<ObjectOptions, 'endpoint_v2' | 'endpoint_admin_cap'>, context: Context);
+    eid(): Promise<number>;
+    populateInitEidTransaction(eid: number): Transaction;
+    getDefaultSendLibrary(srcEid: number): Promise<string>;
+    populateSetDefaultSendLibraryTransaction(dstEid: number, newLib: string): Transaction;
+    getDefaultReceiveLibrary(srcEid: number): Promise<string>;
+    populateSetDefaultReceiveLibraryTransaction(srcEid: number, newLib: string, gracePeriod: number): Transaction;
+    confirmQuoteMoveCall(tx: Transaction, executedCall: TransactionResult): TransactionResult;
+    confirmSendMoveCall(tx: Transaction, executedCall: TransactionResult): TransactionResult;
+    getSendLibrary(sender: string, dstEid: number): Promise<[string, boolean]>;
+    getReceiveLibrary(receiver: string, srcEid: number): Promise<[string, boolean]>;
+    getInboundNonce(receiver: string, srcEid: number, sender: Uint8Array): Promise<bigint>;
+    getLazyInboundNonce(receiver: string, srcEid: number, sender: Uint8Array): Promise<bigint>;
+    getOutboundNonce(sender: string, dstEid: number, receiver: Uint8Array): Promise<bigint>;
+    getInboundPayloadHash(receiver: string, srcEid: number, sender: Uint8Array, nonce: bigint): Promise<Uint8Array | null>;
+    getComposeMessageHash(from: string, to: string, guid: Uint8Array, index: number): Promise<Uint8Array>;
+    populateQuoteTransaction(tx: Transaction): void;
+    populateSendTransaction(tx: Transaction): void;
+    populateGetConfigTransaction(tx: Transaction): void;
+    populateSetConfigTransaction(tx: Transaction): void;
+}
+
+declare class Counter {
+    private readonly context;
+    packageId: string;
+    utilsPkgId: string;
+    readonly client: SuiClient;
+    private readonly objects;
+    constructor(packageId: string, utilsPkgId: string, client: SuiClient, objects: Pick<ObjectOptions, 'counter' | 'counter_admin_cap' | 'endpoint_v2' | 'simple_message_lib'>, context: Context);
+    getPeer(dstEid: number): Promise<string>;
+    getCount(): Promise<number>;
+    getComposedCount(): Promise<number>;
+    populateSetPeerTransaction(dstEid: number, peer: Uint8Array): Transaction;
+    /**
+     * Builds a transaction for calling the lz_receive function on the counter contract.
+     *
+     * @param srcEid - The source endpoint ID
+     * @param sender - The sender address as Bytes32
+     * @param nonce - The nonce
+     * @param guid - The GUID as Bytes32
+     * @param message - The message as vector<u8>
+     * @param value - The value to be sent (Coin<SUI>)
+     * @param extraData - Extra data as vector<u8>
+     * @returns A Transaction object ready to be executed
+     */
+    populateLzReceiveTransaction(srcEid: number, sender: Uint8Array, nonce: bigint, guid: Uint8Array, message: Uint8Array, value: bigint, extraData?: Uint8Array): Transaction;
+    quote(dstEid: EndpointId, msgType: number, options: Uint8Array, payInZero: boolean): Promise<[bigint, bigint]>;
+    send(sender: Ed25519Keypair, dstEid: EndpointId, msgType: number, options: Uint8Array, sendValue: string, nativeFee: string, zroFee: string): Promise<SuiTransactionBlockResponse>;
+}
+
+declare class Utils {
+    packageId: string;
+    readonly client: SuiClient;
+    private readonly context;
+    constructor(packageId: string, client: SuiClient, context: Context);
+    fromBytesMoveCall(tx: Transaction, peer: Uint8Array): TransactionResult;
+    fromBytesLeftPaddedMoveCall(tx: Transaction, bytes: Uint8Array): TransactionResult;
+    fromBytesRightPaddedMoveCall(tx: Transaction, bytes: Uint8Array): TransactionResult;
+    fromAddressMoveCall(tx: Transaction, address: string): TransactionResult;
+    fromIdMoveCall(tx: Transaction, id: string): TransactionResult;
+    zeroBytes32MoveCall(tx: Transaction): TransactionResult;
+    ffBytes32MoveCall(tx: Transaction): TransactionResult;
+    isZeroMoveCall(tx: Transaction, bytes32: string): TransactionResult;
+    isFfMoveCall(tx: Transaction, bytes32: string): TransactionResult;
+    toBytesMoveCall(tx: Transaction, bytes32: string): TransactionResult;
+    toAddressMoveCall(tx: Transaction, bytes32: string): TransactionResult;
+    toIdMoveCall(tx: Transaction, bytes32: string): TransactionResult;
+    newReaderMoveCall(tx: Transaction, buffer: Uint8Array): TransactionResult;
+    newWriterMoveCall(tx: Transaction): TransactionResult;
+    createWriterMoveCall(tx: Transaction, buffer: Uint8Array): TransactionResult;
+    positionMoveCall(tx: Transaction, reader: TransactionResult): TransactionResult;
+    remainingLengthMoveCall(tx: Transaction, reader: TransactionResult): TransactionResult;
+    skipMoveCall(tx: Transaction, reader: TransactionResult, len: number): TransactionResult;
+    setPositionMoveCall(tx: Transaction, reader: TransactionResult, position: number): TransactionResult;
+    rewindMoveCall(tx: Transaction, reader: TransactionResult, len: number): TransactionResult;
+    readU8MoveCall(tx: Transaction, reader: TransactionResult): TransactionResult;
+    readU16MoveCall(tx: Transaction, reader: TransactionResult): TransactionResult;
+    readU32MoveCall(tx: Transaction, reader: TransactionResult): TransactionResult;
+    readU64MoveCall(tx: Transaction, reader: TransactionResult): TransactionResult;
+    readU128MoveCall(tx: Transaction, reader: TransactionResult): TransactionResult;
+    readU256MoveCall(tx: Transaction, reader: TransactionResult): TransactionResult;
+    readBytes32MoveCall(tx: Transaction, reader: TransactionResult): TransactionResult;
+    readAddressMoveCall(tx: Transaction, reader: TransactionResult): TransactionResult;
+    readFixedLenBytesMoveCall(tx: Transaction, reader: TransactionResult, len: number): TransactionResult;
+    readBytesUntilEndMoveCall(tx: Transaction, reader: TransactionResult): TransactionResult;
+    readerBufferLengthMoveCall(tx: Transaction, reader: TransactionResult): TransactionResult;
+    readerToBytesMoveCall(tx: Transaction, reader: TransactionResult): TransactionResult;
+    writerBufferLengthMoveCall(tx: Transaction, writer: TransactionResult): TransactionResult;
+    writerToBytesMoveCall(tx: Transaction, writer: TransactionResult): TransactionResult;
+    writeU8MoveCall(tx: Transaction, writer: TransactionResult, value: number): TransactionResult;
+    writeU16MoveCall(tx: Transaction, writer: TransactionResult, value: number): TransactionResult;
+    writeU32MoveCall(tx: Transaction, writer: TransactionResult, value: number): TransactionResult;
+    writeU64MoveCall(tx: Transaction, writer: TransactionResult, value: number): TransactionResult;
+    writeU128MoveCall(tx: Transaction, writer: TransactionResult, value: string): TransactionResult;
+    writeU256MoveCall(tx: Transaction, writer: TransactionResult, value: string): TransactionResult;
+    writeBytesMoveCall(tx: Transaction, writer: TransactionResult, bytes: Uint8Array): TransactionResult;
+    writeAddressMoveCall(tx: Transaction, writer: TransactionResult, address: string): TransactionResult;
+    writeBytes32MoveCall(tx: Transaction, writer: TransactionResult, bytes32: string): TransactionResult;
+    blake2b256MoveCall(tx: Transaction, bytes: Uint8Array): TransactionResult;
+    keccak256MoveCall(tx: Transaction, bytes: Uint8Array): TransactionResult;
+}
+
+declare class Zro {
+    private readonly context;
+    packageId: string;
+    readonly client: SuiClient;
+    constructor(packageId: string, client: SuiClient, context: Context);
+    zeroOptionMoveCall(tx: Transaction): TransactionResult;
+    noneOptionMoveCall(tx: Transaction): TransactionResult;
+}
+
+declare function devInspectTransaction(suiClient: SuiClient, tx: Transaction, sender: string): Promise<SuiExecutionResult[] | null | undefined>;
+declare function moveView(suiClient: SuiClient, tx: Transaction, sender?: string): Promise<SuiExecutionResult | null | undefined>;
+declare function readAddressFromDeployment(network: string, name: string): string | undefined;
+declare function validateTransaction(client: SuiClient, signer: Keypair, tx: Transaction): Promise<SuiTransactionBlockResponse>;
+
+/**
+ * Creates an instance of the SDK from the given provider.
+ *
+ * @param {unknown} provider - The provider of the current chain.
+ * @param {Stage} [stage] - The stage of the SDK. {@link Stage}
+ * @returns {SDK} The initialized SDK instance.
+ */
+declare function getSDKFromProvider(provider: Provider, stage?: Stage): SDK;
+/**
+ * Options for initializing the SDK.
+ */
+interface SdkOptions {
+    /**
+     * The chain for the SDK (optional).
+     * default value is Chain.SUI
+     */
+    chain?: Chain;
+    /**
+     * The Sui client for the SDK.
+     */
+    client: SuiClient;
+    /**
+     * The stage of the SDK (optional).
+     * default value is Stage.SANDBOX
+     */
+    stage?: Stage;
+    /**
+     * The package options for the SDK.
+     */
+    packages?: Partial<PackageOptions>;
+    /**
+     * The object options for the SDK.
+     */
+    objects?: Partial<ObjectOptions>;
+}
+/**
+ * The SDK class provides methods to interact with LayerZero on Sui.
+ * It initializes all modules at once and provides access to them.
+ */
+declare class SDK {
+    chain: Chain;
+    stage: Stage;
+    client: SuiClient;
+    readonly packages: PackageOptions;
+    readonly objects: ObjectOptions;
+    endpoint: Endpoint;
+    counter: Counter;
+    simpleMessageLib: SimpleMessageLib;
+    utils: Utils;
+    zro: Zro;
+    /**
+     * Creates an instance of the SDK.
+     *
+     * @param {SdkOptions} options - The SDK options.
+     */
+    constructor(options: SdkOptions);
+    /**
+     * Gets the Sui client.
+     *
+     * @returns {SuiClient} The Sui client.
+     */
+    getSuiClient(): SuiClient;
+    /**
+     * Gets the chain.
+     *
+     * @returns {Chain} The chain.
+     */
+    getChain(): Chain;
+    /**
+     * Gets the stage.
+     *
+     * @returns {Stage} The stage.
+     */
+    getStage(): Stage;
+    /**
+     * Gets the package options.
+     *
+     * @returns {PackageOptions} The package options.
+     */
+    getPackages(): PackageOptions;
+    /**
+     * Gets the object options.
+     *
+     * @returns {ObjectOptions} The object options.
+     */
+    getObjects(): ObjectOptions;
+    /**
+     * Gets the endpoint module.
+     *
+     * @returns {Endpoint} The endpoint module.
+     */
+    getEndpoint(): Endpoint;
+    /**
+     * Gets the counter module.
+     *
+     * @returns {Counter} The counter module.
+     */
+    getCounter(): Counter;
+    /**
+     * Gets the simple message library module.
+     *
+     * @returns {SimpleMessageLib} The simple message library module.
+     */
+    getSimpleMessageLib(): SimpleMessageLib;
+    /**
+     * Gets the utils module.
+     *
+     * @returns {Utils} The utils module.
+     */
+    getUtils(): Utils;
+}
+
+declare const MessagingFeeBcs: _mysten_sui_dist_cjs_bcs.BcsType<{
+    native_fee: string;
+    zro_fee: string;
+}, {
+    native_fee: string | number | bigint;
+    zro_fee: string | number | bigint;
+}>;
+
+export { type Context, Counter, Endpoint, MessagingFeeBcs, type ObjectOptions, type PackageOptions, SDK, type SdkOptions, SimpleMessageLib, Utils, Zro, devInspectTransaction, getSDKFromProvider, moveView, readAddressFromDeployment, validateTransaction };