@tari-project/tarijs 0.4.1 → 0.4.2

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

@@ -0,0 +1,20 @@
+---
+sidebar_position: 2
+---
+
+# Internals of a Transaction Request
+
+A Transaction Request has the following parts:
+
+- `network`: The ID of the network (e.g., LocalNet, NextNet, Igor) on which this request is expected to be executed.
+- `accountId`: The ID of the account in which the transaction will be executed.
+- `feeInstructions`: Instructions describing where to obtain funds to cover transaction costs.
+- `instructions`: The core of the Transaction Request—the instructions to be executed.
+- `inputs`: Substates involved in the transaction. Supplying these helps assign transactions to the correct shards in consensus.
+- `minEpoch` and `maxEpoch`: Required epoch bounds for execution. These are optional.
+- `is_dry_run`: If `true`, the transaction will be validated but not submitted.
+- `is_seal_signer_authorized`: If `true`, the wallet's public key will be used; otherwise, the first signature of the transaction is used as the "default" owner.
+- `detect_inputs_use_unversioned`: If `true`, dependent substates will skip the version check.
+
+Most of these parts are covered by the *Transaction Builder*; the rest are filled by `buildTransactionRequest`.
+ 

package/docusaurus/tari-docs/docs/wallet/template-definition.md

@@ -0,0 +1,101 @@
+---
+sidebar_position: 2
+---
+
+# Template definition
+
+A Tari contract template provides a standardized structure and pre-written code for creating smart contracts on the Tari blockchain. It simplifies development by offering a foundation with common functionalities and best practices, allowing developers to focus on the specific logic of their contract.
+
+
+Let's take a look at the template definition of the `XtrFaucet` template.  
+The template address varies by installation. You can easily examine them using the `Tari Validation Node` UI.
+
+```js
+const templateAddress = "0102030000000000000000000000000000000000000000000000000000000000";
+const template = await provider.getTemplateDefinition(templateAddress);
+```
+
+The result should look similar to:
+
+```json
+{
+  "V1": {
+    "functions": [
+      {
+        "arguments": [
+          {
+            "arg_type": {
+              "Other": {
+                "name": "&self"
+              }
+            },
+            "name": "self"
+          },
+          {
+            "arg_type": {
+              "Other": {
+                "name": "Amount"
+              }
+            },
+            "name": "amount"
+          }
+        ],
+        "is_mut": false,
+        "name": "take",
+        "output": {
+          "Other": {
+            "name": "Bucket"
+          }
+        }
+      },
+      {
+        "arguments": [
+          {
+            "arg_type": {
+              "Other": {
+                "name": "&self"
+              }
+            },
+            "name": "self"
+          },
+          {
+            "arg_type": {
+              "Other": {
+                "name": "Amount"
+              }
+            },
+            "name": "amount"
+          },
+          {
+            "arg_type": {
+              "Other": {
+                "name": "ConfidentialOutputStatement"
+              }
+            },
+            "name": "output"
+          },
+          {
+            "arg_type": {
+              "Other": {
+                "name": "BalanceProofSignature"
+              }
+            },
+            "name": "balance_proof"
+          }
+        ],
+        "is_mut": false,
+        "name": "take_confidential",
+        "output": {
+          "Other": {
+            "name": "Bucket"
+          }
+        }
+      }
+    ],
+    "tari_version": "0.8.0",
+    "template_name": "XtrFaucet"
+  }
+}
+```
+
+This template has two methods - `take` and `take_confidential`. First one takes `amount` only, second requires additional confidential output statement along with balance proof signature. Both methods return  a bucket.

package/docusaurus/tari-docs/docusaurus.config.ts

@@ -0,0 +1,108 @@
+import {themes as prismThemes} from 'prism-react-renderer';
+import type {Config} from '@docusaurus/types';
+import type * as Preset from '@docusaurus/preset-classic';
+
+const config: Config = {
+  title: "tari.js",
+  tagline: "Your gateway to Tari L2",
+  favicon: "img/favicon.png",
+  
+  organizationName: "tari-project",
+  projectName: "tari.js",
+  deploymentBranch: "documentation",
+  trailingSlash: false,
+
+  url: "https://tari-project.github.io/",
+  baseUrl: "/tari.js",
+
+  onBrokenLinks: "throw",
+  onBrokenMarkdownLinks: "warn",
+
+  i18n: {
+    defaultLocale: "en",
+    locales: ["en"],
+  },
+
+  presets: [
+    [
+      "classic",
+      {
+        docs: {
+          sidebarPath: "./sidebars.ts",
+          remarkPlugins: [[require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }]],
+        },
+        blog: false,
+        theme: {
+          customCss: "./src/css/custom.css",
+        },
+      } satisfies Preset.Options,
+    ],
+  ],
+
+  themeConfig: {
+    image: "img/meta-image.png",
+    navbar: {
+      title: "tari.js",
+      logo: {
+        alt: "Tari Logo",
+        src: "img/tari-logo.svg",
+      },
+      items: [
+        {
+          type: "docSidebar",
+          sidebarId: "docsSidebar",
+          position: "left",
+          label: "Documentation",
+        },
+        {
+          href: "https://github.com/tari-project/tari.js",
+          label: "GitHub",
+          position: "right",
+        },
+      ],
+    },
+    footer: {
+      style: "dark",
+      links: [
+        {
+          title: "tari.js",
+          items: [
+            {
+              label: "Documentation",
+              to: "/docs/",
+            },
+            {
+              label: "Github",
+              to: "https://github.com/tari-project/tari.js",
+            },
+          ],
+        },
+        {
+          title: "Community",
+          items: [
+            {
+              label: "Discord",
+              href: "https://discord.com/invite/tari",
+            },
+            {
+              label: "Telegram",
+              href: "https://t.me/tariproject",
+            },
+            {
+              label: "X",
+              href: "https://x.com/tari",
+            }
+          ],
+        },
+      ],
+      copyright: `Copyright © ${new Date().getFullYear()} Tari Labs.`,
+    },
+    prism: {
+      theme: prismThemes.github,
+      darkTheme: prismThemes.dracula,
+      additionalLanguages: ["typescript", "javascript"],
+    },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;

package/docusaurus/tari-docs/moon.yml

@@ -0,0 +1,41 @@
+language: "typescript"
+platform: 'node'
+type: 'application'
+
+fileGroups:
+  configs:
+    - "docusaurus.config.ts"
+    - "package.json"
+    - "tsconfig.json"
+  sources:
+    - "sidebars.ts"
+    - "src/**/*"
+  docs:
+    - "docs/**/*"
+    - "static/**/*"
+
+tasks:
+  build:
+    script: "pnpm run build"
+    inputs:
+      - "@files(configs)"
+      - "@files(sources)"
+      - "@files(docs)"
+    outputs:
+      - "build"
+
+  start:
+    script: "pnpm run start"
+    inputs:
+      - "@files(configs)"
+      - "@files(sources)"
+      - "@files(docs)"
+
+  serve:
+    script: "pnpm run start"
+    inputs:
+      - "@files(configs)"
+      - "@files(sources)"
+      - "@files(docs)"
+    deps:
+      - 'build'

package/docusaurus/tari-docs/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "tari-docs",
+  "version": "0.0.1",
+  "private": true,
+  "scripts": {
+    "docusaurus": "docusaurus",
+    "start": "docusaurus start",
+    "build": "docusaurus build",
+    "swizzle": "docusaurus swizzle",
+    "deploy": "docusaurus deploy",
+    "clear": "docusaurus clear",
+    "serve": "docusaurus serve",
+    "write-translations": "docusaurus write-translations",
+    "write-heading-ids": "docusaurus write-heading-ids",
+    "typecheck": "tsc"
+  },
+  "dependencies": {
+    "@docusaurus/core": "3.7.0",
+    "@docusaurus/preset-classic": "3.7.0",
+    "@docusaurus/remark-plugin-npm2yarn": "^3.7.0",
+    "@mdx-js/react": "^3.0.0",
+    "clsx": "^2.0.0",
+    "prism-react-renderer": "^2.3.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-feather": "^2.0.10"
+  },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "3.7.0",
+    "@docusaurus/tsconfig": "3.7.0",
+    "@docusaurus/types": "3.7.0",
+    "typescript": "~5.6.2"
+  },
+  "browserslist": {
+    "production": [
+      ">0.5%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 3 chrome version",
+      "last 3 firefox version",
+      "last 5 safari version"
+    ]
+  },
+  "engines": {
+    "node": ">=18.0"
+  }
+}

package/docusaurus/tari-docs/sidebars.ts

@@ -0,0 +1,7 @@
+import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
+
+const sidebars: SidebarsConfig = {
+  docsSidebar: [{type: 'autogenerated', dirName: '.'}],
+};
+
+export default sidebars;

package/docusaurus/tari-docs/src/components/HomepageFeatures/index.tsx

@@ -0,0 +1,69 @@
+import type {ReactNode} from 'react';
+import clsx from 'clsx';
+import Heading from '@theme/Heading';
+import { Zap, Cpu, Code } from 'react-feather';
+import styles from './styles.module.css';
+
+type FeatureItem = {
+  title: string;
+  Svg: React.ComponentType<React.ComponentProps<'svg'>>;
+  description: ReactNode;
+};
+
+const FeatureList: FeatureItem[] = [
+  {
+    title: 'Simple Integration with Tari L2',
+    Svg: Zap,
+    description: (
+      <>
+        Easily integrate with Tari's Layer 2 wallet and blockchain functionality using our simple and intuitive JavaScript/TypeScript libraries.
+      </>
+    ),
+  },
+  {
+    title: 'Build Secure and Scalable dApps',
+    Svg: Cpu,
+    description: (
+      <>
+        Use Tari's advanced protocol to create decentralized applications with enhanced security and scalability for real-world use cases.
+      </>
+    ),
+  },
+  {
+    title: 'Developer-Friendly Smart Contracts',
+    Svg: Code,
+    description: (
+      <>
+        Quickly deploy and manage Tari-based smart contracts with pre-built templates, a seamless transaction builder, and a robust API.
+      </>
+    ),
+  },
+];
+
+function Feature({ title, Svg, description }: FeatureItem) {
+  return (
+    <div className={clsx('col col--4')}>
+      <div className="text--center">
+        <Svg className={styles.featureSvg} role="img" />
+      </div>
+      <div className="text--center padding-horiz--md">
+        <Heading as="h3">{title}</Heading>
+        <p>{description}</p>
+      </div>
+    </div>
+  );
+}
+
+export default function HomepageFeatures(): ReactNode {
+  return (
+    <section className={styles.features}>
+      <div className="container">
+        <div className="row">
+          {FeatureList.map((props, idx) => (
+            <Feature key={idx} {...props} />
+          ))}
+        </div>
+      </div>
+    </section>
+  );
+}

package/docusaurus/tari-docs/src/components/HomepageFeatures/styles.module.css

@@ -0,0 +1,11 @@
+.features {
+  display: flex;
+  align-items: center;
+  padding: 2rem 0;
+  width: 100%;
+}
+
+.featureSvg {
+  height: 200px;
+  width: 200px;
+}

package/docusaurus/tari-docs/src/css/custom.css

@@ -0,0 +1,30 @@
+/**
+ * Any CSS included here will be global. The classic template
+ * bundles Infima by default. Infima is a CSS framework designed to
+ * work well for content-centric websites.
+ */
+
+/* You can override the default Infima variables here. */
+:root {
+  --ifm-color-primary: #2e8555;
+  --ifm-color-primary-dark: #29784c;
+  --ifm-color-primary-darker: #277148;
+  --ifm-color-primary-darkest: #205d3b;
+  --ifm-color-primary-light: #33925d;
+  --ifm-color-primary-lighter: #359962;
+  --ifm-color-primary-lightest: #3cad6e;
+  --ifm-code-font-size: 95%;
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
+}
+
+/* For readability concerns, you should choose a lighter palette in dark mode. */
+[data-theme='dark'] {
+  --ifm-color-primary: #25c2a0;
+  --ifm-color-primary-dark: #21af90;
+  --ifm-color-primary-darker: #1fa588;
+  --ifm-color-primary-darkest: #1a8870;
+  --ifm-color-primary-light: #29d5b0;
+  --ifm-color-primary-lighter: #32d8b4;
+  --ifm-color-primary-lightest: #4fddbf;
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
+}

package/docusaurus/tari-docs/src/pages/index.module.css

@@ -0,0 +1,23 @@
+/**
+ * CSS files with the .module.css suffix will be treated as CSS modules
+ * and scoped locally.
+ */
+
+.heroBanner {
+  padding: 4rem 0;
+  text-align: center;
+  position: relative;
+  overflow: hidden;
+}
+
+@media screen and (max-width: 996px) {
+  .heroBanner {
+    padding: 2rem;
+  }
+}
+
+.buttons {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}

package/docusaurus/tari-docs/src/pages/index.tsx

@@ -0,0 +1,44 @@
+import type {ReactNode} from 'react';
+import clsx from 'clsx';
+import Link from '@docusaurus/Link';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import Layout from '@theme/Layout';
+import HomepageFeatures from '@site/src/components/HomepageFeatures';
+import Heading from '@theme/Heading';
+
+import styles from './index.module.css';
+
+function HomepageHeader() {
+  const {siteConfig} = useDocusaurusContext();
+  return (
+    <header className={clsx('hero hero--primary', styles.heroBanner)}>
+      <div className="container">
+        <Heading as="h1" className="hero__title">
+          {siteConfig.title}
+        </Heading>
+        <p className="hero__subtitle">{siteConfig.tagline}</p>
+        <div className={styles.buttons}>
+          <Link
+            className="button button--secondary button--lg"
+            to="/docs/">
+            tari.js Documentation
+          </Link>
+        </div>
+      </div>
+    </header>
+  );
+}
+
+export default function Home(): ReactNode {
+  const {siteConfig} = useDocusaurusContext();
+  return (
+    <Layout
+      title={`${siteConfig.title}`}
+      description="tari.js - TypeScript and JavaScript library to interact with Tari L2">
+      <HomepageHeader />
+      <main>
+        <HomepageFeatures />
+      </main>
+    </Layout>
+  );
+}

package/docusaurus/tari-docs/static/img/tari-logo.svg

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="161px" height="51px" viewBox="0 0 161 51" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <!-- Generator: Sketch 64 (93537) - https://sketch.com -->
+    <title>Tari Logo</title>
+    <desc>Created with Sketch.</desc>
+    <defs>
+        <polygon id="path-1" points="0.393621297 0.862457335 29.0083004 0.862457335 29.0083004 33.4853883 0.393621297 33.4853883"></polygon>
+    </defs>
+    <g id="Final-Designs" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="Tari-Home---Large-Display" transform="translate(-50.000000, -112.000000)">
+            <g id="Group">
+                <g id="Tari-Logo" transform="translate(50.000000, 112.000000)">
+                    <path d="M102.594401,9.47880149 L91.5497291,42.1014905 L98.6148729,42.1014905 L100.946448,34.5589002 L110.633313,34.5589002 L112.964645,42.1014905 L120.029547,42.1014905 L108.985118,9.47880149 L102.594401,9.47880149 Z M105.78988,18.7257282 L108.750629,28.4486495 L102.828647,28.4486495 L105.78988,18.7257282 Z" id="Fill-1" fill="#000000"></path>
+                    <polygon id="Fill-2" fill="#000000" points="154.348369 42.1015147 160.914771 42.1015147 160.914771 9.47882569 154.348369 9.47882569"></polygon>
+                    <g id="Group-10" transform="translate(0.000000, 0.176120)">
+                        <path d="M130.331357,23.2899286 L130.331357,15.412908 L135.915763,15.412908 C138.462951,15.412908 139.808901,16.7748284 139.808901,19.3517813 C139.808901,21.9282501 138.462951,23.2899286 135.915763,23.2899286 L130.331357,23.2899286 Z M136.976648,29.3699305 C143.007768,29.0536494 146.467259,25.4022604 146.467259,19.3517813 C146.467259,13.059312 142.607758,9.30265727 136.144202,9.30265727 L123.764471,9.30265727 L123.764471,41.9253463 L130.331357,41.9253463 L130.331357,31.7305442 L139.324678,41.9253463 L147.781991,41.9253463 L136.621165,29.3885638 L136.976648,29.3699305 Z" id="Fill-3" fill="#000000"></path>
+                        <g id="Group-7" transform="translate(64.000000, 8.440006)">
+                            <mask id="mask-2" fill="white">
+                                <use xlink:href="#path-1"></use>
+                            </mask>
+                            <g id="Clip-6"></g>
+                            <polygon id="Fill-5" fill="#000000" mask="url(#mask-2)" points="11.4177961 33.4853883 17.9844402 33.4853883 17.9844402 6.97295003 29.0083004 6.97295003 29.0083004 0.862457335 0.393451904 0.862457335 0.393451904 6.97295003 11.4177961 6.97295003"></polygon>
+                        </g>
+                        <path d="M44.338157,17.1463649 L44.338157,23.1828086 L8.93838931,14.0762361 L20.8764882,6.30520718 L44.338157,17.1463649 Z M22.868551,42.4464326 L22.868551,22.7585999 L41.7674959,27.6201815 L22.868551,42.4464326 Z M17.9307424,40.5439062 L4.93805053,26.0356302 L4.93805053,18.1460261 L17.9307424,21.4883937 L17.9307424,40.5439062 Z M0,14.0024291 L0,27.9236371 L20.3772626,50.6774848 L49.2762075,28.0056718 L49.2762075,13.9883937 L20.4697028,0.677484788 L0,14.0024291 Z" id="Fill-8" fill="#000000"></path>
+                    </g>
+                </g>
+            </g>
+        </g>
+    </g>
+</svg>

package/docusaurus/tari-docs/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  // This file is not used in compilation. It is here just for a nice editor experience.
+  "extends": "@docusaurus/tsconfig",
+  "compilerOptions": {
+    "baseUrl": "."
+  },
+  "exclude": [".docusaurus", "build"]
+}

package/package.json

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

package/packages/tari_provider/package.json

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

package/packages/tari_provider/src/TariProvider.ts

@@ -10,7 +10,6 @@ import {
   ListSubstatesResponse,
 } from "./types";
 
-
 export interface TariProvider {
   providerName: string;
   isConnected(): boolean;
@@ -32,4 +31,4 @@ export interface TariProvider {
     limit: number | null,
     offset: number | null,
   ): Promise<ListSubstatesResponse>;
-}
+}

package/packages/tari_provider/src/types.ts

@@ -58,6 +58,8 @@ export interface VaultData {
   type: string;
   balance: number;
   resource_address: string;
+  token_symbol: string;
+  vault_id: string;
 }
 
 export interface VaultBalances {

package/packages/tari_universe/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tari-universe-provider",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "",
   "type": "module",
   "publishConfig": {

package/packages/tari_universe/src/provider.ts

@@ -7,7 +7,7 @@ import {
   ListSubstatesResponse,
   SubmitTransactionRequest,
   TariProvider,
-  TransactionResult
+  TransactionResult,
 } from "@tari-project/tari-provider";
 import {
   ProviderRequest,
@@ -16,7 +16,6 @@ import {
   TariUniverseProviderParameters,
   WindowSize,
 } from "./types";
-import {  } from "@tari-project/tari-provider";
 import { AccountsGetBalancesResponse, SubstateType } from "@tari-project/wallet_jrpc_client";
 import { sendProviderCall } from "./utils";
 
@@ -84,21 +83,7 @@ export class TariUniverseProvider implements TariProvider {
   }
 
   public async getAccount(): Promise<Account> {
-    const { account_id, address, public_key } = await this.sendRequest({ methodName: "getAccount", args: [] });
-    const { balances } = await this.getAccountBalances(address);
-
-    return {
-      account_id,
-      address,
-      public_key,
-      resources: balances.map((b: any) => ({
-        type: b.resource_type,
-        resource_address: b.resource_address,
-        balance: b.balance + b.confidential_balance,
-        vault_id: "Vault" in b.vault_address ? b.vault_address.Vault : b.vault_address,
-        token_symbol: b.token_symbol,
-      })),
-    };
+    return this.sendRequest({ methodName: "getAccount", args: [] });
   }
 
   public async getAccountBalances(componentAddress: string): Promise<AccountsGetBalancesResponse> {

package/packages/tarijs/moon.yml

@@ -54,6 +54,14 @@ tasks:
       - "@files(configs)"
       - "@files(tests)"
   test:
+    command: "pnpm run test"
+    inputs:
+      - "@files(sources)"
+      - "@files(tests)"
+      - "@files(configs)"
+    deps:
+      - "build"
+  integration-test:
     command: "pnpm run integration-tests"
     inputs:
       - "@files(sources)"