@eversurf/surfkeeper-provider/dist/api.d.ts

Provider interface for Surf Keeper extension of the Everscale blockchain

import { SubscriptionType } from './constants';
import type { SubscriptionDisposer, SubscriptionParams, SubscriptionResponse, SubscriptionListener, SendMessageParams, SendTransactionParams, SendResponse, SignDataParams, SignDataResponse } from './types';
/**
 * @remarks Networks
 */
export declare enum ProviderNetwork {
    everscale = "everscale",
    gosh = "gosh",
    ton = "ton",
    venom = "venom",
    dev = "dev",
    fld = "fld"
}
/**
 * @remarks Provider Api
 */
export declare type ProviderMethodsApi = {
    /**
     * Signs an arbitrary data.
     * Shows an approval window to the user.
     */
    signData: {
        input: SignDataParams;
        output: SignDataResponse;
    };
    /**
     * Sends an internal message from the user account.
     * Shows an approval window to the user.
     */
    sendMessage: {
        input: SendMessageParams;
        output: SendResponse;
    };
    /**
     * Sends transaction with provided params.
     * Shows an approval window to the user.
     */
    sendTransaction: {
        input: SendTransactionParams;
        output: SendResponse;
    };
};
/**
 * @remarks Provider Api
 */
export type ApiMethod = keyof ProviderMethodsApi;
/**
 * @remarks Provider Api
 */
export type ProviderApiRequestParams<T extends ApiMethod> = ProviderMethodsApi[T] extends {
    input: infer I;
} ? I : undefined;
/**
 * @remarks Provider Api
 */
export type RawProviderApiRequestParams<T extends ApiMethod> = ProviderApiRequestParams<T>;
/**
 * @remarks Provider Api
 */
export type ProviderApiResponse<T extends ApiMethod> = ProviderMethodsApi[T] extends {
    output: infer O;
} ? O : undefined;
/**
 * @remarks Provider Api
 */
export type RawProviderApiResponse<T extends ApiMethod> = ProviderApiResponse<T>;
/**
 * @remarks Subscription Api
 */
export declare type SubscriptionApi<T extends SubscriptionType> = {
    /**
     * Subscribes on data updates.
     * Returns updated data in listener callback.
     */
    subscribe: {
        input: {
            type: T;
            listener: SubscriptionListener<SubscriptionResponse<T>>;
        } & SubscriptionParams<T>;
        output: SubscriptionDisposer;
    };
};
/**
 * @remarks Subscription Api
 */
export type SubscriptionMethod = keyof SubscriptionApi<SubscriptionType>;
/**
 * @remarks Subscription Api
 */
export type ProviderSubscriptionRequestParams<T extends SubscriptionType> = SubscriptionApi<T>[SubscriptionMethod] extends {
    input: infer I;
} ? I : undefined;
/**
 * @remarks Subscription Api
 */
export type RawProviderSubscriptionRequestParams<T extends SubscriptionType> = ProviderSubscriptionRequestParams<T>;
/**
 * @remarks Subscription Api
 */
export type ProviderSubscriptionResponse<T extends SubscriptionType> = SubscriptionApi<T>[SubscriptionMethod] extends {
    output: infer O;
} ? O : undefined;
/**
 * @remarks Subscription Api
 */
export type RawProviderSubscriptionResponse<T extends SubscriptionType> = ProviderSubscriptionResponse<T>;