blub-sdk/dist/utils/sui.d.ts

A modular SDK for interacting with the BLUB ecosystem on the Sui blockchain.

import { SuiObjectData, SuiObjectRef, SuiObjectResponse, OwnedObjectRef, ObjectOwner, DisplayFieldsResponse, SuiMoveObject, SuiParsedData } from "@mysten/sui/client";
export declare const GAS_TYPE_ARG = "0x2::sui::SUI";
export declare const GAS_TYPE_ARG_LONG = "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI";
/**
 * Represents a SUI address, which is a string.
 */
export type SuiAddress = string;
/**
 * Represents a SUI object identifier, which is a string.
 */
export type SuiObjectIdType = string;
/**
 * Represents a SUI struct tag.
 */
export type SuiStructTag = {
    /**
     * The full address of the struct.
     */
    full_address: string;
    /**
     * The source address of the struct.
     */
    source_address: string;
    /**
     * The address of the struct.
     */
    address: SuiAddress;
    /**
     * The module to which the struct belongs.
     */
    module: string;
    /**
     * The name of the struct.
     */
    name: string;
    /**
     * An array of type arguments (SUI addresses) for the struct.
     */
    type_arguments: SuiAddress[];
};
export declare function getSuiObjectData(resp: SuiObjectResponse): SuiObjectData | null | undefined;
export declare function getObjectDeletedResponse(resp: SuiObjectResponse): SuiObjectRef | undefined;
export declare function getObjectNotExistsResponse(resp: SuiObjectResponse): string | undefined;
export declare function getObjectReference(resp: SuiObjectResponse | OwnedObjectRef): SuiObjectRef | undefined;
export declare function getObjectId(data: SuiObjectResponse | SuiObjectRef | OwnedObjectRef): string;
export declare function getObjectVersion(data: SuiObjectResponse | SuiObjectRef | SuiObjectData): string | number | undefined;
export declare function isSuiObjectResponse(resp: SuiObjectResponse | SuiObjectData): resp is SuiObjectResponse;
export declare function getMovePackageContent(data: SuiObjectResponse): any | undefined;
export declare function getMoveObject(data: SuiObjectResponse | SuiObjectData): SuiMoveObject | undefined;
export declare function getMoveObjectType(resp: SuiObjectResponse): string | undefined;
/**
 * Deriving the object type from the object response
 * @returns 'package' if the object is a package, move object type(e.g., 0x2::coin::Coin<0x2::sui::SUI>)
 * if the object is a move object
 */
export declare function getObjectType(resp: SuiObjectResponse | SuiObjectData): string | null | undefined;
export declare function getObjectPreviousTransactionDigest(resp: SuiObjectResponse): string | null | undefined;
export declare function getObjectOwner(resp: SuiObjectResponse): ObjectOwner | null | undefined;
export declare function getObjectDisplay(resp: SuiObjectResponse): DisplayFieldsResponse;
/**
 * Get the fields of a sui object response or data. The dataType of the object must be moveObject.
 * @param {SuiObjectResponse | SuiObjectData}object The object to get the fields from.
 * @returns {any} The fields of the object.
 */
export declare function getObjectFields(object: SuiObjectResponse | SuiObjectData): any;
export interface SuiObjectDataWithContent extends SuiObjectData {
    content: SuiParsedData;
}
/**
 * Return hasPublicTransfer of a move object.
 * @param {SuiObjectResponse | SuiObjectData}data
 * @returns
 */
export declare function hasPublicTransfer(data: SuiObjectResponse | SuiObjectData): boolean;
export declare function completionCoin(s: string): string;