@mysten/sui/dist/esm/transactions/ObjectCache.d.ts

Sui TypeScript API(Work in Progress)

import type { bcs } from '../bcs/index.js';
import type { OpenMoveTypeSignature } from './data/internal.js';
import type { TransactionPlugin } from './json-rpc-resolver.js';
export interface ObjectCacheEntry {
    objectId: string;
    version: string;
    digest: string;
    owner: string | null;
    initialSharedVersion: string | null;
}
export interface MoveFunctionCacheEntry {
    package: string;
    module: string;
    function: string;
    parameters: OpenMoveTypeSignature[];
}
export interface CacheEntryTypes {
    OwnedObject: ObjectCacheEntry;
    SharedOrImmutableObject: ObjectCacheEntry;
    MoveFunction: MoveFunctionCacheEntry;
    Custom: unknown;
}
export declare abstract class AsyncCache {
    protected abstract get<T extends keyof CacheEntryTypes>(type: T, key: string): Promise<CacheEntryTypes[T] | null>;
    protected abstract set<T extends keyof CacheEntryTypes>(type: T, key: string, value: CacheEntryTypes[T]): Promise<void>;
    protected abstract delete<T extends keyof CacheEntryTypes>(type: T, key: string): Promise<void>;
    abstract clear<T extends keyof CacheEntryTypes>(type?: T): Promise<void>;
    getObject(id: string): Promise<ObjectCacheEntry | null>;
    getObjects(ids: string[]): Promise<(ObjectCacheEntry | null)[]>;
    addObject(object: ObjectCacheEntry): Promise<ObjectCacheEntry>;
    addObjects(objects: ObjectCacheEntry[]): Promise<void>;
    deleteObject(id: string): Promise<void>;
    deleteObjects(ids: string[]): Promise<void>;
    getMoveFunctionDefinition(ref: {
        package: string;
        module: string;
        function: string;
    }): Promise<MoveFunctionCacheEntry | null>;
    addMoveFunctionDefinition(functionEntry: MoveFunctionCacheEntry): Promise<{
        package: string;
        module: string;
        function: string;
        parameters: OpenMoveTypeSignature[];
    }>;
    deleteMoveFunctionDefinition(ref: {
        package: string;
        module: string;
        function: string;
    }): Promise<void>;
    getCustom<T>(key: string): Promise<T | null>;
    setCustom<T>(key: string, value: T): Promise<void>;
    deleteCustom(key: string): Promise<void>;
}
export declare class InMemoryCache extends AsyncCache {
    #private;
    protected get<T extends keyof CacheEntryTypes>(type: T, key: string): Promise<NonNullable<CacheEntryTypes[T]> | null>;
    protected set<T extends keyof CacheEntryTypes>(type: T, key: string, value: CacheEntryTypes[T]): Promise<void>;
    protected delete<T extends keyof CacheEntryTypes>(type: T, key: string): Promise<void>;
    clear<T extends keyof CacheEntryTypes>(type?: T): Promise<void>;
}
export interface ObjectCacheOptions {
    cache?: AsyncCache;
}
export declare class ObjectCache {
    #private;
    constructor({ cache }: ObjectCacheOptions);
    asPlugin(): TransactionPlugin;
    clear(): Promise<void>;
    getMoveFunctionDefinition(ref: {
        package: string;
        module: string;
        function: string;
    }): Promise<MoveFunctionCacheEntry | null>;
    getObjects(ids: string[]): Promise<(ObjectCacheEntry | null)[]>;
    deleteObjects(ids: string[]): Promise<void>;
    clearOwnedObjects(): Promise<void>;
    clearCustom(): Promise<void>;
    getCustom<T>(key: string): Promise<T | null>;
    setCustom<T>(key: string, value: T): Promise<void>;
    deleteCustom(key: string): Promise<void>;
    applyEffects(effects: typeof bcs.TransactionEffects.$inferType): Promise<void>;
}