@waterx/sdk 3.0.1 → 3.0.3

package/dist/cjs/src/generated/native_custody/custody_vault.d.ts

@@ -0,0 +1,586 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { MoveStruct, MoveTuple, type RawTransactionArgument } from '../utils/index.ts';
+import { type BcsType } from '@mysten/sui/bcs';
+import { type Transaction, type TransactionArgument } from '@mysten/sui/transactions';
+export declare const NativeCustody: MoveStruct<{
+    dummy_field: BcsType<boolean, boolean, "bool">;
+}, "@waterx/native-custody::custody_vault::NativeCustody">;
+export declare const FeeConfig: MoveStruct<{
+    mint_fee_rate: MoveStruct<{
+        value: BcsType<string, string | number | bigint, "u128">;
+    }, "bucket_v2_framework::float::Float">;
+    burn_fee_rate: MoveStruct<{
+        value: BcsType<string, string | number | bigint, "u128">;
+    }, "bucket_v2_framework::float::Float">;
+}, "@waterx/native-custody::custody_vault::FeeConfig">;
+export declare const SingleVault: MoveStruct<{
+    id: BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    decimal: BcsType<number, number, "u8">;
+    default_fee_config: MoveStruct<{
+        mint_fee_rate: MoveStruct<{
+            value: BcsType<string, string | number | bigint, "u128">;
+        }, "bucket_v2_framework::float::Float">;
+        burn_fee_rate: MoveStruct<{
+            value: BcsType<string, string | number | bigint, "u128">;
+        }, "bucket_v2_framework::float::Float">;
+    }, "@waterx/native-custody::custody_vault::FeeConfig">;
+    partner_fee_configs: MoveStruct<{
+        contents: BcsType<{
+            key: string;
+            value: {
+                mint_fee_rate: {
+                    value: string;
+                };
+                burn_fee_rate: {
+                    value: string;
+                };
+            };
+        }[], Iterable<{
+            key: string | Uint8Array<ArrayBufferLike>;
+            value: {
+                mint_fee_rate: {
+                    value: string | number | bigint;
+                };
+                burn_fee_rate: {
+                    value: string | number | bigint;
+                };
+            };
+        }> & {
+            length: number;
+        }, string>;
+    }, "0x2::vec_map::VecMap<bytes[32], @waterx/native-custody::custody_vault::FeeConfig>">;
+    min_burn_amount: BcsType<string, string | number | bigint, "u64">;
+    balance: MoveStruct<{
+        value: BcsType<string, string | number | bigint, "u64">;
+    }, "0x2::balance::Balance<phantom T>">;
+    balance_amount: BcsType<string, string | number | bigint, "u64">;
+    credit_backing: BcsType<string, string | number | bigint, "u64">;
+    sheet: MoveStruct<{
+        credits: MoveStruct<{
+            contents: BcsType<{
+                key: [{
+                    name: string;
+                }];
+                value: {
+                    value: string;
+                };
+            }[], Iterable<{
+                key: readonly [{
+                    name: string;
+                }];
+                value: {
+                    value: string | number | bigint;
+                };
+            }> & {
+                length: number;
+            }, string>;
+        }, "0x2::vec_map::VecMap<bucket_v2_framework::sheet::Entity, bucket_v2_framework::liability::Credit<phantom T>>">;
+        debts: MoveStruct<{
+            contents: BcsType<{
+                key: [{
+                    name: string;
+                }];
+                value: {
+                    value: string;
+                };
+            }[], Iterable<{
+                key: readonly [{
+                    name: string;
+                }];
+                value: {
+                    value: string | number | bigint;
+                };
+            }> & {
+                length: number;
+            }, string>;
+        }, "0x2::vec_map::VecMap<bucket_v2_framework::sheet::Entity, bucket_v2_framework::liability::Debt<phantom T>>">;
+        blacklist: MoveStruct<any, any>;
+    }, "bucket_v2_framework::sheet::Sheet<phantom CoinType, phantom SelfEntity>">;
+    deprecated: BcsType<boolean, boolean, "bool">;
+}, "@waterx/native-custody::custody_vault::SingleVault<phantom T>">;
+export declare const CustodyVault: MoveStruct<{
+    id: BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+    credit_supply: BcsType<string, string | number | bigint, "u64">;
+    /**
+     * Admin-managed package-version allowlist used by admin paths that don't already
+     * thread `&CreditRegistry`. mint/burn paths keep the CreditRegistry-based
+     * `assert_valid_package` check; this set covers `add_asset` /
+     * `set_min_burn_amount` / `set_asset_deprecated` / `set_fee_config` so admin can
+     * kill-switch the package without touching `CreditRegistry.module_config_map`.
+     */
+    allowed_versions: MoveStruct<any, any>;
+}, "@waterx/native-custody::custody_vault::CustodyVault<phantom CREDIT>">;
+export declare const VaultKey: MoveTuple<readonly [BcsType<boolean, boolean, "bool">], "@waterx/native-custody::custody_vault::VaultKey<phantom T>">;
+export interface PackageVersionOptions {
+    package?: string;
+    arguments?: [
+    ];
+}
+export declare function packageVersion(options?: PackageVersionOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface MemoMintOptions {
+    package?: string;
+    arguments?: [
+    ];
+}
+export declare function memoMint(options?: MemoMintOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface MemoBurnOptions {
+    package?: string;
+    arguments?: [
+    ];
+}
+export declare function memoBurn(options?: MemoBurnOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface CreateVaultArguments {
+    registry: RawTransactionArgument<string>;
+    _: RawTransactionArgument<string>;
+}
+export interface CreateVaultOptions {
+    package?: string;
+    arguments: CreateVaultArguments | [
+        registry: RawTransactionArgument<string>,
+        _: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string
+    ];
+}
+/** Create + share an empty `CustodyVault<CREDIT>`. Add assets via `add_asset`. */
+export declare function createVault(options: CreateVaultOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface AddVersionArguments {
+    vault: RawTransactionArgument<string>;
+    _: RawTransactionArgument<string>;
+    version: RawTransactionArgument<number>;
+}
+export interface AddVersionOptions {
+    package?: string;
+    arguments: AddVersionArguments | [
+        vault: RawTransactionArgument<string>,
+        _: RawTransactionArgument<string>,
+        version: RawTransactionArgument<number>
+    ];
+    typeArguments: [
+        string
+    ];
+}
+/**
+ * Admin: whitelist a package version on this vault. Skips the version check itself
+ * so admin can recover from a stuck state.
+ */
+export declare function addVersion(options: AddVersionOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface RemoveVersionArguments {
+    vault: RawTransactionArgument<string>;
+    _: RawTransactionArgument<string>;
+    version: RawTransactionArgument<number>;
+}
+export interface RemoveVersionOptions {
+    package?: string;
+    arguments: RemoveVersionArguments | [
+        vault: RawTransactionArgument<string>,
+        _: RawTransactionArgument<string>,
+        version: RawTransactionArgument<number>
+    ];
+    typeArguments: [
+        string
+    ];
+}
+/**
+ * Admin: remove a package version from this vault's allowlist. Skips the version
+ * check itself.
+ */
+export declare function removeVersion(options: RemoveVersionOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface AddAssetArguments {
+    vault: RawTransactionArgument<string>;
+    _: RawTransactionArgument<string>;
+    decimal: RawTransactionArgument<number>;
+    mintFeeRate: RawTransactionArgument<number | bigint>;
+    burnFeeRate: RawTransactionArgument<number | bigint>;
+    minBurnAmount: RawTransactionArgument<number | bigint>;
+}
+export interface AddAssetOptions {
+    package?: string;
+    arguments: AddAssetArguments | [
+        vault: RawTransactionArgument<string>,
+        _: RawTransactionArgument<string>,
+        decimal: RawTransactionArgument<number>,
+        mintFeeRate: RawTransactionArgument<number | bigint>,
+        burnFeeRate: RawTransactionArgument<number | bigint>,
+        minBurnAmount: RawTransactionArgument<number | bigint>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/**
+ * Register backing asset `T` on `CustodyVault<CREDIT>`. Fee-rate inputs are raw
+ * 1e9-scaled `Float` values (u128). e.g. 1% = `10_000_000`, 100% =
+ * `1_000_000_000`. Anything above 1.0 aborts.
+ */
+export declare function addAsset(options: AddAssetOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface SetMinBurnAmountArguments {
+    vault: RawTransactionArgument<string>;
+    _: RawTransactionArgument<string>;
+    minBurnAmount: RawTransactionArgument<number | bigint>;
+}
+export interface SetMinBurnAmountOptions {
+    package?: string;
+    arguments: SetMinBurnAmountArguments | [
+        vault: RawTransactionArgument<string>,
+        _: RawTransactionArgument<string>,
+        minBurnAmount: RawTransactionArgument<number | bigint>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function setMinBurnAmount(options: SetMinBurnAmountOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface SetAssetDeprecatedArguments {
+    vault: RawTransactionArgument<string>;
+    _: RawTransactionArgument<string>;
+    deprecated: RawTransactionArgument<boolean>;
+}
+export interface SetAssetDeprecatedOptions {
+    package?: string;
+    arguments: SetAssetDeprecatedArguments | [
+        vault: RawTransactionArgument<string>,
+        _: RawTransactionArgument<string>,
+        deprecated: RawTransactionArgument<boolean>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/**
+ * Toggle the `deprecated` flag on a backing asset. When deprecated, `mint` aborts
+ * with `EAssetDeprecated`; `burn` still works so existing credit holders can
+ * redeem.
+ */
+export declare function setAssetDeprecated(options: SetAssetDeprecatedOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface SetFeeConfigArguments {
+    vault: RawTransactionArgument<string>;
+    _: RawTransactionArgument<string>;
+    partner: RawTransactionArgument<string | null>;
+    mintFeeRate: RawTransactionArgument<number | bigint>;
+    burnFeeRate: RawTransactionArgument<number | bigint>;
+}
+export interface SetFeeConfigOptions {
+    package?: string;
+    arguments: SetFeeConfigArguments | [
+        vault: RawTransactionArgument<string>,
+        _: RawTransactionArgument<string>,
+        partner: RawTransactionArgument<string | null>,
+        mintFeeRate: RawTransactionArgument<number | bigint>,
+        burnFeeRate: RawTransactionArgument<number | bigint>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function setFeeConfig(options: SetFeeConfigOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface DepositLiquidityArguments {
+    vault: RawTransactionArgument<string>;
+    registry: RawTransactionArgument<string>;
+    _: RawTransactionArgument<string>;
+    assetCoin: RawTransactionArgument<string>;
+}
+export interface DepositLiquidityOptions {
+    package?: string;
+    arguments: DepositLiquidityArguments | [
+        vault: RawTransactionArgument<string>,
+        registry: RawTransactionArgument<string>,
+        _: RawTransactionArgument<string>,
+        assetCoin: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function depositLiquidity(options: DepositLiquidityOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface WithdrawLiquidityArguments {
+    vault: RawTransactionArgument<string>;
+    registry: RawTransactionArgument<string>;
+    _: RawTransactionArgument<string>;
+    amount: RawTransactionArgument<number | bigint>;
+}
+export interface WithdrawLiquidityOptions {
+    package?: string;
+    arguments: WithdrawLiquidityArguments | [
+        vault: RawTransactionArgument<string>,
+        registry: RawTransactionArgument<string>,
+        _: RawTransactionArgument<string>,
+        amount: RawTransactionArgument<number | bigint>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function withdrawLiquidity(options: WithdrawLiquidityOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface MintArguments {
+    vault: RawTransactionArgument<string>;
+    registry: RawTransactionArgument<string>;
+    accountRegistry: RawTransactionArgument<string>;
+    accountId: RawTransactionArgument<string>;
+    assetCoin: RawTransactionArgument<string>;
+    extraData: RawTransactionArgument<Array<number>>;
+}
+export interface MintOptions {
+    package?: string;
+    arguments: MintArguments | [
+        vault: RawTransactionArgument<string>,
+        registry: RawTransactionArgument<string>,
+        accountRegistry: RawTransactionArgument<string>,
+        accountId: RawTransactionArgument<string>,
+        assetCoin: RawTransactionArgument<string>,
+        extraData: RawTransactionArgument<Array<number>>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/**
+ * Mint credit backed by asset `T` and wrap the resulting `Coin<CREDIT>` into a
+ * `DepositRequest<CREDIT>` targeting `account_id`. The hot-potato request keeps
+ * the credit inside the waterx_account system — it must be consumed in the same
+ * PTB by the deposit policy registered for `CREDIT`. Fee tier is looked up by
+ * `account_id.to_address()` — partner discounts follow the destination wxa
+ * account, symmetric with `burn`.
+ */
+export declare function mint(options: MintOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface MintFromRequestArguments {
+    vault: RawTransactionArgument<string>;
+    registry: RawTransactionArgument<string>;
+    accountRegistry: RawTransactionArgument<string>;
+    depositRequest: TransactionArgument;
+}
+export interface MintFromRequestOptions {
+    package?: string;
+    arguments: MintFromRequestArguments | [
+        vault: RawTransactionArgument<string>,
+        registry: RawTransactionArgument<string>,
+        accountRegistry: RawTransactionArgument<string>,
+        depositRequest: TransactionArgument
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/**
+ * Variant of `mint` that accepts a `DepositRequest<T>` instead of raw `Coin<T>`.
+ * Requires `T` to have `NativeCustody` registered as its deposit policy on the wxa
+ * `AccountRegistry`. Unwraps the request, then funnels through `mint` so the
+ * returned `DepositRequest<CREDIT>` carries the same `account_id` and `extra_data`
+ * as the input request.
+ */
+export declare function mintFromRequest(options: MintFromRequestOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface BurnAuthorizedArguments<M extends BcsType<any>> {
+    vault: RawTransactionArgument<string>;
+    registry: RawTransactionArgument<string>;
+    Witness: RawTransactionArgument<M>;
+    version: RawTransactionArgument<number>;
+    accountId: RawTransactionArgument<string>;
+    creditCoin: RawTransactionArgument<string>;
+}
+export interface BurnAuthorizedOptions<M extends BcsType<any>> {
+    package?: string;
+    arguments: BurnAuthorizedArguments<M> | [
+        vault: RawTransactionArgument<string>,
+        registry: RawTransactionArgument<string>,
+        Witness: RawTransactionArgument<M>,
+        version: RawTransactionArgument<number>,
+        accountId: RawTransactionArgument<string>,
+        creditCoin: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string,
+        string
+    ];
+}
+/**
+ * Account-authorized burn. Only callable by a `CreditRegistry`-registered module
+ * witness `M` (production: `WithdrawQueue`, via
+ * `withdrawal_queue::execute_native`), which vouches that `account_id` is the
+ * genuine originating wxa Account. `account_id` keys (a) the credit registry's
+ * personal-burn-cap and (b) the partner-fee lookup — so cap accounting and partner
+ * discounts bind to the source account, not whoever executes the queue entry
+ * (audit findings #3 / L03 / M14).
+ *
+ * There is intentionally no unauthenticated public burn: a raw `Coin<CREDIT>`
+ * holder cannot burn against a spoofed `account_id` to dodge burn fees or
+ * per-account burn caps. CREDIT exits route through the withdrawal queue. A
+ * direct-burn entrypoint can be re-added later as a new (additive) function if a
+ * use case arises.
+ */
+export declare function burnAuthorized<M extends BcsType<any>>(options: BurnAuthorizedOptions<M>): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface CreditSupplyArguments {
+    vault: RawTransactionArgument<string>;
+}
+export interface CreditSupplyOptions {
+    package?: string;
+    arguments: CreditSupplyArguments | [
+        vault: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string
+    ];
+}
+export declare function creditSupply(options: CreditSupplyOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface HasAssetArguments {
+    vault: RawTransactionArgument<string>;
+}
+export interface HasAssetOptions {
+    package?: string;
+    arguments: HasAssetArguments | [
+        vault: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function hasAsset(options: HasAssetOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface SingleVaultArguments {
+    vault: RawTransactionArgument<string>;
+}
+export interface SingleVaultOptions {
+    package?: string;
+    arguments: SingleVaultArguments | [
+        vault: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function singleVault(options: SingleVaultOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface DecimalArguments {
+    single: RawTransactionArgument<string>;
+}
+export interface DecimalOptions {
+    package?: string;
+    arguments: DecimalArguments | [
+        single: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string
+    ];
+}
+export declare function decimal(options: DecimalOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface BalanceArguments {
+    single: RawTransactionArgument<string>;
+}
+export interface BalanceOptions {
+    package?: string;
+    arguments: BalanceArguments | [
+        single: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string
+    ];
+}
+export declare function balance(options: BalanceOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface BalanceAmountArguments {
+    single: RawTransactionArgument<string>;
+}
+export interface BalanceAmountOptions {
+    package?: string;
+    arguments: BalanceAmountArguments | [
+        single: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string
+    ];
+}
+export declare function balanceAmount(options: BalanceAmountOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface CreditBackingArguments {
+    single: RawTransactionArgument<string>;
+}
+export interface CreditBackingOptions {
+    package?: string;
+    arguments: CreditBackingArguments | [
+        single: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string
+    ];
+}
+export declare function creditBacking(options: CreditBackingOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface MinBurnAmountArguments {
+    single: RawTransactionArgument<string>;
+}
+export interface MinBurnAmountOptions {
+    package?: string;
+    arguments: MinBurnAmountArguments | [
+        single: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string
+    ];
+}
+export declare function minBurnAmount(options: MinBurnAmountOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface SheetArguments {
+    single: RawTransactionArgument<string>;
+}
+export interface SheetOptions {
+    package?: string;
+    arguments: SheetArguments | [
+        single: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string
+    ];
+}
+export declare function sheet(options: SheetOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface DeprecatedArguments {
+    single: RawTransactionArgument<string>;
+}
+export interface DeprecatedOptions {
+    package?: string;
+    arguments: DeprecatedArguments | [
+        single: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string
+    ];
+}
+export declare function deprecated(options: DeprecatedOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface MintFeeRateArguments {
+    vault: RawTransactionArgument<string>;
+    caller: RawTransactionArgument<string>;
+}
+export interface MintFeeRateOptions {
+    package?: string;
+    arguments: MintFeeRateArguments | [
+        vault: RawTransactionArgument<string>,
+        caller: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function mintFeeRate(options: MintFeeRateOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface BurnFeeRateArguments {
+    vault: RawTransactionArgument<string>;
+    caller: RawTransactionArgument<string>;
+}
+export interface BurnFeeRateOptions {
+    package?: string;
+    arguments: BurnFeeRateArguments | [
+        vault: RawTransactionArgument<string>,
+        caller: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function burnFeeRate(options: BurnFeeRateOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;