@layerzerolabs/lz-v2-stellar-sdk 0.2.13 → 0.2.18

package/dist/generated/dvn_fee_lib.d.ts

@@ -0,0 +1,690 @@
+import { Buffer } from "buffer";
+import { AssembledTransaction, Client as ContractClient, ClientOptions as ContractClientOptions, MethodOptions } from '@stellar/stellar-sdk/contract';
+import type { u32, u64, u128, i128, Option } from '@stellar/stellar-sdk/contract';
+export * from '@stellar/stellar-sdk';
+export * as contract from '@stellar/stellar-sdk/contract';
+export * as rpc from '@stellar/stellar-sdk/rpc';
+export type MigrationData = void;
+export declare const DvnFeeLibError: {
+    1: {
+        message: string;
+    };
+    2: {
+        message: string;
+    };
+    3: {
+        message: string;
+    };
+    4: {
+        message: string;
+    };
+};
+/**
+ * BufferReaderError: 1000-1009
+ */
+export declare const BufferReaderError: {
+    1000: {
+        message: string;
+    };
+    1001: {
+        message: string;
+    };
+};
+/**
+ * BufferWriterError: 1010-1019
+ */
+export declare const BufferWriterError: {
+    1010: {
+        message: string;
+    };
+};
+/**
+ * TtlConfigurableError: 1020-1029
+ */
+export declare const TtlConfigurableError: {
+    1020: {
+        message: string;
+    };
+    1021: {
+        message: string;
+    };
+    1022: {
+        message: string;
+    };
+};
+/**
+ * OwnableError: 1030-1039
+ */
+export declare const OwnableError: {
+    1030: {
+        message: string;
+    };
+    1031: {
+        message: string;
+    };
+};
+/**
+ * BytesExtError: 1040-1049
+ */
+export declare const BytesExtError: {
+    1040: {
+        message: string;
+    };
+};
+/**
+ * UpgradeableError: 1050-1059
+ */
+export declare const UpgradeableError: {
+    1050: {
+        message: string;
+    };
+};
+/**
+ * MultisigError: 1060-1069
+ */
+export declare const MultisigError: {
+    1060: {
+        message: string;
+    };
+    1061: {
+        message: string;
+    };
+    1062: {
+        message: string;
+    };
+    1063: {
+        message: string;
+    };
+    1064: {
+        message: string;
+    };
+    1065: {
+        message: string;
+    };
+    1066: {
+        message: string;
+    };
+    1067: {
+        message: string;
+    };
+};
+export type MultisigStorage = {
+    tag: "Signers";
+    values: void;
+} | {
+    tag: "Threshold";
+    values: void;
+};
+export type OwnableStorage = {
+    tag: "Owner";
+    values: void;
+};
+/**
+ * TTL configuration: threshold (when to extend) and extend_to (target TTL).
+ */
+export interface TtlConfig {
+    /**
+   * Target TTL after extension (in ledgers).
+   */
+    extend_to: u32;
+    /**
+   * TTL threshold that triggers extension (in ledgers).
+   */
+    threshold: u32;
+}
+export type TtlConfigStorage = {
+    tag: "Frozen";
+    values: void;
+} | {
+    tag: "Instance";
+    values: void;
+} | {
+    tag: "Persistent";
+    values: void;
+};
+export type UpgradeableStorage = {
+    tag: "Migrating";
+    values: void;
+};
+/**
+ * WorkerError: 1200-1299
+ */
+export declare const WorkerError: {
+    1200: {
+        message: string;
+    };
+    1201: {
+        message: string;
+    };
+    1202: {
+        message: string;
+    };
+    1203: {
+        message: string;
+    };
+    1204: {
+        message: string;
+    };
+    1205: {
+        message: string;
+    };
+    1206: {
+        message: string;
+    };
+    1207: {
+        message: string;
+    };
+    1208: {
+        message: string;
+    };
+    1209: {
+        message: string;
+    };
+    1210: {
+        message: string;
+    };
+    1211: {
+        message: string;
+    };
+    1212: {
+        message: string;
+    };
+    1213: {
+        message: string;
+    };
+    1214: {
+        message: string;
+    };
+    1215: {
+        message: string;
+    };
+    1216: {
+        message: string;
+    };
+    1217: {
+        message: string;
+    };
+    1218: {
+        message: string;
+    };
+};
+/**
+ * Parameters for DVN fee calculation.
+ *
+ * Contains all inputs needed by the fee library to calculate verification fees
+ * for cross-chain messages. Includes message parameters, common configuration,
+ * and destination-specific settings.
+ */
+export interface DvnFeeParams {
+    /**
+   * Number of block confirmations required.
+   */
+    confirmations: u64;
+    /**
+   * Default fee multiplier in basis points (used if no dst-specific multiplier).
+   */
+    default_multiplier_bps: u32;
+    /**
+   * Destination endpoint ID (chain identifier).
+   */
+    dst_eid: u32;
+    /**
+   * Minimum fee margin in USD (scaled).
+   */
+    floor_margin_usd: u128;
+    /**
+   * ============================================================================================
+   * Destination-Specific Configuration
+   * ============================================================================================
+   * Gas estimate for verification on destination chain.
+   */
+    gas: u128;
+    /**
+   * Destination-specific fee multiplier in basis points (0 = use default).
+   */
+    multiplier_bps: u32;
+    /**
+   * DVN options
+   */
+    options: Buffer;
+    /**
+   * ============================================================================================
+   * Common Configuration
+   * ============================================================================================
+   * Price feed contract address for gas price and exchange rate data.
+   */
+    price_feed: string;
+    /**
+   * Number of required signatures (quorum).
+   */
+    quorum: u32;
+    /**
+   * ============================================================================================
+   * Message Parameters
+   * ============================================================================================
+   * The OApp sender address.
+   */
+    sender: string;
+}
+/**
+ * Parameters for executor fee calculation.
+ *
+ * Contains all inputs needed by the fee library to calculate execution fees
+ * for cross-chain messages. Includes message parameters, common configuration,
+ * and destination-specific settings.
+ */
+export interface FeeParams {
+    /**
+   * Size of the message calldata in bytes.
+   */
+    calldata_size: u32;
+    /**
+   * Default fee multiplier in basis points (used if no dst-specific multiplier).
+   */
+    default_multiplier_bps: u32;
+    /**
+   * Destination endpoint ID (chain identifier).
+   */
+    dst_eid: u32;
+    /**
+   * Minimum fee margin in USD (scaled).
+   */
+    floor_margin_usd: u128;
+    /**
+   * Base gas for each lzCompose call on destination chain.
+   */
+    lz_compose_base_gas: u64;
+    /**
+   * ============================================================================================
+   * Destination-Specific Configuration
+   * ============================================================================================
+   * Base gas for lzReceive execution on destination chain.
+   */
+    lz_receive_base_gas: u64;
+    /**
+   * Destination-specific fee multiplier in basis points (0 = use default).
+   */
+    multiplier_bps: u32;
+    /**
+   * Maximum native token value that can be sent.
+   */
+    native_cap: u128;
+    /**
+   * Encoded executor options (lzReceive gas, lzCompose, nativeDrop, etc.).
+   */
+    options: Buffer;
+    /**
+   * ============================================================================================
+   * Common Configuration
+   * ============================================================================================
+   * Price feed contract address for gas price and exchange rate data.
+   */
+    price_feed: string;
+    /**
+   * ============================================================================================
+   * Message Parameters
+   * ============================================================================================
+   * The OApp sender address.
+   */
+    sender: string;
+}
+/**
+ * Gas price information for a destination endpoint.
+ *
+ * Contains the exchange rate and gas costs needed for cross-chain fee calculations.
+ */
+export interface Price {
+    /**
+   * Gas cost per byte of calldata on the destination chain.
+   */
+    gas_per_byte: u32;
+    /**
+   * Gas price in the smallest unit (wei for EVM, stroops for Stellar).
+   */
+    gas_price_in_unit: u64;
+    /**
+   * Price ratio = (remote native token price / local native token price) * PRICE_RATIO_DENOMINATOR.
+   * Used to convert destination chain gas costs to source chain native token.
+   */
+    price_ratio: u128;
+}
+/**
+ * Fee estimation result with detailed breakdown.
+ *
+ * Contains the calculated fee and all intermediate values used in the calculation.
+ */
+export interface FeeEstimate {
+    /**
+   * Source chain native token price in USD (scaled).
+   */
+    native_price_usd: u128;
+    /**
+   * Price ratio used for the calculation.
+   */
+    price_ratio: u128;
+    /**
+   * Denominator for the price ratio (typically 10^20).
+   */
+    price_ratio_denominator: u128;
+    /**
+   * Total gas fee in source chain native token units.
+   */
+    total_gas_fee: i128;
+}
+export type WorkerStorage = {
+    tag: "Paused";
+    values: void;
+} | {
+    tag: "DepositAddress";
+    values: void;
+} | {
+    tag: "PriceFeed";
+    values: void;
+} | {
+    tag: "WorkerFeeLib";
+    values: void;
+} | {
+    tag: "DefaultMultiplierBps";
+    values: void;
+} | {
+    tag: "SupportedOptionTypes";
+    values: readonly [u32];
+} | {
+    tag: "MessageLibs";
+    values: void;
+} | {
+    tag: "Allowlist";
+    values: readonly [string];
+} | {
+    tag: "Denylist";
+    values: readonly [string];
+} | {
+    tag: "AllowlistSize";
+    values: void;
+} | {
+    tag: "Admins";
+    values: void;
+};
+export interface Client {
+    /**
+     * Construct and simulate a upgrade transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    upgrade: ({ new_wasm_hash }: {
+        new_wasm_hash: Buffer;
+    }, txnOptions?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a migrate transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    migrate: ({ migration_data }: {
+        migration_data: MigrationData;
+    }, txnOptions?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a authorizer transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    authorizer: (txnOptions?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<string>>;
+    /**
+     * Construct and simulate a get_fee transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     */
+    get_fee: ({ dvn, params }: {
+        dvn: string;
+        params: DvnFeeParams;
+    }, txnOptions?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<i128>>;
+    /**
+     * Construct and simulate a set_ttl_configs transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     * Sets TTL configs for instance and persistent storage.
+     *
+     * - `None` values remove the corresponding config (disables auto-extension for that type)
+     * - Validates that `threshold <= extend_to <= MAX_TTL`
+     *
+     * # Arguments
+     * - `instance` - TTL config for instance storage
+     * - `persistent` - TTL config for persistent storage
+     *
+     * # Panics
+     * - `TtlConfigFrozen` if configs are frozen
+     * - `InvalidTtlConfig` if validation fails
+     */
+    set_ttl_configs: ({ instance, persistent }: {
+        instance: Option<TtlConfig>;
+        persistent: Option<TtlConfig>;
+    }, txnOptions?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a ttl_configs transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     * Returns the current TTL configs as (instance_config, persistent_config).
+     */
+    ttl_configs: (txnOptions?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<readonly [Option<TtlConfig>, Option<TtlConfig>]>>;
+    /**
+     * Construct and simulate a freeze_ttl_configs transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     * Permanently freezes TTL configs, preventing any future modifications.
+     *
+     * This is irreversible and provides immutability guarantees to users.
+     * Emits `TtlConfigsFrozen` event.
+     *
+     * # Panics
+     * - `TtlConfigAlreadyFrozen` if already frozen
+     */
+    freeze_ttl_configs: (txnOptions?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a is_ttl_configs_frozen transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     * Returns whether TTL configs are frozen.
+     */
+    is_ttl_configs_frozen: (txnOptions?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<boolean>>;
+    /**
+     * Construct and simulate a extend_instance_ttl transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     * Extends the instance TTL.
+     *
+     * # Arguments
+     *
+     * * `threshold` - The threshold to extend the TTL (if current TTL is below this, extend).
+     * * `extend_to` - The TTL to extend to.
+     */
+    extend_instance_ttl: ({ threshold, extend_to }: {
+        threshold: u32;
+        extend_to: u32;
+    }, txnOptions?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a owner transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     * Returns the current owner address, or None if no owner is set.
+     */
+    owner: (txnOptions?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<Option<string>>>;
+    /**
+     * Construct and simulate a transfer_ownership transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     * Transfers ownership to a new address. Requires current owner authorization.
+     */
+    transfer_ownership: ({ new_owner }: {
+        new_owner: string;
+    }, txnOptions?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<null>>;
+    /**
+     * Construct and simulate a renounce_ownership transaction. Returns an `AssembledTransaction` object which will have a `result` field containing the result of the simulation. If this transaction changes contract state, you will need to call `signAndSend()` on the returned object.
+     * Permanently renounces ownership. Requires current owner authorization.
+     */
+    renounce_ownership: (txnOptions?: {
+        /**
+         * The fee to pay for the transaction. Default: BASE_FEE
+         */
+        fee?: number;
+        /**
+         * The maximum amount of time to wait for the transaction to complete. Default: DEFAULT_TIMEOUT
+         */
+        timeoutInSeconds?: number;
+        /**
+         * Whether to automatically simulate the transaction when constructing the AssembledTransaction. Default: true
+         */
+        simulate?: boolean;
+    }) => Promise<AssembledTransaction<null>>;
+}
+export declare class Client extends ContractClient {
+    readonly options: ContractClientOptions;
+    static deploy<T = Client>(
+    /** Constructor/Initialization Args for the contract's `__constructor` method */
+    { owner }: {
+        owner: string;
+    }, 
+    /** Options for initializing a Client as well as for calling a method, with extras specific to deploying. */
+    options: MethodOptions & Omit<ContractClientOptions, "contractId"> & {
+        /** The hash of the Wasm blob, which must already be installed on-chain. */
+        wasmHash: Buffer | string;
+        /** Salt used to generate the contract's ID. Passed through to {@link Operation.createCustomContract}. Default: random. */
+        salt?: Buffer | Uint8Array;
+        /** The format used to decode `wasmHash`, if it's provided as a string. */
+        format?: "hex" | "base64";
+    }): Promise<AssembledTransaction<T>>;
+    constructor(options: ContractClientOptions);
+    readonly fromJSON: {
+        upgrade: (json: string) => AssembledTransaction<null>;
+        migrate: (json: string) => AssembledTransaction<null>;
+        authorizer: (json: string) => AssembledTransaction<string>;
+        get_fee: (json: string) => AssembledTransaction<bigint>;
+        set_ttl_configs: (json: string) => AssembledTransaction<null>;
+        ttl_configs: (json: string) => AssembledTransaction<readonly [Option<TtlConfig>, Option<TtlConfig>]>;
+        freeze_ttl_configs: (json: string) => AssembledTransaction<null>;
+        is_ttl_configs_frozen: (json: string) => AssembledTransaction<boolean>;
+        extend_instance_ttl: (json: string) => AssembledTransaction<null>;
+        owner: (json: string) => AssembledTransaction<Option<string>>;
+        transfer_ownership: (json: string) => AssembledTransaction<null>;
+        renounce_ownership: (json: string) => AssembledTransaction<null>;
+    };
+}