@tari-project/tarijs 0.4.2 → 0.5.1

package/Dockerfile

@@ -0,0 +1,52 @@
+# Use Node.js 22.13.1 as the base image
+FROM node:22.13.1-slim
+
+# Set working directory
+WORKDIR /app
+# Add proto to PATH and set environment
+ENV PATH="/root/.proto/bin:${PATH}"
+ENV PROTO_HOME="/root/.proto"
+ENV SHELL="/bin/bash"
+# Install system dependencies
+RUN apt-get update && apt-get install -y \
+    git \
+    python3 \
+    build-essential \
+    curl \
+    && rm -rf /var/lib/apt/lists/* \
+    && npm install -g pnpm@latest \
+    && curl -fsSL https://moonrepo.dev/install/proto.sh | bash -s -- -y \
+    && /bin/bash -c "source ~/.bashrc && source ~/.profile"
+
+
+# Clone tari-dan repo at the same level (required for building)
+WORKDIR /
+RUN git clone https://github.com/tari-project/tari-dan.git
+
+# Set up project
+WORKDIR /app
+COPY . .
+
+# Use proto to set up the environment (with explicit shell sourcing)
+SHELL ["/bin/bash", "-c"]
+RUN proto use \
+    && pnpm install \
+    && moon tarijs:build
+
+# Create combined dist directory and copy all dist folders while excluding node_modules
+RUN mkdir -p /app/combined_dist && \
+    for pkg in /app/packages/*/; do \
+        if [ -d "${pkg}dist" ]; then \
+            pkg_name=$(basename $pkg); \
+            mkdir -p "/app/combined_dist/${pkg_name}/dist"; \
+            cp -r "${pkg}dist/"* "/app/combined_dist/${pkg_name}/dist/"; \
+            cp "${pkg}package.json" "/app/combined_dist/${pkg_name}/package.json"; \
+        fi \
+    done && \
+    find /app/packages -name "node_modules" -type d -exec rm -rf {} +
+
+# Set working directory to the combined dist
+WORKDIR /app/combined_dist
+
+# Set default command
+CMD ["bash"] 

package/README.md

@@ -14,7 +14,9 @@ Please read the [TODO](TODO.md) file for upcoming features.
 
 You must have the [tari-dan](https://github.com/tari-project/tari-dan) repo cloned at the same folder level as this repo.
 
-To build the library:
+### Option 1: Local Build
+
+To build the library locally:
 First you must install [proto](https://moonrepo.dev/proto) to manage node and pnpm versions 
 ```shell
 proto use
@@ -22,7 +24,40 @@ pnpm install
 moon tarijs:build
 ```
 
-The bundled files for deployment or publication will be located under the `dist` folder.
+The bundled files for deployment or publication will be located under the `dist` folder of each package.
+
+### Option 2: Docker Build
+
+Alternatively, you can build the library using Docker:
+
+```shell
+# Build the Docker image
+docker build -t tarijs .
+
+# Run the container and copy the combined dist files
+docker create --name tarijs-build tarijs
+docker cp tarijs-build:/app/combined_dist/ ./dist
+docker rm tarijs-build
+```
+
+This will create a combined build output in your local `dist` directory, containing all package distributions organized by package name, with the following structure:
+
+```
+dist/
+├── tarijs/
+├── tari_provider/
+├── tari_permissions/
+├── wallet_daemon/
+├── tari_signer/
+├── builders/
+├── metamask_signer/
+├── tari_universe/
+├── tarijs_types/
+├── indexer_provider/
+└── walletconnect/
+```
+
+Each package's dist folder contains its compiled JavaScript files, type definitions, and other build artifacts, excluding node_modules.
 
 ## Running the example site
 

package/TODO.md

@@ -1,12 +1,4 @@
 # 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)

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/indexer-provider @tari-project/tari-permissions
+```
+
+## Establish the connection
+
+```js
+import { IndexerProvider, IndexerProviderParameters } from "@tari-project/indexer-provider";
+import { TariPermissions } from "@tari-project/tari-permissions";
+
+const permissions = new TariPermissions().addPermission("Admin");
+const optionalPermissions = new TariPermissions();
+const indexerJrpcUrl = "http://127.0.0.1:12006/json_rpc"; // example url
+
+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.5.0",
   "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.1",
   "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.1",
   "description": "",
   "type": "module",
   "publishConfig": {
@@ -13,10 +13,9 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@tari-project/tari-provider": "workspace:^",
-    "@tari-project/tari-universe-provider": "workspace:^",
-    "@tari-project/tarijs-types": "workspace:^",
-    "@tari-project/typescript-bindings": "catalog:"
+    "@tari-project/tari-signer": "workspace:^",
+    "@tari-project/tari-universe-signer": "workspace:^",
+    "@tari-project/tarijs-types": "workspace:^"
   },
   "devDependencies": {
     "@types/node": "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 } from "@tari-project/tari-signer";
 import {
   Transaction,
   TransactionResult,
@@ -8,13 +8,15 @@ import {
   UpSubstates,
   FinalizeResultStatus,
   TxResultAccept,
-  SubmitTxResult
+  SubmitTxResult,
+  ReqSubstate,
+  SubmitTransactionRequest,
 } from "@tari-project/tarijs-types";
 
 export function buildTransactionRequest(
   transaction: Transaction,
   accountId: number,
-  requiredSubstates: SubstateRequirement[],
+  requiredSubstates: ReqSubstate[],
   inputRefs = [],
   isDryRun = false,
   network = 0,
@@ -22,8 +24,6 @@ export function buildTransactionRequest(
   detectInputsUseUnversioned = true,
 ): SubmitTransactionRequest {
   return {
-    //TODO refactor SubTxReq type to not use 'object[]' and types match
-    // https://github.com/tari-project/tari.js/issues/25
     network,
     account_id: accountId,
     instructions: transaction.instructions as object[],
@@ -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,
@@ -75,7 +75,7 @@ export async function waitForTransactionResult(
       throw new Error(`Transaction rejected: ${JSON.stringify(resp.result)}`);
     }
     if (FINALIZED_STATUSES.includes(resp.status)) {
-      return resp as any as TransactionResult; //TODO fix: type mismatch (https://github.com/tari-project/tari.js/issues/29)
+      return resp as TransactionResult;
     }
     await new Promise((resolve) => setTimeout(resolve, 1000));
   }

package/packages/builders/src/transaction/TransactionBuilder.ts

@@ -13,24 +13,23 @@ import {
   Transaction,
   TransactionSignature,
   UnsignedTransaction,
-  TemplateAddress,
-  Arg,
+  PublishedTemplateAddress,
+  TransactionArg,
 } from "@tari-project/tarijs-types";
 
-
 export interface TransactionConstructor {
-  new(unsignedTransaction: UnsignedTransaction, signatures: TransactionSignature[]): Transaction;
+  new (unsignedTransaction: UnsignedTransaction, signatures: TransactionSignature[]): Transaction;
 }
 
 export interface TariFunctionDefinition {
   functionName: string;
-  args?: Arg[];
-  templateAddress: TemplateAddress;
+  args?: TransactionArg[];
+  templateAddress: PublishedTemplateAddress;
 }
 
 export interface TariMethodDefinition {
   methodName: string;
-  args?: Arg[];
+  args?: TransactionArg[];
   componentAddress: ComponentAddress;
 }
 

package/packages/builders/src/transaction/TransactionRequest.ts

@@ -3,7 +3,6 @@ import {
   Instruction,
   SubstateRequirement,
   Transaction,
-  TransactionId,
   TransactionSignature,
   UnsignedTransaction,
   VersionedSubstateId,
@@ -12,7 +11,7 @@ import {
 ///TODO this implementation is not fully done, see:
 /// https://github.com/tari-project/tari-dan/blob/development/dan_layer/transaction/src/transaction.rs
 export class TransactionRequest implements Transaction {
-  id: TransactionId;
+  id: string;
   feeInstructions: Array<Instruction>;
   instructions: Array<Instruction>;
   inputs: Array<SubstateRequirement>;
@@ -23,7 +22,7 @@ export class TransactionRequest implements Transaction {
   filledInputs: VersionedSubstateId[];
 
   constructor(unsignedTransaction: UnsignedTransaction, signatures: TransactionSignature[]) {
-    this.id = this.calculateHash();
+    this.id = "";
     this.feeInstructions = unsignedTransaction.feeInstructions;
     this.instructions = unsignedTransaction.instructions;
     this.inputs = unsignedTransaction.inputs;
@@ -34,23 +33,10 @@ export class TransactionRequest implements Transaction {
     this.filledInputs = [];
   }
 
-  private calculateHash(): TransactionId {
-    return "";
-  }
-
   withFilledInputs(filled_inputs: Array<VersionedSubstateId>): this {
     return { ...this, filled_inputs };
   }
 
-  getId(): TransactionId {
-    return this.id;
-  }
-
-  checkId(): boolean {
-    const id = this.calculateHash();
-    return id === this.id;
-  }
-
   getUnsignedTransaction(): UnsignedTransaction {
     return this.unsignedTransaction;
   }
@@ -67,10 +53,6 @@ export class TransactionRequest implements Transaction {
     return this.signatures;
   }
 
-  getHash(): string {
-    return this.id;
-  }
-
   getInputs(): SubstateRequirement[] {
     return this.inputs;
   }
@@ -90,4 +72,12 @@ export class TransactionRequest implements Transaction {
   getMaxEpoch(): Epoch | undefined {
     return this.maxEpoch;
   }
+
+  setId(id: string): void {
+    this.id = id;
+  }
+
+  getId(): string {
+    return this.id;
+  }
 }

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.1",
+  "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";