@tari-project/indexer-provider 0.5.0

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, The Tari Developer Community
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { IndexerProvider, IndexerProviderParameters } from "./provider";
+export * from "./transports";

package/dist/index.js

@@ -0,0 +1,2 @@
+export { IndexerProvider } from "./provider";
+export * from "./transports";

package/dist/provider.d.ts

@@ -0,0 +1,23 @@
+import { GetSubstateRequest, ListSubstatesRequest, ListSubstatesResponse, Substate, TariProvider, TransactionResult } from "@tari-project/tari-provider";
+import { TariPermissions } from "@tari-project/tari-permissions";
+import { IndexerProviderClient } from "./transports";
+import { GetTemplateDefinitionResponse, ListTemplatesResponse } from "@tari-project/typescript-bindings";
+export interface IndexerProviderParameters {
+    indexerJrpcUrl: string;
+    permissions: TariPermissions;
+    optionalPermissions?: TariPermissions;
+    onConnection?: () => void;
+}
+export declare class IndexerProvider implements TariProvider {
+    providerName: string;
+    client: IndexerProviderClient;
+    params: IndexerProviderParameters;
+    private constructor();
+    static build(params: IndexerProviderParameters): Promise<IndexerProvider>;
+    isConnected(): boolean;
+    listSubstates({ filter_by_template, filter_by_type, limit, offset, }: ListSubstatesRequest): Promise<ListSubstatesResponse>;
+    getSubstate({ substate_address, version }: GetSubstateRequest): Promise<Substate>;
+    listTemplates(limit?: number): Promise<ListTemplatesResponse>;
+    getTransactionResult(transactionId: string): Promise<TransactionResult>;
+    getTemplateDefinition(template_address: string): Promise<GetTemplateDefinitionResponse>;
+}

package/dist/provider.js

@@ -0,0 +1,66 @@
+import { IndexerProviderClient } from "./transports";
+import { stringToSubstateId, substateIdToString, } from "@tari-project/typescript-bindings";
+import { convertStringToTransactionStatus } from "@tari-project/tarijs-types";
+export class IndexerProvider {
+    providerName = "IndexerProvider";
+    client;
+    params;
+    constructor(params, connection) {
+        this.params = params;
+        this.client = connection;
+    }
+    static async build(params) {
+        const client = IndexerProviderClient.usingFetchTransport(params.indexerJrpcUrl);
+        await client.getIdentity();
+        params.onConnection?.();
+        return new IndexerProvider(params, client);
+    }
+    isConnected() {
+        return this.client.isConnected();
+    }
+    async listSubstates({ filter_by_template, filter_by_type, limit, offset, }) {
+        const resp = await this.client.listSubstates({
+            filter_by_template,
+            filter_by_type,
+            limit,
+            offset,
+        });
+        const substates = resp.substates.map((s) => ({
+            substate_id: typeof s.substate_id === "string" ? s.substate_id : substateIdToString(s.substate_id),
+            module_name: s.module_name,
+            version: s.version,
+            template_address: s.template_address,
+        }));
+        return { substates };
+    }
+    async getSubstate({ substate_address, version }) {
+        const resp = await this.client.getSubstate({
+            address: stringToSubstateId(substate_address),
+            version: version ?? null,
+            local_search_only: false,
+        });
+        return {
+            address: {
+                substate_id: substateIdToString(resp.address),
+                version: resp.version,
+            },
+            value: resp.substate,
+        };
+    }
+    async listTemplates(limit = 0) {
+        const resp = await this.client.listTemplates({ limit });
+        return resp;
+    }
+    async getTransactionResult(transactionId) {
+        const resp = await this.client.getTransactionResult({ transaction_id: transactionId });
+        return {
+            transaction_id: transactionId,
+            status: convertStringToTransactionStatus(resp.status),
+            result: resp.result,
+        };
+    }
+    async getTemplateDefinition(template_address) {
+        let resp = await this.client.getTemplateDefinition({ template_address });
+        return resp;
+    }
+}

package/dist/transports/IndexerProviderClient.d.ts

@@ -0,0 +1,30 @@
+import { GetEpochManagerStatsResponse, GetNonFungibleCollectionsResponse, GetNonFungibleCountRequest, GetNonFungibleCountResponse, GetNonFungiblesRequest, GetNonFungiblesResponse, GetRelatedTransactionsRequest, GetRelatedTransactionsResponse, GetTemplateDefinitionRequest, GetTemplateDefinitionResponse, IndexerGetIdentityResponse, IndexerGetSubstateRequest, IndexerGetSubstateResponse, IndexerSubmitTransactionRequest, IndexerSubmitTransactionResponse, InspectSubstateRequest, InspectSubstateResponse, ListTemplatesRequest, ListTemplatesResponse, SubstatesListRequest, SubstatesListResponse, TransactionGetResultRequest, TransactionGetResultResponse, TransactionWaitResultRequest, TransactionWaitResultResponse } from "@tari-project/typescript-bindings";
+import { RpcTransport } from "./rpc";
+export declare class IndexerProviderClient {
+    private token;
+    private transport;
+    private id;
+    private connected;
+    constructor(transport: RpcTransport);
+    static new(transport: RpcTransport): IndexerProviderClient;
+    static usingFetchTransport(url: string): IndexerProviderClient;
+    getTransport(): RpcTransport;
+    isAuthenticated(): boolean;
+    isConnected(): boolean;
+    setToken(token: string): void;
+    submitTransaction(params: IndexerSubmitTransactionRequest): Promise<IndexerSubmitTransactionResponse>;
+    inspectSubstate(params: InspectSubstateRequest): Promise<InspectSubstateResponse>;
+    getSubstate(params: IndexerGetSubstateRequest): Promise<IndexerGetSubstateResponse>;
+    listSubstates(params: SubstatesListRequest): Promise<SubstatesListResponse>;
+    listTemplates(params: ListTemplatesRequest): Promise<ListTemplatesResponse>;
+    getTemplateDefinition(params: GetTemplateDefinitionRequest): Promise<GetTemplateDefinitionResponse>;
+    getTransactionResult(params: TransactionGetResultRequest): Promise<TransactionGetResultResponse>;
+    getSubstateTransactions(params: GetRelatedTransactionsRequest): Promise<GetRelatedTransactionsResponse>;
+    getNonFungibles(params: GetNonFungiblesRequest): Promise<GetNonFungiblesResponse>;
+    getNonFungibleCollections(): Promise<GetNonFungibleCollectionsResponse>;
+    getNonFungibleCount(params: GetNonFungibleCountRequest): Promise<GetNonFungibleCountResponse>;
+    getEpochManagerStats(): Promise<GetEpochManagerStatsResponse>;
+    waitForTransactionResult(params: TransactionWaitResultRequest): Promise<TransactionWaitResultResponse>;
+    getIdentity(): Promise<IndexerGetIdentityResponse | undefined>;
+    __invokeRpc(method: string, params?: object | null): Promise<any>;
+}

package/dist/transports/IndexerProviderClient.js

@@ -0,0 +1,91 @@
+import { FetchRpcTransport } from "./rpc";
+export class IndexerProviderClient {
+    token;
+    transport;
+    id;
+    connected;
+    constructor(transport) {
+        this.token = null;
+        this.transport = transport;
+        this.id = 0;
+        this.connected = false;
+    }
+    static new(transport) {
+        return new IndexerProviderClient(transport);
+    }
+    static usingFetchTransport(url) {
+        return IndexerProviderClient.new(FetchRpcTransport.new(url));
+    }
+    getTransport() {
+        return this.transport;
+    }
+    isAuthenticated() {
+        return this.token !== null;
+    }
+    isConnected() {
+        return this.connected;
+    }
+    setToken(token) {
+        this.token = token;
+    }
+    submitTransaction(params) {
+        return this.__invokeRpc("submit_transaction", params);
+    }
+    inspectSubstate(params) {
+        return this.__invokeRpc("inspect_substate", params);
+    }
+    getSubstate(params) {
+        return this.__invokeRpc("get_substate", params);
+    }
+    listSubstates(params) {
+        return this.__invokeRpc("list_substates", params);
+    }
+    listTemplates(params) {
+        return this.__invokeRpc("list_templates", params);
+    }
+    getTemplateDefinition(params) {
+        return this.__invokeRpc("get_template_definition", params);
+    }
+    getTransactionResult(params) {
+        return this.__invokeRpc("get_transaction_result", params);
+    }
+    getSubstateTransactions(params) {
+        return this.__invokeRpc("get_substate_transactions", params);
+    }
+    getNonFungibles(params) {
+        return this.__invokeRpc("get_non_fungibles", params);
+    }
+    getNonFungibleCollections() {
+        return this.__invokeRpc("get_non_fungible_collections");
+    }
+    getNonFungibleCount(params) {
+        return this.__invokeRpc("get_non_fungible_count", params);
+    }
+    getEpochManagerStats() {
+        return this.__invokeRpc("get_epoch_manager_stats");
+    }
+    waitForTransactionResult(params) {
+        return this.__invokeRpc("transactions.wait_result", params);
+    }
+    async getIdentity() {
+        try {
+            const res = await this.__invokeRpc("get_identity");
+            this.connected = !!res.public_key;
+            return res;
+        }
+        catch (e) {
+            console.error("Failed to get Indexer identity:", e);
+            this.connected = false;
+        }
+    }
+    async __invokeRpc(method, params = null) {
+        const id = this.id++;
+        const response = await this.transport.sendRequest({
+            method,
+            jsonrpc: "2.0",
+            id: id,
+            params: params || {},
+        }, { token: this.token ?? undefined, timeout_millis: undefined });
+        return response;
+    }
+}

package/dist/transports/fetch.d.ts

@@ -0,0 +1,7 @@
+import { RpcRequest, RpcTransport, RpcTransportOptions } from "./rpc";
+export default class FetchRpcTransport implements RpcTransport {
+    private url;
+    constructor(url: string);
+    static new(url: string): FetchRpcTransport;
+    sendRequest<T>(data: RpcRequest, options: RpcTransportOptions): Promise<T>;
+}

package/dist/transports/fetch.js

@@ -0,0 +1,38 @@
+export default class FetchRpcTransport {
+    url;
+    constructor(url) {
+        this.url = url;
+    }
+    static new(url) {
+        return new FetchRpcTransport(url);
+    }
+    async sendRequest(data, options) {
+        const headers = {
+            "Content-Type": "application/json",
+        };
+        if (options?.token) {
+            headers["Authorization"] = `Bearer ${options.token}`;
+        }
+        let controller = new AbortController();
+        let signal = controller.signal;
+        const timeoutId = options.timeout_millis
+            ? setTimeout(() => {
+                controller.abort("Timeout");
+            }, options.timeout_millis)
+            : null;
+        const response = await fetch(this.url, {
+            method: "POST",
+            body: JSON.stringify(data),
+            headers,
+            signal,
+        });
+        if (timeoutId) {
+            clearTimeout(timeoutId);
+        }
+        const json = await response.json();
+        if (json.error) {
+            throw new Error(`${json.error.code}: ${json.error.message}`);
+        }
+        return json.result;
+    }
+}

package/dist/transports/index.d.ts

@@ -0,0 +1,3 @@
+export { IndexerProviderClient } from "./IndexerProviderClient";
+export * from "./fetch";
+export * from "./rpc";

package/dist/transports/index.js

@@ -0,0 +1,3 @@
+export { IndexerProviderClient } from "./IndexerProviderClient";
+export * from "./fetch";
+export * from "./rpc";

package/dist/transports/rpc.d.ts

@@ -0,0 +1,15 @@
+import FetchRpcTransport from "./fetch";
+export { FetchRpcTransport };
+export interface RpcTransport {
+    sendRequest<T>(request: RpcRequest, options: RpcTransportOptions): Promise<T>;
+}
+export interface RpcTransportOptions {
+    token?: string;
+    timeout_millis?: number;
+}
+export interface RpcRequest {
+    id: number;
+    jsonrpc: string;
+    method: string;
+    params: any;
+}

package/dist/transports/rpc.js

@@ -0,0 +1,2 @@
+import FetchRpcTransport from "./fetch";
+export { FetchRpcTransport };

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@tari-project/indexer-provider",
+  "version": "0.5.0",
+  "description": "",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@tari-project/typescript-bindings": "^1.5.1",
+    "@tari-project/wallet_jrpc_client": "^1.5.1",
+    "@tari-project/tari-permissions": "^0.5.0",
+    "@tari-project/tarijs-types": "^0.5.0",
+    "@tari-project/tari-provider": "^0.5.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.1",
+    "typescript": "^5.0.4"
+  },
+  "files": [
+    "/dist"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -b"
+  }
+}