@tari-project/tarijs 0.5.4 → 0.6.0

package/.github/workflows/check-package-versions.yml

@@ -0,0 +1,22 @@
+# Check package versions
+name: Check Package Versions
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+jobs:
+  check_versions:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check package.json versions
+        run: ./scripts/check_versions.sh

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

@@ -9,19 +9,100 @@ title: Installation
 
 Usually, you will need to install the base package and at least one package that implements a concrete provider.
 
-## Install base package
+## Prerequisites
 
-```bash npm2yarn
-npm install @tari-project/tarijs
+Before you begin with the above, however, you will need to have at minimum a default web project template set up in your IDE of choice. We have provided instructions for creating a base React + Vite project below in your IDE of choice, but you are not limited to React. 
+
+Tari.js is useable in any Typescript or Javascript application and framework, so you have full flexibility to choose whichever technology and framework suits you.
+
+
+### Create a React project
+
+The quickest way to set up a new React project is to leverage `vite` to do so.
+
+In the terminal, run the following command below, and select `Y` to continue
+
+```bash
+npm create vite@latest
+```
+
+When you run this command, you'll be likely asked to install the following. Select `Y` to continue
+
+```bash
+Need to install the following packages:
+create-vite@6.3.1
+Ok to proceed? (y)
+```
+
+You'll be asked to enter a project name. You can call it what you like but to make it easy to follow along, let's call it the `'base-app`. 
+
+```bash
+> npx
+> create-vite
+
+✔ Project name: … base-app
+```
+Next, select `React` from the list of options:
+
+```bash
+? Select a framework: › - Use arrow-keys. Return to submit.
+    Vanilla
+    Vue
+❯   React
+    Preact
+    Lit
+    Svelte
+    Solid
+    Qwik
+    Angular
+    Others
+```
+
+Lastly, choose the `Typescript` variant:
+
+```bash
+? Select a variant: › - Use arrow-keys. Return to submit.
+❯   TypeScript
+    TypeScript + SWC
+    JavaScript
+    JavaScript + SWC
+    React Router v7 ↗
+```
+
+Once this is done, you'll be instructed to enter the following commands. Do so in the same terminal:
+
+```bash
+  cd latest
+  npm install
+  npm run dev
+```
+
+The above will install all the necessary dependencies and then run the template Vite + React application. When running the application, you'll see the following message:
+
+```bash
+  VITE v6.2.1  ready in 123 ms
+
+  ➜  Local:   http://localhost:5173/
+  ➜  Network: use --host to expose
+  ➜  press h + enter to show help
 ```
 
-## Install a provider
+The `localhost:port` address indicates that you have the app running locally at that address. Entering the address in your browser will open up the stock app. You'll see something equivalent to the below:
+
+You can view the project and its associated files on the left-hand side of VS Code
 
-For this documentation, we will use the `Wallet Daemon Provider`, which allows direct connection to the wallet if you are hosting it locally.
-However, you are free to install any other available provider.
+We'll be modifying this app to get your Hello Ootle app up and running. For now, you can proceed to the next step.
+
+## Install the base package
+
+Use the below commands to install the tari.js base package.
 
 ```bash npm2yarn
-npm install @tari-project/wallet-daemon-provider
+npm install @tari-project/tarijs
 ```
 
-We will review all providers on their dedicated pages.
+## Install a provider or signer.
+
+In order to use the wallet, you will need to connect either to an Ootle indexer or a signer that allows you to interact with the Ootle via several clients. We explain more about providers and signers in the following section, but in short:
+- You will use an indexer when you simply want to obtain information from the Ootle.
+- A signer is used when you wish to modify, interact with or create on the Ootle.

package/docusaurus/tari-docs/docs/wallet/submit-transaction/transaction-builder/instruction.md

@@ -4,7 +4,7 @@ sidebar_position: 3
 
 # Instructions
 
-There are nine types of instructions. In most cases, you will not need to create raw instructions yourself but will instead use one of the methods provided by the Transaction Builder.
+There are ten types of instructions. In most cases, you will not need to create raw instructions yourself but will instead use one of the methods provided by the Transaction Builder.
 
 ## CreateAccount
 
@@ -105,4 +105,15 @@ DropAllProofsInWorkspace
     "output": ConfidentialOutput | null
   }
 }
+```
+
+## AllocateAddress
+
+```json
+{
+  "AllocateAddress": {
+    "substate_type": string,
+    "workspace_id": string
+  }
+}
 ```

package/docusaurus/tari-docs/package.json

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

package/package.json

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

package/packages/builders/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tarijs-builders",
-  "version": "0.5.4",
+  "version": "0.6.0",
   "description": "",
   "type": "module",
   "publishConfig": {

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

@@ -3,19 +3,14 @@ import { WorkspaceArg } from "@tari-project/tarijs-types";
 /**
  *
  * @param key workspace name
- * @returns encoded Uint8Array value
+ * @returns encoded hex value
  * @example
- * key: "0"   -> [ 48 ]
- * key: "0.0" -> [ 48, 46, 48 ]
- * key: "0.1" -> [ 48, 46, 49 ]
- *
- * key: "bucket"   -> [ 98, 117, 99, 107, 101, 116 ]
- * key: "bucket.0" -> [ 98, 117, 99, 107, 101, 116, 46, 48 ]
- * key: "bucket.1" -> [ 98, 117, 99, 107, 101, 116, 46, 49 ]
+ * key: "bucket"   -> "6275636b6574"
+ * key: "bucket.0" -> "6275636b65742e30"
+ * key: "bucket.1" -> "6275636b65742e31"
  */
-export function toWorkspace(key: string): number[] {
-  const encoder = new TextEncoder();
-  return Array.from(encoder.encode(key));
+export function toWorkspace(key: string): string {
+  return Buffer.from(key).toString("hex");
 }
 
 /**
@@ -23,10 +18,8 @@ export function toWorkspace(key: string): number[] {
  * @param key workspace name
  * @returns formatted Workspace data
  * @example
- * key: "bucket" -> { Workspace: [ 98, 117, 99, 107, 101, 116 ] }
+ * key: "bucket" -> { Workspace: "6275636b6574" }
  */
 export function fromWorkspace(key: string): WorkspaceArg {
-  const encoder = new TextEncoder();
-  const encodedKey = encoder.encode(key);
-  return { Workspace: Array.from(encodedKey) };
+  return { Workspace: Buffer.from(key).toString("hex") };
 }

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

@@ -14,6 +14,7 @@ import {
   TransactionSignature,
   UnsignedTransaction,
   PublishedTemplateAddress,
+  SubstateType,
   TransactionArg,
 } from "@tari-project/tarijs-types";
 
@@ -151,6 +152,15 @@ export class TransactionBuilder implements Builder {
     });
   }
 
+  public allocateAddress(substateType: SubstateType, workspaceId: string): this {
+    return this.addInstruction({
+      AllocateAddress: {
+        substate_type: substateType,
+        workspace_id: workspaceId,
+      },
+    });
+  }
+
   /**
    * The `SaveVar` method replaces
    * `PutLastInstructionOutputOnWorkspace: { key: Array<number> }`

package/packages/indexer_provider/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/indexer-provider",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "description": "",
   "type": "module",
   "publishConfig": {

package/packages/indexer_provider/src/provider.ts

@@ -70,7 +70,7 @@ export class IndexerProvider implements TariProvider {
 
   public async getSubstate({ substate_address, version }: GetSubstateRequest): Promise<Substate> {
     const resp = await this.client.getSubstate({
-      address: stringToSubstateId(substate_address),
+      address: substate_address,
       version: version ?? null,
       local_search_only: false,
     });

package/packages/metamask_signer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/metamask-signer",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "description": "",
   "type": "module",
   "publishConfig": {

package/packages/tari_permissions/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tari-permissions",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "description": "",
   "type": "module",
   "publishConfig": {

package/packages/tari_provider/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tari-provider",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "description": "",
   "type": "module",
   "publishConfig": {

package/packages/tari_signer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tari-signer",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "description": "",
   "type": "module",
   "publishConfig": {

package/packages/tari_universe/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tari-universe-signer",
-  "version": "0.5.4",
+  "version": "0.6.0",
   "description": "",
   "type": "module",
   "publishConfig": {

package/packages/tari_universe/src/signer.ts

@@ -11,14 +11,14 @@ import {
   ListAccountNftFromBalancesRequest,
 } from "@tari-project/tarijs-types";
 import { SignerRequest, SignerMethodNames, SignerReturnType, TariUniverseSignerParameters, WindowSize } from "./types";
+import { sendSignerCall } from "./utils";
+import { TariSigner } from "@tari-project/tari-signer";
 import {
   AccountsGetBalancesResponse,
   ConfidentialViewVaultBalanceRequest,
   ListAccountNftRequest,
   ListAccountNftResponse,
-} from "@tari-project/wallet_jrpc_client";
-import { sendSignerCall } from "./utils";
-import { TariSigner } from "@tari-project/tari-signer";
+} from "@tari-project/typescript-bindings";
 
 export class TariUniverseSigner implements TariSigner {
   public signerName = "TariUniverse";

package/packages/tarijs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tarijs-all",
-  "version": "0.5.4",
+  "version": "0.6.0",
   "description": "",
   "type": "module",
   "publishConfig": {

package/packages/tarijs/test/integration-tests/wallet_daemon/json_rpc_provider.spec.ts

@@ -1,6 +1,18 @@
 import { assert, describe, expect, it } from "vitest";
 
-import { Network, SubmitTransactionRequest, TariPermissions, WalletDaemonTariSigner } from "../../../src";
+import {
+  Amount,
+  buildTransactionRequest,
+  fromWorkspace,
+  Network,
+  submitAndWaitForTransaction,
+  SubmitTransactionRequest,
+  TariPermissions,
+  TransactionBuilder,
+  TransactionStatus,
+  waitForTransactionResult,
+  WalletDaemonTariSigner,
+} from "../../../src";
 
 function buildSigner(): Promise<WalletDaemonTariSigner> {
   const permissions = new TariPermissions().addPermission("Admin");
@@ -113,6 +125,81 @@ describe("WalletDaemonTariSigner", () => {
         transaction_id: expect.any(String),
       });
     });
+
+    it("submits a dry run transaction", async () => {
+      const signer = await buildSigner();
+      const account = await signer.getAccount();
+
+      const request: SubmitTransactionRequest = {
+        network: Network.LocalNet,
+        account_id: account.account_id,
+        fee_instructions: [],
+        instructions: [
+          {
+            EmitLog: {
+              level: "Info",
+              message: "From Integration Test",
+            },
+          },
+        ],
+        inputs: [],
+        input_refs: [],
+        required_substates: [],
+        is_dry_run: true,
+        min_epoch: null,
+        max_epoch: null,
+        is_seal_signer_authorized: true,
+        detect_inputs_use_unversioned: true,
+      };
+      const result = await signer.submitTransaction(request);
+      const txResult = await waitForTransactionResult(signer, result.transaction_id);
+
+      expect(txResult.status).toEqual(TransactionStatus.DryRun);
+    });
+
+    it("submits a transaction, that uses workspaces", async () => {
+      const workspaceId = "bucket";
+      const signer = await buildSigner();
+      const account = await signer.getAccount();
+      const xtrAddress = account.resources[0].resource_address;
+
+      const fee = new Amount(2000);
+      const builder = new TransactionBuilder();
+      builder.feeTransactionPayFromComponent(account.address, fee.getStringValue());
+
+      builder.callMethod(
+        {
+          componentAddress: account.address,
+          methodName: "withdraw",
+        },
+        [xtrAddress, 10],
+      );
+      builder.saveVar(workspaceId);
+      builder.callMethod(
+        {
+          componentAddress: account.address,
+          methodName: "deposit",
+        },
+        [fromWorkspace(workspaceId)],
+      );
+      const transaction = builder.build();
+
+      const isDryRun = false;
+      const inputRefs = undefined;
+      const network = Network.LocalNet;
+      const requiredSubstates = [{ substate_id: account.address }];
+      const submitTransactionRequest = buildTransactionRequest(
+        transaction,
+        account.account_id,
+        requiredSubstates,
+        inputRefs,
+        isDryRun,
+        network,
+      );
+
+      const txResult = await submitAndWaitForTransaction(signer, submitTransactionRequest);
+      expect(txResult.result.status).toBe(TransactionStatus.Accepted);
+    });
   });
 
   describe("getAccountBalances", () => {
@@ -215,4 +302,40 @@ describe("WalletDaemonTariSigner", () => {
       expect(substates.every((substate) => substate.module_name)).toBe(true);
     });
   });
+
+  describe("allocateAddress", () => {
+    it("allocates component address", async () => {
+      const signer = await buildSigner();
+      const account = await signer.getAccount();
+
+      const fee = new Amount(2000);
+      const builder = new TransactionBuilder();
+      builder.feeTransactionPayFromComponent(account.address, fee.getStringValue());
+      builder.allocateAddress("Component", "id-1");
+      const transaction = builder.build();
+
+      const isDryRun = false;
+      const inputRefs = undefined;
+      const network = Network.LocalNet;
+      const requiredSubstates = [{ substate_id: account.address }];
+      const submitTransactionRequest = buildTransactionRequest(
+        transaction,
+        account.account_id,
+        requiredSubstates,
+        inputRefs,
+        isDryRun,
+        network,
+      );
+
+      const txResult = await submitAndWaitForTransaction(signer, submitTransactionRequest);
+
+      expect(txResult.result.status).toBe(TransactionStatus.OnlyFeeAccepted);
+
+      const executionResult = txResult.result.result?.result;
+      const reason =
+        executionResult && "AcceptFeeRejectRest" in executionResult && executionResult.AcceptFeeRejectRest[1];
+      const failure = reason && typeof reason === "object" && "ExecutionFailure" in reason && reason.ExecutionFailure;
+      expect(failure).toEqual("1 dangling address allocations remain after transaction execution");
+    });
+  });
 });

package/packages/tarijs_types/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tarijs-types",
-  "version": "0.5.4",
+  "version": "0.6.0",
   "description": "",
   "type": "module",
   "publishConfig": {

package/packages/tarijs_types/src/Instruction.ts

@@ -1,4 +1,4 @@
-import { ComponentAddress, LogLevel, PublishedTemplateAddress } from "@tari-project/typescript-bindings";
+import { ComponentAddress, LogLevel, PublishedTemplateAddress, SubstateType } from "@tari-project/typescript-bindings";
 import { TransactionArg } from "./TransactionArg";
 import { ConfidentialClaim } from "./ConfidentialClaim";
 import { Amount } from "./Amount";
@@ -13,7 +13,8 @@ export type Instruction =
   | ClaimBurn
   | ClaimValidatorFees
   | DropAllProofsInWorkspace
-  | CreateFreeTestCoins;
+  | CreateFreeTestCoins
+  | AllocateAddress;
 
 export type CreateAccount = { CreateAccount: { owner_public_key: string; workspace_bucket: string | null } };
 export type CallFunction = {
@@ -22,7 +23,7 @@ export type CallFunction = {
 export type CallMethod = {
   CallMethod: { component_address: ComponentAddress; method: string; args: Array<TransactionArg> };
 };
-export type PutLastInstructionOutputOnWorkspace = { PutLastInstructionOutputOnWorkspace: { key: number[] } };
+export type PutLastInstructionOutputOnWorkspace = { PutLastInstructionOutputOnWorkspace: { key: string } };
 export type EmitLog = { EmitLog: { level: LogLevel; message: string } };
 export type ClaimBurn = { ClaimBurn: { claim: ConfidentialClaim } };
 export type ClaimValidatorFees = { ClaimValidatorFees: { epoch: number; validator_public_key: string } };
@@ -30,3 +31,6 @@ export type DropAllProofsInWorkspace = "DropAllProofsInWorkspace";
 export type CreateFreeTestCoins = {
   CreateFreeTestCoins: { revealed_amount: Amount; output: ConfidentialOutput | null };
 };
+export type AllocateAddress = {
+  AllocateAddress: { substate_type: SubstateType; workspace_id: string };
+};

package/packages/tarijs_types/src/SubstateType.ts

@@ -0,0 +1 @@
+export type SubstateType = "Component" | "Resource" | "Vault" | "UnclaimedConfidentialOutput" | "NonFungible" | "TransactionReceipt" | "NonFungibleIndex" | "ValidatorFeePool" | "Template";

package/packages/tarijs_types/src/Workspace.ts

@@ -1,3 +1,3 @@
 export interface WorkspaceArg {
-  Workspace: number[];
+  Workspace: string;
 }

package/packages/tarijs_types/src/index.ts

@@ -16,6 +16,7 @@ export { Instruction } from "./Instruction";
 export { Transaction } from "./Transaction";
 export { SubstateDiff, DownSubstates, UpSubstates } from "./SubstateDiff";
 export { SubstateRequirement } from "./SubstateRequirement";
+export { SubstateType } from "./SubstateType";
 export {
   TransactionResult,
   SubmitTxResult,

package/packages/wallet_daemon/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/wallet-daemon-signer",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "description": "",
   "type": "module",
   "publishConfig": {
@@ -16,6 +16,7 @@
     "@tari-project/tari-permissions": "workspace:^",
     "@tari-project/tari-signer": "workspace:^",
     "@tari-project/tarijs-types": "workspace:^",
+    "@tari-project/typescript-bindings": "catalog:",
     "@tari-project/wallet_jrpc_client": "catalog:"
   },
   "devDependencies": {

package/packages/wallet_daemon/src/signer.ts

@@ -1,17 +1,7 @@
 import { TariPermissions } from "@tari-project/tari-permissions";
 import { TariConnection } from "./webrtc";
 import { TariSigner } from "@tari-project/tari-signer";
-import {
-  WalletDaemonClient,
-  substateIdToString,
-  Instruction,
-  SubstatesListRequest,
-  KeyBranch,
-  SubstateId,
-  ListAccountNftRequest,
-  ListAccountNftResponse,
-  ConfidentialViewVaultBalanceRequest,
-} from "@tari-project/wallet_jrpc_client";
+import { WalletDaemonClient } from "@tari-project/wallet_jrpc_client";
 import { WebRtcRpcTransport } from "./webrtc_transport";
 import {
   AccountData,
@@ -25,6 +15,16 @@ import {
   ListSubstatesResponse,
   ListSubstatesRequest,
 } from "@tari-project/tarijs-types";
+import {
+  ConfidentialViewVaultBalanceRequest,
+  Instruction,
+  KeyBranch,
+  ListAccountNftRequest,
+  ListAccountNftResponse,
+  SubstateId,
+  substateIdToString,
+  SubstatesListRequest,
+} from "@tari-project/typescript-bindings";
 
 export const WalletDaemonNotConnected = "WALLET_DAEMON_NOT_CONNECTED";
 export const Unsupported = "UNSUPPORTED";
@@ -194,7 +194,9 @@ export class WalletDaemonTariSigner implements TariSigner {
       detect_inputs_use_unversioned: req.detect_inputs_use_unversioned,
     };
 
-    const res = await this.client.submitTransaction(params);
+    const res = req.is_dry_run
+      ? await this.client.submitTransactionDryRun(params)
+      : await this.client.submitTransaction(params);
     return { transaction_id: res.transaction_id };
   }
 

package/packages/walletconnect/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/wallet-connect-signer",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "description": "",
   "type": "module",
   "publishConfig": {

package/packages/walletconnect/src/index.ts

@@ -1,15 +1,6 @@
 import { TariSigner } from "@tari-project/tari-signer";
 import UniversalProvider from "@walletconnect/universal-provider";
 import { WalletConnectModal } from "@walletconnect/modal";
-import {
-  ConfidentialViewVaultBalanceRequest,
-  Instruction,
-  KeyBranch,
-  ListAccountNftRequest,
-  ListAccountNftResponse,
-  substateIdToString,
-  TransactionSubmitRequest,
-} from "@tari-project/wallet_jrpc_client";
 import {
   convertStringToTransactionStatus,
   GetTransactionResultResponse,
@@ -22,6 +13,15 @@ import {
   ListSubstatesResponse,
   ListSubstatesRequest,
 } from "@tari-project/tarijs-types";
+import {
+  ConfidentialViewVaultBalanceRequest,
+  Instruction,
+  KeyBranch,
+  ListAccountNftRequest,
+  ListAccountNftResponse,
+  substateIdToString,
+  TransactionSubmitRequest,
+} from "@tari-project/typescript-bindings";
 
 const walletConnectParams = {
   requiredNamespaces: {
@@ -193,7 +193,7 @@ export class WalletConnectTariSigner implements TariSigner {
   }
 
   async submitTransaction(req: SubmitTransactionRequest): Promise<SubmitTransactionResponse> {
-    const method = "tari_submitTransaction";
+    const method = req.is_dry_run ? "tari_submitTransactionDryRun" : "tari_submitTransaction";
     const params: TransactionSubmitRequest = {
       transaction: {
         V1: {

package/pnpm-workspace.yaml

@@ -8,8 +8,8 @@ catalog:
   vitest: ^3.0.4
   vite: ^6.1.0
   "@types/node": ^22.13.1
-  "@tari-project/typescript-bindings": ^1.5.2
-  "@tari-project/wallet_jrpc_client": ^1.5.2
+  "@tari-project/typescript-bindings": ^1.5.5
+  "@tari-project/wallet_jrpc_client": ^1.5.4
   "@metamask/providers": ^18.2.0
   "@walletconnect/universal-provider": ^2.13.3
   "@walletconnect/modal": ^2.6.2

package/scripts/check_versions.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+echo "Finding all package.json files and extracting versions..."
+
+declare -a versions
+
+# Find all package.json files, excluding node_modules, and extract the version
+while IFS= read -r file; do
+    version=$(jq -r '.version' "$file")
+    if [[ -z "$version" || "$version" == "null" ]]; then
+        echo "::error::Could not find 'version' field in $file"
+        exit 1
+    fi
+    echo "Found version '$version' in $file"
+    versions+=("$version")
+done < <(find . -name 'package.json' -not -path '*/node_modules/*')
+
+if [ ${#versions[@]} -eq 0 ]; then
+    echo "Error: No package.json files with a 'version' field were found."
+    exit 1
+fi
+
+reference_version=${versions[0]}
+echo "Reference version: $reference_version"
+
+all_same=true
+for version in "${versions[@]}"; do
+    if [ "$version" != "$reference_version" ]; then
+        echo "Error: Mismatched version found! '$version' does not match '$reference_version'."
+        all_same=false
+        break
+    fi
+done
+
+if [ "$all_same" = false ]; then
+    echo "::error::All package.json versions are NOT the same. Please unify them."
+    exit 1
+else
+    echo "All package.json versions are consistent: $reference_version"
+fi