@tari-project/tarijs 0.4.2 → 0.5.0

package/TODO.md

@@ -1,12 +1,8 @@
 # TODO
 
-- In the wallet provider interface:
-  - Full TypeScript class definitions for transaction requests (instructions, etc.).
-  - Common return types for both types of wallets.
-  - Implement `getSubstate` method for the Tari Wallet Daemon provider.
-  - Add account balance to `getAccountData` method for the Tari Wallet Daemon provider.
 - For the example site:
-  - The button should indicate when a connection was established.
   - The `TariConnect` button could be made into a reusable React component, ready to be imported by any web.
 - Typescript-bindings
   - [Types refactor and cleanup](https://github.com/tari-project/tari.js/issues/29)
+- Other
+  - Configure prettier to not change entire file while saving

package/docusaurus/tari-docs/docs/index.md

@@ -7,10 +7,15 @@ slug: /
 
 This is the documentation of `tari.js` library, which enables interaction with Tari L2 (Ootle) wallet using TypeScript or JavaScript.
 
-At its core, `TariProvider` is an abstract interface implemented by multiple concrete providers. To access a wallet, you need to create an instance of one of these providers:
+### Note
 
-* [Tari WalletConnect provider](./providers/wallet-connect.md)
-* [Tari Universe provider](./providers/tari-universe.md)
-* [Tari Wallet Daemon provider](./providers/wallet-daemon.md)
-* Tari Metamask provider
+> This documentation covers version **v0.5.0**.
+>
+> The biggest difference between version 0.4.0 and 0.5.0 is the _Signer_ and _Provider_ split. Learn more in the [Tari Provider](./providers/indexer-provider.md) and [Tari Signer](./signers/wallet-connect.md) sections.
 
+At its core, `TariSigner` is an abstract interface implemented by multiple concrete signers. To access a wallet, you need to create an instance of one of these signers:
+
+- [Tari WalletConnect signer](./signers/wallet-connect.md)
+- [Tari Universe signer](./signers/tari-universe.md)
+- [Tari Wallet Daemon signer](./signers/wallet-daemon.md)
+- Tari Metamask signer

package/docusaurus/tari-docs/docs/installation.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 1
 title: Installation
 ---
 

package/docusaurus/tari-docs/docs/providers/_category_.json

@@ -1,8 +1,8 @@
 {
   "label": "Providers",
-  "position": 3,
+  "position": 1,
   "link": {
     "type": "generated-index",
-    "description": "List of all available providers."
+    "description": "A Provider provides a connection to the blockchain, whch can be used to query its current state, but only the public one."
   }
 }

package/docusaurus/tari-docs/docs/providers/indexer-provider.md

@@ -0,0 +1,32 @@
+---
+sidebar_position: 1
+---
+
+# Indexer Provider
+
+This provider is designed to provide connection to the blockchain, whch can be used to query its current state, but only the public one.
+
+## Install required dependencies
+
+```bash npm2yarn
+npm install @tari-project/tari-universe-signer @tari-project/tari-permissions
+```
+
+## Establish the connection
+
+```js
+import { TariPermissions } from "@tari-project/tari-permissions";
+import { TariUniverseSigner } from "@tari-project/tari-universe-signer";
+
+const permissions = new TariPermissions().addPermission("Admin");
+const optionalPermissions = new TariPermissions();
+const indexerJrpcUrl = "http://127.0.0.1:12006/json_rpc";
+
+const params: IndexerProviderParameters = {
+  indexerJrpcUrl: indexerJrpcUrl,
+  permissions: requiredPermissions,
+  optionalPermissions: optionalPermissions,
+};
+
+const provider = await IndexerProvider.build(params);
+```

package/docusaurus/tari-docs/docs/signers/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Signers",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "List of all available signers."
+  }
+}

package/docusaurus/tari-docs/docs/{providers → signers}/tari-universe.md

@@ -2,25 +2,25 @@
 sidebar_position: 2
 ---
 
-# Tari Universe provider
+# Tari Universe signer
 
-This provider is designed for building Tari Universe apps.
+This signer is designed for building Tari Universe apps.
 
 ## Install required dependencies
 
 ```bash npm2yarn
-npm install @tari-project/tari-universe-provider @tari-project/tari-permissions
+npm install @tari-project/tari-universe-signer @tari-project/tari-permissions
 ```
 
 ## Establish the connection
 
 ```js
 import { TariPermissions } from "@tari-project/tari-permissions";
-import { TariUniverseProvider } from "@tari-project/tari-universe-provider";
+import { TariUniverseSigner } from "@tari-project/tari-universe-signer";
 
 const permissions = new TariPermissions().addPermission("Admin");
 const optionalPermissions = new TariPermissions();
-const provider = new TariUniverseProvider({
+const signer = new TariUniverseSigner({
   permissions,
   optionalPermissions,
 });

package/docusaurus/tari-docs/docs/{providers → signers}/wallet-connect.md

@@ -2,18 +2,17 @@
 sidebar_position: 1
 ---
 
-
-# WalletConnect provider
+# WalletConnect signer
 
 [WalletConnect](https://walletconnect.network/) is an open-source protocol that lets users connect their cryptocurrency wallets to decentralized applications (dApps) in a secure way. It uses QR codes or deep linking to establish a connection between the wallet and the dApp, allowing users to interact with dApps without exposing their private keys.
 
 ## Install required dependencies
 
 ```bash npm2yarn
-npm install @tari-project/wallet-connect-provider
+npm install @tari-project/wallet-connect-signer
 ```
 
-`WalletConnect` provider is browser only. This means it requires user interaction.
+`WalletConnect` signer is browser only. This means it requires user interaction.
 
 Establishing connection requires multiple steps.
 
@@ -24,11 +23,11 @@ Obtain a WalletConnect Project ID by registering your project on the WalletConne
 ## Request a connection and display wallet connect dialog
 
 ```js
-import { WalletConnectTariProvider } from "@tari-project/wallet-connect-provider";
+import { WalletConnectTariSigner } from "@tari-project/wallet-connect-signer";
 
 const projectId = "1825b9dd9c17b5a33063ae91cbc48a6e";
-const provider = new WalletConnectTariProvider(projectId);
-await provider.connect();
+const signer = new WalletConnectTariSigner(projectId);
+await signer.connect();
 ```
 
 You should see `WalletConnect` dialog:

package/docusaurus/tari-docs/docs/{providers → signers}/wallet-daemon.md

@@ -2,31 +2,31 @@
 sidebar_position: 3
 ---
 
-# Wallet daemon provider
+# Wallet daemon signer
 
-This is the only provider that works in both Node.js and browser environments. It enables a direct connection to a wallet via JSON-RPC.
+This is the only signer that works in both Node.js and browser environments. It enables a direct connection to a wallet via JSON-RPC.
 
 ## Install required dependencies
 
 ```bash npm2yarn
-npm install @tari-project/wallet-daemon-provider @tari-project/tari-permissions
+npm install @tari-project/wallet-daemon-signer @tari-project/tari-permissions
 ```
 
 ## Establish and test the connection
 
 ```js
 import { TariPermissions } from "@tari-project/tari-permissions";
-import { WalletDaemonTariProvider } from "@tari-project/wallet-daemon-provider";
+import { WalletDaemonTariSigner } from "@tari-project/wallet-daemon-signer";
 
 const permissions = new TariPermissions().addPermission("Admin");
 const serverUrl = "http://127.0.0.1:12010/json_rpc";
-const provider = await WalletDaemonTariProvider.buildFetchProvider({
+const signer = await WalletDaemonTariSigner.buildFetchProvider({
   permissions,
   serverUrl,
 });
 
 // Test connection
-const account = await provider.getAccount();
+const account = await signer.getAccount();
 console.log(`Account address: ${account.address}`);
 ```
 
@@ -34,4 +34,4 @@ If the connection is successful, it should output an account address similar to
 
 ```txt
 Account id: component_24b679b98056c7ca7e3d9f9266fec928c7f29d35e7aec546ed69f532aff40710
-```
+```

package/docusaurus/tari-docs/docs/wallet/_category_.json

@@ -3,6 +3,6 @@
   "position": 4,
   "link": {
     "type": "generated-index",
-    "description": "Features of TariProvider."
+    "description": "Features of TariSigner."
   }
 }

package/docusaurus/tari-docs/docs/wallet/list-substates.md

@@ -7,7 +7,7 @@ sidebar_position: 3
 In the Tari network, substates are discrete units of state within the Tari Digital Assets Network. Each substate encapsulates a specific piece of data—such as ownership records, smart contract states, or asset balances.  
 Substates follow a create-spend lifecycle, meaning they are created, referenced, and eventually consumed or modified according to network rules.
 
-You can query substates using the `listSubstates` method of a `TariProvider`.
+You can query substates using the `listSubstates` method of a `TariSigner`.
 
 ```ts
 listSubstates(
@@ -18,7 +18,6 @@ listSubstates(
 ): Promise<ListSubstatesResponse>;
 ```
 
-
 ## List by template
 
 ```js
@@ -66,4 +65,4 @@ Output:
     }
   ]
 }
-```
+```

package/docusaurus/tari-docs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tari-docs",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",

package/docusaurus/tari-docs/tsconfig.json

@@ -1,8 +1,10 @@
 {
   // This file is not used in compilation. It is here just for a nice editor experience.
+  // "composite" added to resolve the ts error: "Referenced project '/docusaurus/tari-docs' must have setting "composite": true
   "extends": "@docusaurus/tsconfig",
   "compilerOptions": {
-    "baseUrl": "."
+    "baseUrl": ".",
+    "composite": true
   },
   "exclude": [".docusaurus", "build"]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tarijs",
-  "version": "0.4.2",
+  "version": "0.5.0",
   "description": "",
   "type": "module",
   "keywords": [],

package/packages/builders/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tarijs-builders",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "",
   "type": "module",
   "publishConfig": {
@@ -13,8 +13,8 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@tari-project/tari-provider": "workspace:^",
-    "@tari-project/tari-universe-provider": "workspace:^",
+    "@tari-project/tari-signer": "workspace:^",
+    "@tari-project/tari-universe-signer": "workspace:^",
     "@tari-project/tarijs-types": "workspace:^",
     "@tari-project/typescript-bindings": "catalog:"
   },

package/packages/builders/src/helpers/submitTransaction.ts

@@ -1,5 +1,5 @@
-import { TariUniverseProvider } from "@tari-project/tari-universe-provider";
-import { TariProvider, SubmitTransactionRequest, SubstateRequirement } from "@tari-project/tari-provider";
+import { TariUniverseSigner } from "@tari-project/tari-universe-signer";
+import { TariSigner, SubmitTransactionRequest, SubstateRequirement } from "@tari-project/tari-signer";
 import {
   Transaction,
   TransactionResult,
@@ -8,7 +8,7 @@ import {
   UpSubstates,
   FinalizeResultStatus,
   TxResultAccept,
-  SubmitTxResult
+  SubmitTxResult,
 } from "@tari-project/tarijs-types";
 
 export function buildTransactionRequest(
@@ -40,12 +40,12 @@ export function buildTransactionRequest(
 }
 
 export async function submitAndWaitForTransaction(
-  provider: TariProvider,
+  signer: TariSigner,
   req: SubmitTransactionRequest,
 ): Promise<SubmitTxResult> {
   try {
-    const response = await provider.submitTransaction(req);
-    const result = await waitForTransactionResult(provider, response.transaction_id);
+    const response = await signer.submitTransaction(req);
+    const result = await waitForTransactionResult(signer, response.transaction_id);
 
     return {
       response,
@@ -57,12 +57,12 @@ export async function submitAndWaitForTransaction(
 }
 
 export async function waitForTransactionResult(
-  provider: TariProvider | TariUniverseProvider,
+  signer: TariSigner | TariUniverseSigner,
   transactionId: string,
 ): Promise<TransactionResult> {
   // eslint-disable-next-line no-constant-condition
   while (true) {
-    const resp = await provider.getTransactionResult(transactionId);
+    const resp = await signer.getTransactionResult(transactionId);
     const FINALIZED_STATUSES = [
       TransactionStatus.Accepted,
       TransactionStatus.Rejected,

package/packages/builders/tsconfig.json

@@ -7,12 +7,10 @@
     "outDir": "./dist",
     "rootDir": "./src"
   },
-  "include": [
-    "src/**/*"
-  ],
+  "include": ["src/**/*"],
   "references": [
     {
-      "path": "../tari_provider"
+      "path": "../tari_signer"
     },
     {
       "path": "../tari_universe"

package/packages/indexer_provider/package.json

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

package/packages/indexer_provider/src/index.ts

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

package/packages/indexer_provider/src/provider.ts

@@ -0,0 +1,105 @@
+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,
+  stringToSubstateId,
+  substateIdToString,
+  SubstatesListRequest,
+} from "@tari-project/typescript-bindings";
+import { convertStringToTransactionStatus } from "@tari-project/tarijs-types";
+
+export interface IndexerProviderParameters {
+  indexerJrpcUrl: string;
+  permissions: TariPermissions;
+  optionalPermissions?: TariPermissions;
+  onConnection?: () => void;
+}
+
+export class IndexerProvider implements TariProvider {
+  public providerName = "IndexerProvider";
+  client: IndexerProviderClient;
+  params: IndexerProviderParameters;
+
+  private constructor(params: IndexerProviderParameters, connection: IndexerProviderClient) {
+    this.params = params;
+    this.client = connection;
+  }
+
+  static async build(params: IndexerProviderParameters) {
+    const client = IndexerProviderClient.usingFetchTransport(params.indexerJrpcUrl);
+    await client.getIdentity();
+    params.onConnection?.();
+    return new IndexerProvider(params, client);
+  }
+
+  public isConnected(): boolean {
+    return this.client.isConnected();
+  }
+
+  public async listSubstates({
+    filter_by_template,
+    filter_by_type,
+    limit,
+    offset,
+  }: ListSubstatesRequest): Promise<ListSubstatesResponse> {
+    const resp = await this.client.listSubstates({
+      filter_by_template,
+      filter_by_type,
+      limit,
+      offset,
+    } as SubstatesListRequest);
+
+    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 };
+  }
+
+  public async getSubstate({ substate_address, version }: GetSubstateRequest): Promise<Substate> {
+    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,
+    };
+  }
+
+  public async listTemplates(limit: number = 0): Promise<ListTemplatesResponse> {
+    const resp = await this.client.listTemplates({ limit });
+    return resp;
+  }
+
+  public async getTransactionResult(transactionId: string): Promise<TransactionResult> {
+    const resp = await this.client.getTransactionResult({ transaction_id: transactionId });
+
+    return {
+      transaction_id: transactionId,
+      status: convertStringToTransactionStatus(resp.status),
+      result: resp.result,
+    };
+  }
+
+  public async getTemplateDefinition(template_address: string): Promise<GetTemplateDefinitionResponse> {
+    let resp = await this.client.getTemplateDefinition({ template_address });
+    return resp;
+  }
+}

package/packages/indexer_provider/src/transports/IndexerProviderClient.ts

@@ -0,0 +1,144 @@
+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 { FetchRpcTransport, RpcTransport } from "./rpc";
+
+export class IndexerProviderClient {
+  private token: string | null;
+  private transport: RpcTransport;
+  private id: number;
+  private connected: boolean;
+
+  constructor(transport: RpcTransport) {
+    this.token = null;
+    this.transport = transport;
+    this.id = 0;
+    this.connected = false;
+  }
+
+  public static new(transport: RpcTransport): IndexerProviderClient {
+    return new IndexerProviderClient(transport);
+  }
+
+  public static usingFetchTransport(url: string): IndexerProviderClient {
+    return IndexerProviderClient.new(FetchRpcTransport.new(url));
+  }
+
+  getTransport() {
+    return this.transport;
+  }
+
+  public isAuthenticated() {
+    return this.token !== null;
+  }
+
+  public isConnected() {
+    return this.connected;
+  }
+
+  public setToken(token: string) {
+    this.token = token;
+  }
+
+  public submitTransaction(params: IndexerSubmitTransactionRequest): Promise<IndexerSubmitTransactionResponse> {
+    return this.__invokeRpc("submit_transaction", params);
+  }
+
+  public inspectSubstate(params: InspectSubstateRequest): Promise<InspectSubstateResponse> {
+    return this.__invokeRpc("inspect_substate", params);
+  }
+
+  public getSubstate(params: IndexerGetSubstateRequest): Promise<IndexerGetSubstateResponse> {
+    return this.__invokeRpc("get_substate", params);
+  }
+
+  public listSubstates(params: SubstatesListRequest): Promise<SubstatesListResponse> {
+    return this.__invokeRpc("list_substates", params);
+  }
+
+  public listTemplates(params: ListTemplatesRequest): Promise<ListTemplatesResponse> {
+    return this.__invokeRpc("list_templates", params);
+  }
+
+  public getTemplateDefinition(params: GetTemplateDefinitionRequest): Promise<GetTemplateDefinitionResponse> {
+    return this.__invokeRpc("get_template_definition", params);
+  }
+
+  public getTransactionResult(params: TransactionGetResultRequest): Promise<TransactionGetResultResponse> {
+    return this.__invokeRpc("get_transaction_result", params);
+  }
+
+  public getSubstateTransactions(params: GetRelatedTransactionsRequest): Promise<GetRelatedTransactionsResponse> {
+    return this.__invokeRpc("get_substate_transactions", params);
+  }
+
+  public getNonFungibles(params: GetNonFungiblesRequest): Promise<GetNonFungiblesResponse> {
+    return this.__invokeRpc("get_non_fungibles", params);
+  }
+
+  public getNonFungibleCollections(): Promise<GetNonFungibleCollectionsResponse> {
+    return this.__invokeRpc("get_non_fungible_collections");
+  }
+
+  public getNonFungibleCount(params: GetNonFungibleCountRequest): Promise<GetNonFungibleCountResponse> {
+    return this.__invokeRpc("get_non_fungible_count", params);
+  }
+
+  public getEpochManagerStats(): Promise<GetEpochManagerStatsResponse> {
+    return this.__invokeRpc("get_epoch_manager_stats");
+  }
+
+  public waitForTransactionResult(params: TransactionWaitResultRequest): Promise<TransactionWaitResultResponse> {
+    return this.__invokeRpc("transactions.wait_result", params);
+  }
+
+  public async getIdentity(): Promise<IndexerGetIdentityResponse | undefined> {
+    try {
+      const res: IndexerGetIdentityResponse = 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: string, params: object | null = null) {
+    const id = this.id++;
+    const response = await this.transport.sendRequest<any>(
+      {
+        method,
+        jsonrpc: "2.0",
+        id: id,
+        params: params || {},
+      },
+      { token: this.token ?? undefined, timeout_millis: undefined },
+    );
+
+    return response;
+  }
+}