@waterx/sdk 2.1.0

package/dist/src/generated/bucket_v2_framework/sheet.d.ts

@@ -0,0 +1,424 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+/** Module for the record of Credit and Debt of certain entity */
+import { MoveTuple, MoveStruct, type RawTransactionArgument } from '../utils/index.ts';
+import { type BcsType } from '@mysten/sui/bcs';
+import { type Transaction } from '@mysten/sui/transactions';
+export declare const Entity: MoveTuple<readonly [MoveStruct<{
+    name: BcsType<string, string, "string">;
+}, "std::type_name::TypeName">], "@bucket/framework::sheet::Entity">;
+export declare const 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/framework::sheet::Entity, @bucket/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/framework::sheet::Entity, @bucket/framework::liability::Debt<phantom T>>">;
+    blacklist: MoveStruct<any, any>;
+}, "@bucket/framework::sheet::Sheet<phantom CoinType, phantom SelfEntity>">;
+export declare const Loan: MoveStruct<{
+    balance: MoveStruct<{
+        value: BcsType<string, string | number | bigint, "u64">;
+    }, "0x2::balance::Balance<phantom T>">;
+    debt: MoveStruct<{
+        value: BcsType<string, string | number | bigint, "u64">;
+    }, "@bucket/framework::liability::Debt<phantom T>">;
+}, "@bucket/framework::sheet::Loan<phantom CoinType, phantom Lender, phantom Receiver>">;
+export declare const Request: MoveStruct<{
+    requirement: BcsType<string, string | number | bigint, "u64">;
+    balance: MoveStruct<{
+        value: BcsType<string, string | number | bigint, "u64">;
+    }, "0x2::balance::Balance<phantom T>">;
+    checklist: BcsType<[{
+        name: string;
+    }][] | null, (Iterable<readonly [{
+        name: string;
+    }]> & {
+        length: number;
+    }) | null | undefined, "Option<vector<@bucket/framework::sheet::Entity>>">;
+    payer_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/framework::sheet::Entity, @bucket/framework::liability::Debt<phantom T>>">;
+}, "@bucket/framework::sheet::Request<phantom CoinType, phantom Collector>">;
+export interface NewArguments<E extends BcsType<any>> {
+    _: RawTransactionArgument<E>;
+}
+export interface NewOptions<E extends BcsType<any>> {
+    package?: string;
+    arguments: NewArguments<E> | [
+        _: RawTransactionArgument<E>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+/** Public Funs */
+export declare function _new<E extends BcsType<any>>(options: NewOptions<E>): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface LendArguments<L extends BcsType<any>> {
+    sheet: RawTransactionArgument<string>;
+    balance: RawTransactionArgument<string>;
+    LenderStamp: RawTransactionArgument<L>;
+}
+export interface LendOptions<L extends BcsType<any>> {
+    package?: string;
+    arguments: LendArguments<L> | [
+        sheet: RawTransactionArgument<string>,
+        balance: RawTransactionArgument<string>,
+        LenderStamp: RawTransactionArgument<L>
+    ];
+    typeArguments: [
+        string,
+        string,
+        string
+    ];
+}
+export declare function lend<L extends BcsType<any>>(options: LendOptions<L>): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface ReceiveArguments<R extends BcsType<any>> {
+    sheet: RawTransactionArgument<string>;
+    loan: RawTransactionArgument<string>;
+    ReceiverStamp: RawTransactionArgument<R>;
+}
+export interface ReceiveOptions<R extends BcsType<any>> {
+    package?: string;
+    arguments: ReceiveArguments<R> | [
+        sheet: RawTransactionArgument<string>,
+        loan: RawTransactionArgument<string>,
+        ReceiverStamp: RawTransactionArgument<R>
+    ];
+    typeArguments: [
+        string,
+        string,
+        string
+    ];
+}
+export declare function receive<R extends BcsType<any>>(options: ReceiveOptions<R>): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface RequestArguments<C extends BcsType<any>> {
+    requirement: RawTransactionArgument<number | bigint>;
+    checklist: RawTransactionArgument<string[] | null>;
+    CollectorStamp: RawTransactionArgument<C>;
+}
+export interface RequestOptions<C extends BcsType<any>> {
+    package?: string;
+    arguments: RequestArguments<C> | [
+        requirement: RawTransactionArgument<number | bigint>,
+        checklist: RawTransactionArgument<string[] | null>,
+        CollectorStamp: RawTransactionArgument<C>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function request<C extends BcsType<any>>(options: RequestOptions<C>): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface PayArguments<P extends BcsType<any>> {
+    sheet: RawTransactionArgument<string>;
+    req: RawTransactionArgument<string>;
+    balance: RawTransactionArgument<string>;
+    PayerStamp: RawTransactionArgument<P>;
+}
+export interface PayOptions<P extends BcsType<any>> {
+    package?: string;
+    arguments: PayArguments<P> | [
+        sheet: RawTransactionArgument<string>,
+        req: RawTransactionArgument<string>,
+        balance: RawTransactionArgument<string>,
+        PayerStamp: RawTransactionArgument<P>
+    ];
+    typeArguments: [
+        string,
+        string,
+        string
+    ];
+}
+export declare function pay<P extends BcsType<any>>(options: PayOptions<P>): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface CollectArguments<C extends BcsType<any>> {
+    sheet: RawTransactionArgument<string>;
+    req: RawTransactionArgument<string>;
+    Stamp: RawTransactionArgument<C>;
+}
+export interface CollectOptions<C extends BcsType<any>> {
+    package?: string;
+    arguments: CollectArguments<C> | [
+        sheet: RawTransactionArgument<string>,
+        req: RawTransactionArgument<string>,
+        Stamp: RawTransactionArgument<C>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function collect<C extends BcsType<any>>(options: CollectOptions<C>): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface AddDebtorArguments<E extends BcsType<any>> {
+    sheet: RawTransactionArgument<string>;
+    debtor: RawTransactionArgument<string>;
+    Stamp: RawTransactionArgument<E>;
+}
+export interface AddDebtorOptions<E extends BcsType<any>> {
+    package?: string;
+    arguments: AddDebtorArguments<E> | [
+        sheet: RawTransactionArgument<string>,
+        debtor: RawTransactionArgument<string>,
+        Stamp: RawTransactionArgument<E>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function addDebtor<E extends BcsType<any>>(options: AddDebtorOptions<E>): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface AddCreditorArguments<E extends BcsType<any>> {
+    sheet: RawTransactionArgument<string>;
+    creditor: RawTransactionArgument<string>;
+    Stamp: RawTransactionArgument<E>;
+}
+export interface AddCreditorOptions<E extends BcsType<any>> {
+    package?: string;
+    arguments: AddCreditorArguments<E> | [
+        sheet: RawTransactionArgument<string>,
+        creditor: RawTransactionArgument<string>,
+        Stamp: RawTransactionArgument<E>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function addCreditor<E extends BcsType<any>>(options: AddCreditorOptions<E>): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface BanArguments<E extends BcsType<any>> {
+    sheet: RawTransactionArgument<string>;
+    entity: RawTransactionArgument<string>;
+    Stamp: RawTransactionArgument<E>;
+}
+export interface BanOptions<E extends BcsType<any>> {
+    package?: string;
+    arguments: BanArguments<E> | [
+        sheet: RawTransactionArgument<string>,
+        entity: RawTransactionArgument<string>,
+        Stamp: RawTransactionArgument<E>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function ban<E extends BcsType<any>>(options: BanOptions<E>): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface UnbanArguments<E extends BcsType<any>> {
+    sheet: RawTransactionArgument<string>;
+    entity: RawTransactionArgument<string>;
+    Stamp: RawTransactionArgument<E>;
+}
+export interface UnbanOptions<E extends BcsType<any>> {
+    package?: string;
+    arguments: UnbanArguments<E> | [
+        sheet: RawTransactionArgument<string>,
+        entity: RawTransactionArgument<string>,
+        Stamp: RawTransactionArgument<E>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function unban<E extends BcsType<any>>(options: UnbanOptions<E>): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface EntityOptions {
+    package?: string;
+    arguments?: [
+    ];
+    typeArguments: [
+        string
+    ];
+}
+/** Getter Funs */
+export declare function entity(options: EntityOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface CreditsArguments {
+    sheet: RawTransactionArgument<string>;
+}
+export interface CreditsOptions {
+    package?: string;
+    arguments: CreditsArguments | [
+        sheet: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function credits(options: CreditsOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface DebtsArguments {
+    sheet: RawTransactionArgument<string>;
+}
+export interface DebtsOptions {
+    package?: string;
+    arguments: DebtsArguments | [
+        sheet: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function debts(options: DebtsOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface BlacklistArguments {
+    sheet: RawTransactionArgument<string>;
+}
+export interface BlacklistOptions {
+    package?: string;
+    arguments: BlacklistArguments | [
+        sheet: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function blacklist(options: BlacklistOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface TotalCreditArguments {
+    sheet: RawTransactionArgument<string>;
+}
+export interface TotalCreditOptions {
+    package?: string;
+    arguments: TotalCreditArguments | [
+        sheet: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function totalCredit(options: TotalCreditOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface TotalDebtArguments {
+    sheet: RawTransactionArgument<string>;
+}
+export interface TotalDebtOptions {
+    package?: string;
+    arguments: TotalDebtArguments | [
+        sheet: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function totalDebt(options: TotalDebtOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface LoanValueArguments {
+    loan: RawTransactionArgument<string>;
+}
+export interface LoanValueOptions {
+    package?: string;
+    arguments: LoanValueArguments | [
+        loan: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string,
+        string
+    ];
+}
+export declare function loanValue(options: LoanValueOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface RequirementArguments {
+    req: RawTransactionArgument<string>;
+}
+export interface RequirementOptions {
+    package?: string;
+    arguments: RequirementArguments | [
+        req: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function requirement(options: RequirementOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface BalanceArguments {
+    req: RawTransactionArgument<string>;
+}
+export interface BalanceOptions {
+    package?: string;
+    arguments: BalanceArguments | [
+        req: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function balance(options: BalanceOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface ShortageArguments {
+    req: RawTransactionArgument<string>;
+}
+export interface ShortageOptions {
+    package?: string;
+    arguments: ShortageArguments | [
+        req: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function shortage(options: ShortageOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;
+export interface PayerDebtsArguments {
+    req: RawTransactionArgument<string>;
+}
+export interface PayerDebtsOptions {
+    package?: string;
+    arguments: PayerDebtsArguments | [
+        req: RawTransactionArgument<string>
+    ];
+    typeArguments: [
+        string,
+        string
+    ];
+}
+export declare function payerDebts(options: PayerDebtsOptions): (tx: Transaction) => import("@mysten/sui/transactions").TransactionResult;