@0xobelisk/sui-client 0.5.16 → 0.5.18

package/dist/metadata/index.d.ts

@@ -1,3 +0,0 @@
-import { SuiMoveNormalizedModules } from '@mysten/sui.js/client';
-import { NetworkType } from '../types';
-export declare function loadMetadata(networkType: NetworkType, packageId: string): Promise<SuiMoveNormalizedModules | undefined>;

package/dist/obelisk.d.ts

@@ -1,136 +0,0 @@
-/// <reference types="node" />
-import { TransactionBlock } from '@mysten/sui.js/transactions';
-import type { SuiTransactionBlockResponse, DevInspectResults, SuiMoveNormalizedModules, SuiObjectData } from '@mysten/sui.js/client';
-import { SuiAccountManager } from './libs/suiAccountManager';
-import { SuiTxBlock } from './libs/suiTxBuilder';
-import { SuiInteractor } from './libs/suiInteractor';
-import { SuiContractFactory } from './libs/suiContractFactory';
-import { SuiMoveMoudleFuncType } from './libs/suiContractFactory/types';
-import { DerivePathParams, FaucetNetworkType, MapMoudleFuncQuery, MapMoudleFuncTx, ObeliskParams, SuiTxArg, SuiVecTxArg } from './types';
-export declare function isUndefined(value?: unknown): value is undefined;
-export declare function withMeta<T extends {
-    meta: SuiMoveMoudleFuncType;
-}>(meta: SuiMoveMoudleFuncType, creator: Omit<T, 'meta'>): T;
-/**
- * @class Obelisk
- * @description This class is used to aggregate the tools that used to interact with SUI network.
- */
-export declare class Obelisk {
-    #private;
-    accountManager: SuiAccountManager;
-    suiInteractor: SuiInteractor;
-    contractFactory: SuiContractFactory;
-    packageId: string | undefined;
-    metadata: SuiMoveNormalizedModules | undefined;
-    /**
-     * Support the following ways to init the ObeliskClient:
-     * 1. mnemonics
-     * 2. secretKey (base64 or hex)
-     * If none of them is provided, will generate a random mnemonics with 24 words.
-     *
-     * @param mnemonics, 12 or 24 mnemonics words, separated by space
-     * @param secretKey, base64 or hex string, when mnemonics is provided, secretKey will be ignored
-     * @param networkType, 'testnet' | 'mainnet' | 'devnet' | 'localnet', default is 'devnet'
-     * @param fullnodeUrl, the fullnode url, default is the preconfig fullnode url for the given network type
-     * @param packageId
-     */
-    constructor({ mnemonics, secretKey, networkType, fullnodeUrls, packageId, metadata, }?: ObeliskParams);
-    get query(): MapMoudleFuncQuery;
-    get tx(): MapMoudleFuncTx;
-    /**
-     * if derivePathParams is not provided or mnemonics is empty, it will return the keypair.
-     * else:
-     * it will generate signer from the mnemonic with the given derivePathParams.
-     * @param derivePathParams, such as { accountIndex: 2, isExternal: false, addressIndex: 10 }, comply with the BIP44 standard
-     */
-    getKeypair(derivePathParams?: DerivePathParams): import("@mysten/sui.js/dist/cjs/keypairs/ed25519").Ed25519Keypair;
-    /**
-     * @description Switch the current account with the given derivePathParams
-     * @param derivePathParams, such as { accountIndex: 2, isExternal: false, addressIndex: 10 }, comply with the BIP44 standard
-     */
-    switchAccount(derivePathParams: DerivePathParams): void;
-    /**
-     * @description Get the address of the account for the given derivePathParams
-     * @param derivePathParams, such as { accountIndex: 2, isExternal: false, addressIndex: 10 }, comply with the BIP44 standard
-     */
-    getAddress(derivePathParams?: DerivePathParams): string;
-    currentAddress(): string;
-    getPackageId(): string;
-    getMetadata(): SuiMoveNormalizedModules | undefined;
-    /**
-     * Request some SUI from faucet
-     * @Returns {Promise<boolean>}, true if the request is successful, false otherwise.
-     */
-    requestFaucet(address: string, network: FaucetNetworkType): Promise<void>;
-    getBalance(coinType?: string, derivePathParams?: DerivePathParams): Promise<import("@mysten/sui.js/client").CoinBalance>;
-    balanceOf(accountAddress?: string, coinType?: string, derivePathParams?: DerivePathParams): Promise<import("@mysten/sui.js/client").CoinBalance>;
-    client(): import("@mysten/sui.js/client").SuiClient;
-    getObject(objectId: string): Promise<SuiObjectData>;
-    getObjects(objectIds: string[]): Promise<SuiObjectData[]>;
-    signTxn(tx: Uint8Array | TransactionBlock | SuiTxBlock, derivePathParams?: DerivePathParams): Promise<import("@mysten/sui.js/dist/cjs/cryptography").SignatureWithBytes>;
-    signAndSendTxn(tx: Uint8Array | TransactionBlock | SuiTxBlock, derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
-    /**
-     * Transfer the given amount of SUI to the recipient
-     * @param recipient
-     * @param amount
-     * @param derivePathParams
-     */
-    transferSui(recipient: string, amount: number, derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
-    /**
-     * Transfer to mutliple recipients
-     * @param recipients the recipients addresses
-     * @param amounts the amounts of SUI to transfer to each recipient, the length of amounts should be the same as the length of recipients
-     * @param derivePathParams
-     */
-    transferSuiToMany(recipients: string[], amounts: number[], derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
-    /**
-     * Transfer the given amounts of coin to multiple recipients
-     * @param recipients the list of recipient address
-     * @param amounts the amounts to transfer for each recipient
-     * @param coinType any custom coin type but not SUI
-     * @param derivePathParams the derive path params for the current signer
-     */
-    transferCoinToMany(recipients: string[], amounts: number[], coinType: string, derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
-    transferCoin(recipient: string, amount: number, coinType: string, derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
-    transferObjects(objects: string[], recipient: string, derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
-    moveCall(callParams: {
-        target: string;
-        arguments?: (SuiTxArg | SuiVecTxArg)[];
-        typeArguments?: string[];
-        derivePathParams?: DerivePathParams;
-    }): Promise<SuiTransactionBlockResponse>;
-    /**
-     * Select coins with the given amount and coin type, the total amount is greater than or equal to the given amount
-     * @param amount
-     * @param coinType
-     * @param owner
-     */
-    selectCoinsWithAmount(amount: number, coinType: string, owner?: string): Promise<string[]>;
-    selectObjectsWithType(objectType: string, owner?: string): Promise<string[]>;
-    /**
-     * stake the given amount of SUI to the validator
-     * @param amount the amount of SUI to stake
-     * @param validatorAddr the validator address
-     * @param derivePathParams the derive path params for the current signer
-     */
-    stakeSui(amount: number, validatorAddr: string, derivePathParams?: DerivePathParams): Promise<SuiTransactionBlockResponse>;
-    /**
-     * Execute the transaction with on-chain data but without really submitting. Useful for querying the effects of a transaction.
-     * Since the transaction is not submitted, its gas cost is not charged.
-     * @param tx the transaction to execute
-     * @param derivePathParams the derive path params
-     * @returns the effects and events of the transaction, such as object changes, gas cost, event emitted.
-     */
-    inspectTxn(tx: Uint8Array | TransactionBlock | SuiTxBlock, derivePathParams?: DerivePathParams): Promise<DevInspectResults>;
-    getWorld(worldObjectId: string): Promise<SuiObjectData>;
-    listSchemaNames(worldId: string): Promise<any>;
-    getEntity(worldId: string, schemaName: string, entityId?: string): Promise<any[] | undefined>;
-    containEntity(worldId: string, schemaName: string, entityId?: string): Promise<boolean | undefined>;
-    getOwnedObjects(owner: string, cursor?: string, limit?: number): Promise<SuiObjectData[]>;
-    entity_key_from_object(objectId: string): Promise<string | undefined>;
-    entity_key_from_bytes(bytes: Uint8Array | Buffer | string): Promise<string>;
-    entity_key_from_address_with_seed(objectId: string, seed: string): Promise<string | undefined>;
-    entity_key_from_address_with_u256(objectId: string, x: number): Promise<string | undefined>;
-    entity_key_from_u256(x: number): Promise<string>;
-    formatData(type: string, value: Buffer | number[] | Uint8Array): Promise<any>;
-}

package/dist/types/index.d.ts

@@ -1,152 +0,0 @@
-import type { Infer } from 'superstruct';
-import type { SerializedBcs } from '@mysten/bcs';
-import type { TransactionArgument } from '@mysten/sui.js/transactions';
-import type { TransactionBlock, TransactionObjectArgument, TransactionResult } from '@mysten/sui.js/transactions';
-import type { SuiObjectRef, SuiMoveNormalizedModules, DevInspectResults, SuiTransactionBlockResponse, DisplayFieldsResponse, MoveStruct } from '@mysten/sui.js/client';
-import type { SharedObjectRef, ObjectArg } from '@mysten/sui.js/bcs';
-import { SuiMoveMoudleFuncType } from '../libs/suiContractFactory/types';
-export declare const ObjectContentFields: import("superstruct").Struct<Record<string, any>, null>;
-export type ObjectContentFields = Infer<typeof ObjectContentFields>;
-export type ObeliskObjectData = {
-    objectId: string;
-    objectType: string;
-    objectVersion: number;
-    objectDisplay: DisplayFieldsResponse;
-    objectFields: ObjectContentFields;
-};
-export type ObeliskObjectContent = {
-    dataType: 'moveObject';
-    fields: MoveStruct;
-    hasPublicTransfer: boolean;
-    type: string;
-};
-export type ObeliskParams = {
-    mnemonics?: string;
-    secretKey?: string;
-    fullnodeUrls?: string[];
-    faucetUrl?: string;
-    networkType?: NetworkType;
-    packageId?: string;
-    metadata?: SuiMoveNormalizedModules;
-};
-export type SchemaFieldType = {
-    schemas: {
-        type: string;
-        fields: {
-            id: {
-                id: string;
-            };
-            size: string;
-        };
-    };
-};
-export type SchemaValueType = {
-    id: {
-        id: string;
-    };
-    name: string;
-    value: {
-        type: string;
-        fields: SchemaFieldType;
-    };
-};
-export type SchemaContentType = {
-    type: string;
-    fields: SchemaValueType;
-    hasPublicTransfer: boolean;
-    dataType: 'moveObject';
-};
-export interface MessageMeta {
-    readonly meta: SuiMoveMoudleFuncType;
-}
-export interface ContractQuery extends MessageMeta {
-    (tx: TransactionBlock, params: (TransactionArgument | SerializedBcs<any>)[], typeArguments?: string[], isRaw?: boolean): Promise<DevInspectResults | TransactionResult>;
-}
-export interface ContractTx extends MessageMeta {
-    (tx: TransactionBlock, params: (TransactionArgument | SerializedBcs<any>)[], typeArguments?: string[], isRaw?: boolean): Promise<SuiTransactionBlockResponse | TransactionResult>;
-}
-export type MapMessageTx = Record<string, ContractTx>;
-export type MapMessageQuery = Record<string, ContractQuery>;
-export type MapMoudleFuncTx = Record<string, MapMessageTx>;
-export type MapMoudleFuncQuery = Record<string, MapMessageQuery>;
-export type MapMoudleFuncTest = Record<string, Record<string, string>>;
-export type MapMoudleFuncQueryTest = Record<string, Record<string, string>>;
-export type AccountMangerParams = {
-    mnemonics?: string;
-    secretKey?: string;
-};
-export type DerivePathParams = {
-    accountIndex?: number;
-    isExternal?: boolean;
-    addressIndex?: number;
-};
-export type NetworkType = 'testnet' | 'mainnet' | 'devnet' | 'localnet';
-export type FaucetNetworkType = 'testnet' | 'devnet' | 'localnet';
-export type SuiKitParams = {
-    mnemonics?: string;
-    secretKey?: string;
-    fullnodeUrls?: string[];
-    faucetUrl?: string;
-    networkType?: NetworkType;
-};
-export type ObjectData = {
-    objectId: string;
-    objectType: string;
-    objectVersion: number;
-    objectDigest: string;
-    initialSharedVersion?: number;
-    objectDisplay: DisplayFieldsResponse;
-    objectFields: ObjectContentFields;
-};
-type TransactionBlockType = InstanceType<typeof TransactionBlock>;
-export type PureCallArg = {
-    Pure: number[];
-};
-export type ObjectCallArg = {
-    Object: ObjectArg;
-};
-export type TransactionType = Parameters<TransactionBlockType['add']>;
-export type TransactionPureArgument = Extract<TransactionArgument, {
-    kind: 'Input';
-    type: 'pure';
-}>;
-export type ObjectFieldType = {
-    id: {
-        id: string;
-    };
-    name: string;
-    value: string;
-};
-export type EntityData = {
-    objectId: string;
-    index: string;
-    key: string;
-};
-export type SuiAddressArg = TransactionArgument | SerializedBcs<any> | string | PureCallArg;
-export type SuiTxArg = SuiAddressArg | number | bigint | boolean;
-export type SuiObjectArg = TransactionObjectArgument | string | SharedObjectRef | SuiObjectRef | ObjectCallArg;
-export type SuiVecTxArg = {
-    value: SuiTxArg[];
-    vecType: SuiInputTypes;
-} | SuiTxArg[];
-/**
- * These are the basics types that can be used in the SUI
- */
-export type SuiBasicTypes = 'address' | 'bool' | 'u8' | 'u16' | 'u32' | 'u64' | 'u128' | 'u256' | 'signer';
-export type SuiInputTypes = 'object' | SuiBasicTypes;
-export type SuiReturnValues = {
-    returnValues: [number[], string][];
-}[];
-export type DynamicFieldContentType = {
-    type: string;
-    fields: Record<string, any>;
-    hasPublicTransfer: boolean;
-    dataType: string;
-};
-export type ObjectContent = {
-    type: string;
-    fields: Record<string, any>;
-    hasPublicTransfer: boolean;
-    dataType: string;
-};
-export {};

package/dist/utils/index.d.ts

@@ -1,3 +0,0 @@
-export declare function capitalizeFirstLetter(input: string): string;
-export declare function normalizeHexAddress(input: string): string | null;
-export declare function numberToAddressHex(num: number): string;