@dojoengine/sdk
Version:
Dojo SDK: Build onchain and provable apps faster
108 lines (103 loc) • 8.86 kB
TypeScript
import * as torii$1 from '@dojoengine/torii-wasm';
import { A as AchievementsPage, P as PlayerAchievementsPage, c as AggregationsPage, d as ActivitiesPage, e as SqlQueryResponse, S as SchemaType, b as SDKConfig, f as SDK } from './index.d-9ZQhmPaZ.js';
export { g as AchievementData, h as AchievementProgressionData, i as AchievementProgressionSubscriptionQuery, j as AchievementProgressionView, k as AchievementQueryInput, l as AchievementTaskData, m as ActivityEntry, n as ActivityQueryInput, o as ActivitySubscriptionQuery, p as AggregationEntryView, q as AggregationQueryInput, r as AndComposeClause, s as AttributesFilter, C as ClauseBuilder, t as ContractType, G as GetParams, u as GetTokenBalanceRequest, v as GetTokenContracts, w as GetTokenRequest, x as GetTokenTransferRequest, H as HashedKeysClause, y as HistoricalToriiQueryBuilder, z as HistoricalToriiQueryBuilderOptions, K as KeysClause, M as MemberClause, B as MemberValueParam, D as MergedModels, N as NO_ACCOUNT, E as NO_IDENTITY, F as NO_SIGNER, O as OrComposeClause, I as Pagination, J as ParsedEntity, L as PlayerAchievementEntryData, Q as PlayerAchievementEntryView, R as PlayerAchievementProgressData, T as PlayerAchievementQueryInput, U as PlayerAchievementStatsData, V as SDKClientConfig, W as SDKFunctionOptions, X as SqlQueryIntegerValue, Y as SqlQueryValue, a as StandardizedQueryResult, Z as SubscribeAchievementProgressionRequest, _ as SubscribeParams, $ as SubscribeResponse, a0 as SubscribeTokenBalanceRequest, a1 as SubscribeTokenRequest, a2 as SubscribeTokenTransferRequest, a3 as SubscriptionCallback, a4 as SubscriptionCallbackArgs, a5 as TaskProgressData, a6 as ToriiQueryBuilder, a7 as ToriiResponse, a8 as UNDEFINED_CLAUSE, a9 as UnionOfModelData, aa as UpdateAchievementProgressionSubscriptionRequest, ab as UpdateTokenBalanceSubscriptionRequest, ac as UpdateTokenTransferSubscriptionRequest, ad as convertToPrimitive, ae as deepMerge, af as defaultAchievementProgression, ag as defaultToken, ah as defaultTokenBalance, ai as defaultTokenTransfer, aj as defaultToriiPagination, ak as generateTypedData, al as getAchievements, am as getModel, an as getModelByEntityId, ao as getPlayerAchievements, ap as getTokenBalances, aq as getTokenContracts, ar as getTokenTransfers, as as getTokens, at as isCairoCustomEnum, au as isCairoOption, av as mergeCairoCustomEnum, aw as mergeCairoOption, ax as onAchievementProgressionUpdated, ay as onTokenBalanceUpdated, az as onTokenTransferUpdated, aA as onTokenUpdated, aB as parseEntities, aC as parseTokenRequest, aD as safeCallback, aE as subscribeQueryModelCallback, aF as subscribeToken, aG as subscribeTokenBalance, aH as subscribeTokenTransfer, aI as toAchievementQuery, aJ as toPlayerAchievementQuery, aK as updateAchievementProgressionSubscription, aL as updateTokenBalanceSubscription, aM as updateTokenTransferSubscription } from './index.d-9ZQhmPaZ.js';
import * as torii from '@dojoengine/torii-wasm/types';
import '@dojoengine/torii-wasm/node';
import 'starknet';
import 'neverthrow';
interface GrpcClientInterface {
getEntities(query: torii.Query): Promise<torii.Entities>;
onEntityUpdated(clause: torii.Clause | null | undefined, world_addresses: string[] | null | undefined, callback: Function): Promise<torii.Subscription>;
updateEntitySubscription(subscription: torii.Subscription, clauses?: torii.Clause | null, world_addresses?: string[] | null): Promise<void>;
getEventMessages(query: torii.Query): Promise<torii.Entities>;
onEventMessageUpdated(clause: torii.Clause | null | undefined, world_addresses: string[] | null | undefined, callback: Function): Promise<torii.Subscription>;
updateEventMessageSubscription(subscription: torii.Subscription, clauses?: torii.Clause | null, world_addresses?: string[] | null): Promise<void>;
getTokens(params: {
contract_addresses?: string[];
token_ids?: any[];
pagination?: torii.Pagination;
}): Promise<torii.Tokens>;
getTokenContracts(params: {
contract_addresses?: string[];
contract_types?: torii.ContractType[];
pagination?: torii.Pagination;
}): Promise<torii.TokenContracts>;
getTokenBalances(params: {
contract_addresses?: string[];
account_addresses?: string[];
token_ids?: any[];
pagination?: torii.Pagination;
}): Promise<torii.TokenBalances>;
getTokenTransfers(params: {
contract_addresses?: string[];
account_addresses?: string[];
token_ids?: any[];
pagination?: torii.Pagination;
}): Promise<torii.TokenTransfers>;
onTokenBalanceUpdated(contractAddresses: string[], accountAddresses: string[], tokenIds: any[], callback: (res: torii.TokenBalance) => void): Promise<torii.Subscription>;
onTokenUpdated(contractAddresses: string[], tokenIds: any[], callback: (res: torii.Token) => void): Promise<torii.Subscription>;
onTokenTransferUpdated(contractAddresses: string[], accountAddresses: string[], tokenIds: any[], callback: (res: torii.TokenTransfer) => void): Promise<torii.Subscription>;
updateTokenBalanceSubscription(subscription: torii.Subscription, contract_addresses: string[], account_addresses: string[], token_ids: any[]): Promise<void>;
updateTokenTransferSubscription(subscription: torii.Subscription, contract_addresses: string[], account_addresses: string[], token_ids: any[]): Promise<void>;
getAchievements(params: torii.AchievementQuery): Promise<AchievementsPage>;
getPlayerAchievements(params: torii.PlayerAchievementQuery): Promise<PlayerAchievementsPage>;
onAchievementProgressionUpdated(world_addresses: string[] | null | undefined, namespaces: string[] | null | undefined, player_addresses: string[] | null | undefined, achievement_ids: string[] | null | undefined, callback: Function): Promise<torii.Subscription>;
updateAchievementProgressionSubscription(subscription: torii.Subscription, world_addresses: string[], namespaces: string[], player_addresses: string[], achievement_ids: string[]): Promise<void>;
publishMessage(message: torii.Message): Promise<string>;
publishMessageBatch(messages: torii.Message[]): Promise<string[]>;
getControllers(params: {
contract_addresses?: string[];
usernames?: string[];
pagination?: torii.Pagination;
}): Promise<torii.Controllers>;
getAggregations(query: torii.AggregationQuery): Promise<AggregationsPage>;
onAggregationUpdated(aggregator_ids: string[] | null | undefined, entity_ids: string[] | null | undefined, callback: Function): Promise<torii.Subscription>;
updateAggregationSubscription(subscription: torii.Subscription, aggregator_ids: string[], entity_ids: string[]): Promise<void>;
getActivities(query: torii.ActivityQuery): Promise<ActivitiesPage>;
onActivityUpdated(world_addresses: string[] | null | undefined, namespaces: string[] | null | undefined, caller_addresses: string[] | null | undefined, callback: Function): Promise<torii.Subscription>;
updateActivitySubscription(subscription: torii.Subscription, world_addresses: string[], namespaces: string[], caller_addresses: string[]): Promise<void>;
executeSql(query: string): Promise<SqlQueryResponse>;
getWorlds(worldAddresses?: string[]): Promise<any[]>;
}
interface InitGrpcOptions {
toriiUrl?: string;
worldAddress: string;
}
declare function initGrpc(options: InitGrpcOptions): GrpcClientInterface;
/**
* Creates a new Torii client instance.
*
* @param {torii.ClientConfig} config - The configuration object for the Torii client.
* @returns {Promise<torii.ToriiClient>} - A promise that resolves to the Torii client instance.
*/
declare function createClient(config: torii$1.ClientConfig): Promise<torii$1.ToriiClient>;
declare const defaultClientConfig: Partial<torii$1.ClientConfig>;
/**
* Initializes the SDK for web environment with the provided configuration and schema.
*
* @template T - The schema type.
* @param {SDKConfig} options - The configuration object for the SDK.
* @returns {Promise<SDK<T>>} - A promise that resolves to the initialized SDK instance.
*
* @example
* ```typescript
* import { init } from "@dojoengine/sdk";
* import { schema } from "./models.gen";
*
* const sdk = await init<typeof schema>({
* client: {
* worldAddress: "0x...",
* toriiUrl: "http://localhost:8080",
* },
* domain: {
* name: "MyApp",
* version: "1.0.0",
* chainId: "SN_MAIN",
* },
* });
* ```
*/
declare function init<T extends SchemaType>(options: SDKConfig & {
grpcClient?: GrpcClientInterface;
}): Promise<SDK<T>>;
export { AchievementsPage, ActivitiesPage, AggregationsPage, type GrpcClientInterface, type InitGrpcOptions, PlayerAchievementsPage, SDK, SDKConfig, SchemaType, SqlQueryResponse, createClient, defaultClientConfig, init, initGrpc };