@tari-project/tarijs 0.4.0 → 0.4.1

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,36 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[TITLE]"
+labels: 'bug-report'
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS & Version: [e.g. iOS 10.2.1]
+ - Browser & Version [e.g. chrome v71.0.12345]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser & Version [e.g. stock browser v0.1.2]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,27 @@
+Description
+---
+
+Motivation and Context
+---
+
+How Has This Been Tested?
+---
+
+What process can a PR reviewer use to test or verify this change?
+---
+
+<!-- Checklist -->
+<!-- 1. Is the title of your PR in the form that would make nice release notes? The title, excluding the conventional commit
+tag, will be included exactly as is in the CHANGELOG, so please think about it carefully. -->
+
+
+Breaking Changes
+---
+
+- [x] None
+- [ ] Requires data directory on base node to be deleted
+- [ ] Requires hard fork
+- [ ] Other - Please specify
+
+<!-- Does this include a breaking change? If so, include this line as a footer -->
+<!-- BREAKING CHANGE: Description what the user should do, e.g. delete a database, resync the chain -->

package/.github/dependabot.yml

@@ -0,0 +1,8 @@
+---
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

package/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+---
+name: CI
+
+'on':
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+concurrency:
+  # https://docs.github.com/en/actions/examples/using-concurrency-expressions-and-a-test-matrix
+  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+  cancel-in-progress: ${{ !startsWith(github.ref, 'refs/tags/v') || github.ref != 'refs/heads/main' }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: 'moonrepo/setup-toolchain@v0'
+        with:
+          auto-install: true
+      - run: pnpm install
+      - run: moon :build

package/.github/workflows/npm_publish.yml

@@ -0,0 +1,26 @@
+---
+# Publishing the package to the npm registry when the version number changes
+# See https://github.com/marketplace/actions/npm-publish for more information
+name: Publish Package to npmjs
+
+on:
+  push:
+    branches: main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: 'moonrepo/setup-toolchain@v0'
+        with:
+          auto-install: true
+      - run: pnpm install --frozen-lockfile
+      - run: moon :build
+      - name: Publish
+        run: |
+          pnpm config set git-checks false
+          pnpm config set //registry.npmjs.org/:_authToken ${{ secrets.NPM_TOKEN }}
+          pnpm publish --access public --no-git-checks -r
+        env:
+          NPM_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/pr_signed_commits_check.yml

@@ -0,0 +1,19 @@
+---
+# Checks if the comments are signed or not
+name: PR - Signed commits check
+
+'on':
+  pull_request_target
+
+permissions: {}
+
+jobs:
+  check-signed-commits:
+    name: Check signed commits in PR
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - name: Check signed commits in PR
+        uses: 1Password/check-signed-commits-action@v1

package/.github/workflows/pr_title.yml

@@ -0,0 +1,30 @@
+---
+# Checks that PR titles conform to Conventional Commits
+# See https://www.conventionalcommits.org/en/v1.0.0/ for more information
+name: PR
+
+'on':
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check-title:
+    runs-on: ubuntu-latest
+    steps:
+      - name: install
+        run: |
+          npm install -g @commitlint/cli @commitlint/config-conventional
+          echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
+      - name: lint
+        run: |
+          echo "$PR_TITLE" | commitlint
+        env:
+          PR_TITLE: ${{github.event.pull_request.title}}

package/.moon/toolchain.yml

@@ -0,0 +1,6 @@
+# Enable Node.js and override default settings
+language: 'typescript'
+node:
+  packageManager: 'pnpm'
+typescript:
+   syncProjectReferences: true

package/.moon/workspace.yml

@@ -0,0 +1,32 @@
+# https://moonrepo.dev/docs/config/workspace
+$schema: 'https://moonrepo.dev/schemas/workspace.json'
+
+# Require a specific version of moon while running commands, otherwise fail.
+# versionConstraint: '>=1.0.0'
+
+# Extend and inherit an external configuration file. Must be a valid HTTPS URL or file system path.
+# extends: './shared/workspace.yml'
+
+# REQUIRED: A map of all projects found within the workspace, or a list or file system globs.
+# When using a map, each entry requires a unique project ID as the map key, and a file system
+# path to the project folder as the map value. File paths are relative from the workspace root,
+# and cannot reference projects located outside the workspace boundary.
+projects:
+  - 'apps/*'
+  - 'packages/*'
+
+
+
+# Configures the version control system to utilize within the workspace. A VCS
+# is required for determining touched (added, modified, etc) files, calculating file hashes,
+# computing affected files, and much more.
+vcs:
+  # The client to use when managing the repository.
+  # Accepts "git". Defaults to "git".
+  manager: 'git'
+
+  # The default branch (master/main/trunk) in the repository for comparing the
+  # local branch against. For git, this is is typically "master" or "main",
+  # and must include the remote prefix (before /).
+  defaultBranch: 'main'
+

package/.prettierrc

@@ -0,0 +1,12 @@
+{
+  "printWidth": 120,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": false,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "arrowParens": "always",
+  "endOfLine": "auto"
+}

package/.prototools

@@ -0,0 +1,9 @@
+moon = "1.31.0"
+node = "22.13.1"
+pnpm = "9.15.3"
+
+[plugins]
+moon = "https://raw.githubusercontent.com/moonrepo/moon/master/proto-plugin.toml"
+
+[settings]
+auto-install = true

package/CODEOWNERS

@@ -0,0 +1,3 @@
+# CI/CD-related files require a review by the devops team
+.github/**/* @tari-project/devops
+CODEOWNERS @tari-project/devops

package/README.md

@@ -0,0 +1,47 @@
+# tari.js
+
+This project provides a unified TypeScript library to connect and send requests to a Tari wallet. It's intended for web application developers that want to interact with a Tari wallet (connect, get substates, submit transactions, etc.).
+
+Tari wallets supported:
+* Tari Wallet Daemon
+* MetaMask through the [tari-snap](https://github.com/tari-project/tari-snap)
+
+An example site (under the `example` folder) contains a web project that allows the user to connect to any type of Tari wallet and perform common actions.
+
+Please read the [TODO](TODO.md) file for upcoming features.
+
+## Library building
+
+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:
+First you must install [proto](https://moonrepo.dev/proto) to manage node and pnpm versions 
+```shell
+proto use
+pnpm install
+moon tarijs:build
+```
+
+The bundled files for deployment or publication will be located under the `dist` folder.
+
+## Running the example site
+
+To run the example site you will need to:
+* Compile the library following the previous section.
+* Have access to a Tari Wallet Daemon and to the Tari MetaMask Snap.
+* Copy the `example/.env.example` file to `example/.env` and edit the correct environment variable values.
+
+To run in development mode, in the packages/tarijs folder:
+```shell
+cd example
+moon tarijs:build
+pnpm run dev
+```
+
+For building and distribution,  in the packages/tarijs folder
+```shell
+cd example
+moon tarijs:build
+```
+The distribution files will be under the `example/dist` folder. 
+

package/TODO.md

@@ -0,0 +1,12 @@
+# 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/package.json

@@ -1,39 +1,15 @@
 {
   "name": "@tari-project/tarijs",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "",
   "type": "module",
-  "publishConfig": {
-    "access": "public"
-  },
   "keywords": [],
   "author": "",
   "license": "ISC",
-  "dependencies": {
-    "@metamask/providers": "^18.2.0",
-    "@tari-project/typescript-bindings": "^1.4.0",
-    "@tari-project/metamask-provider": "^0.4.0",
-    "@tari-project/tari-permissions": "^0.4.0",
-    "@tari-project/tari-provider": "^0.4.0",
-    "@tari-project/tari-universe-provider": "^0.4.0",
-    "@tari-project/tarijs-types": "^0.4.0",
-    "@tari-project/tarijs-builders": "^0.4.0",
-    "@tari-project/wallet-connect-provider": "^0.4.0",
-    "@tari-project/wallet-daemon-provider": "^0.4.0"
+  "engines": {
+    "node": "22.13.1"
   },
   "devDependencies": {
-    "@types/node": "^22.13.1",
-    "typescript": "^5.0.4",
-    "vite": "^6.1.0",
-    "vitest": "^3.0.4"
-  },
-  "files": [
-    "/dist"
-  ],
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "tsc -b",
-    "integration-tests": "vitest run integration-tests"
+    "@moonrepo/cli": "^1.32.1"
   }
 }

package/packages/builders/moon.yml

@@ -0,0 +1,55 @@
+language: "typescript"
+platform: "node"
+type: "library"
+
+fileGroups:
+  configs:
+    - "tsconfig.json"
+    - "package.json"
+    - "eslint.config.ts"
+  sources:
+    - "src/**/*"
+  tests:
+    - "integration-tests/**/*"
+
+tasks:
+  build:
+    command: "pnpm run build"
+    inputs:
+      - "@files(sources)"
+      - "@files(configs)"
+    outputs:
+      - "dist"
+  format:
+    command: "pnpm run format"
+    inputs:
+      - "@files(sources)"
+      - "@files(configs)"
+      - "@files(tests)"
+    options:
+      runInCI: false
+  lint:
+    command: "pnpm run lint:fix"
+    inputs:
+      - "@files(sources)"
+      - "@files(configs)"
+      - "@files(tests)"
+    options:
+      runInCI: false
+    deps:
+      - "build"
+
+  lintCheck:
+    command: "pnpm run lint"
+    inputs:
+      - "@files(sources)"
+      - "@files(configs)"
+      - "@files(tests)"
+    deps:
+      - "build"
+  formatCheck:
+    command: "pnpm run format:check"
+    inputs:
+      - "@files(sources)"
+      - "@files(configs)"
+      - "@files(tests)"

package/packages/builders/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@tari-project/tarijs-builders",
+  "version": "0.4.0",
+  "description": "",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -b"
+  },
+  "keywords": [],
+  "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:"
+  },
+  "devDependencies": {
+    "@types/node": "catalog:",
+    "typescript": "catalog:"
+  },
+  "files": [
+    "/dist"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts"
+}

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

@@ -0,0 +1,2 @@
+export { buildTransactionRequest, submitAndWaitForTransaction, waitForTransactionResult } from "./submitTransaction";
+export { fromWorkspace, toWorkspace } from "./workspace";

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

@@ -0,0 +1,97 @@
+import { TariUniverseProvider } from "@tari-project/tari-universe-provider";
+import { TariProvider, SubmitTransactionRequest, SubstateRequirement } from "@tari-project/tari-provider";
+import {
+  Transaction,
+  TransactionResult,
+  TransactionStatus,
+  DownSubstates,
+  UpSubstates,
+  FinalizeResultStatus,
+  TxResultAccept,
+  SubmitTxResult
+} from "@tari-project/tarijs-types";
+
+export function buildTransactionRequest(
+  transaction: Transaction,
+  accountId: number,
+  requiredSubstates: SubstateRequirement[],
+  inputRefs = [],
+  isDryRun = false,
+  network = 0,
+  isSealSignerAuthorized = true,
+  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[],
+    fee_instructions: transaction.feeInstructions as object[],
+    inputs: transaction.inputs,
+    input_refs: inputRefs as object[],
+    required_substates: requiredSubstates,
+    is_dry_run: isDryRun,
+    min_epoch: transaction.minEpoch ?? null,
+    max_epoch: transaction.maxEpoch ?? null,
+    is_seal_signer_authorized: isSealSignerAuthorized,
+    detect_inputs_use_unversioned: detectInputsUseUnversioned,
+  };
+}
+
+export async function submitAndWaitForTransaction(
+  provider: TariProvider,
+  req: SubmitTransactionRequest,
+): Promise<SubmitTxResult> {
+  try {
+    const response = await provider.submitTransaction(req);
+    const result = await waitForTransactionResult(provider, response.transaction_id);
+
+    return {
+      response,
+      result,
+    };
+  } catch (e) {
+    throw new Error(`Transaction failed: ${e}`);
+  }
+}
+
+export async function waitForTransactionResult(
+  provider: TariProvider | TariUniverseProvider,
+  transactionId: string,
+): Promise<TransactionResult> {
+  // eslint-disable-next-line no-constant-condition
+  while (true) {
+    const resp = await provider.getTransactionResult(transactionId);
+    const FINALIZED_STATUSES = [
+      TransactionStatus.Accepted,
+      TransactionStatus.Rejected,
+      TransactionStatus.InvalidTransaction,
+      TransactionStatus.OnlyFeeAccepted,
+      TransactionStatus.DryRun,
+    ];
+
+    if (resp.status == TransactionStatus.Rejected) {
+      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)
+    }
+    await new Promise((resolve) => setTimeout(resolve, 1000));
+  }
+}
+
+export function getAcceptResultSubstates(
+  txResult: TransactionResult,
+): { upSubstates: UpSubstates; downSubstates: DownSubstates } | undefined {
+  const result = txResult.result?.result;
+
+  if (result && isAccept(result)) {
+    return { upSubstates: result.Accept.up_substates, downSubstates: result.Accept.down_substates };
+  }
+  return undefined;
+}
+
+function isAccept(result: FinalizeResultStatus): result is TxResultAccept {
+  return "Accept" in result;
+}

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

@@ -0,0 +1,32 @@
+import { WorkspaceArg } from "@tari-project/tarijs-types";
+
+/**
+ *
+ * @param key workspace name
+ * @returns encoded Uint8Array 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 ]
+ */
+export function toWorkspace(key: string): number[] {
+  const encoder = new TextEncoder();
+  return Array.from(encoder.encode(key));
+}
+
+/**
+ *
+ * @param key workspace name
+ * @returns formatted Workspace data
+ * @example
+ * key: "bucket" -> { Workspace: [ 98, 117, 99, 107, 101, 116 ] }
+ */
+export function fromWorkspace(key: string): WorkspaceArg {
+  const encoder = new TextEncoder();
+  const encodedKey = encoder.encode(key);
+  return { Workspace: Array.from(encodedKey) };
+}

package/packages/builders/src/index.ts

@@ -0,0 +1,9 @@
+export * from "@tari-project/tarijs-types";
+export { TransactionBuilder, TransactionRequest, TariMethodDefinition, TariFunctionDefinition } from "./transaction";
+export {
+  buildTransactionRequest,
+  submitAndWaitForTransaction,
+  waitForTransactionResult,
+  fromWorkspace,
+  toWorkspace,
+} from "./helpers";