@tari-project/tarijs 0.4.0 → 0.4.2

package/packages/walletconnect/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@tari-project/wallet-connect-provider",
+  "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/tarijs-builders": "workspace:^",
+    "@tari-project/typescript-bindings": "catalog:",
+    "@tari-project/wallet_jrpc_client": "catalog:",
+    "@walletconnect/modal": "catalog:",
+    "@walletconnect/universal-provider": "catalog:"
+  },
+  "devDependencies": {
+    "@types/node": "catalog:",
+    "typescript": "catalog:"
+  },
+  "files": [
+    "/dist"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts"
+}

package/packages/walletconnect/src/index.ts

@@ -0,0 +1,274 @@
+import {
+  TariProvider, SubmitTransactionRequest,
+  TransactionResult,
+  SubmitTransactionResponse,
+  VaultBalances, TemplateDefinition, Substate,
+  Account,
+  ListSubstatesResponse,
+} from "@tari-project/tari-provider";
+import {
+  TransactionStatus,
+} from "@tari-project/tarijs-builders";
+import UniversalProvider from "@walletconnect/universal-provider";
+import { WalletConnectModal } from "@walletconnect/modal";
+import {
+  Instruction,
+  KeyBranch,
+  stringToSubstateId,
+  substateIdToString,
+  SubstateType,
+  TransactionSubmitRequest,
+} from "@tari-project/wallet_jrpc_client";
+
+const walletConnectParams = {
+  requiredNamespaces: {
+    tari: {
+      methods: [
+        "tari_getSubstate",
+        "tari_getDefaultAccount",
+        "tari_getAccountBalances",
+        "tari_submitTransaction",
+        "tari_getTransactionResult",
+        "tari_getTemplate",
+        "tari_createKey",
+        "tari_viewConfidentialVaultBalance",
+        "tari_createFreeTestCoins",
+        "tari_listSubstates",
+      ],
+      chains: [
+        "tari:devnet",
+      ],
+      events: ["chainChanged\", \"accountsChanged"],
+    },
+  },
+};
+
+export class WalletConnectTariProvider implements TariProvider {
+  public providerName = "WalletConnect";
+  projectId: string;
+  wcProvider: UniversalProvider | null;
+  wcSession: any | null;
+
+  constructor(projectId: string) {
+    this.projectId = projectId;
+    this.wcProvider = null;
+    this.wcSession = null;
+  }
+
+  async connect(): Promise<void> {
+    if (this.wcProvider && this.wcSession)
+      return;
+
+    // initialize WalletConnect
+    const projectId = this.projectId;
+    this.wcProvider = await UniversalProvider.init({
+      projectId,
+      // TODO: parameterize the relay URL
+      relayUrl: "wss://relay.walletconnect.com",
+    });
+
+    // open UI modal with the connection URI
+    const { uri, approval } = await this.wcProvider.client.connect(walletConnectParams);
+    const walletConnectModal = new WalletConnectModal({
+      projectId,
+    });
+    if (uri) {
+      walletConnectModal.openModal({ uri });
+    }
+
+    // wait for the wallet to approve the connection
+    console.log("waiting for session approval from the wallet app");
+    const session = await approval();
+    walletConnectModal.closeModal();
+
+    // at this point session is open
+    console.log("session approved by the wallet");
+    this.wcSession = session;
+  }
+
+  private async sendRequest(method: string, params: object): Promise<any> {
+    if (!this.wcProvider) {
+      throw "WalletConnect provider not initialized";
+    }
+
+    if (!this.wcSession) {
+      throw "WalletConnect session not initialized";
+    }
+
+    const requestResult = await this.wcProvider.client.request({
+      topic: this.wcSession.topic,
+      chainId: "tari:devnet",
+      request: {
+        method,
+        params,
+      },
+    });
+
+    console.log({ requestResult });
+
+    return requestResult;
+  }
+
+
+  isConnected(): boolean {
+    // TODO: check status in the session
+    return this.wcSession !== null;
+  }
+
+  async getAccount(): Promise<Account> {
+    const { account, public_key } = await this.sendRequest("tari_getDefaultAccount", {});
+    const { balances } = await this.sendRequest(
+      "tari_getAccountBalances",
+      {
+        account: { ComponentAddress: account.address }, refresh: false,
+      });
+
+    return {
+      account_id: account.key_index,
+      address: account.address,
+      public_key,
+      // TODO: should be vaults not resources
+      resources: balances.map((b: any) => ({
+        type: b.resource_type,
+        resource_address: b.resource_address,
+        balance: b.balance + b.confidential_balance,
+        vault_id: (typeof (b.vault_address) === "object" && "Vault" in b.vault_address) ? b.vault_address.Vault : b.vault_address,
+        token_symbol: b.token_symbol,
+      })),
+    };
+  }
+
+  async getSubstate(substate_address: string): Promise<Substate> {
+    const method = "tari_getSubstate";
+    const params = { substate_id: substate_address };
+    const { value, record } = await this.sendRequest(method, params);
+    return {
+      value,
+      address: {
+        substate_id: record.substate_id,
+        version: record.version,
+      },
+    };
+  }
+
+  public async listSubstates(filter_by_template: string | null, filter_by_type: SubstateType | null, limit: number | null, offset: number | null): Promise<ListSubstatesResponse> {
+    const method = "tari_listSubstates";
+    const params = {
+      filter_by_template,
+      filter_by_type,
+      limit,
+      offset,
+    };
+    const res = await this.sendRequest(method, params);
+    const substates = res.substates.map((s: any) => ({
+      substate_id: substateIdToString(s.substate_id),
+      module_name: s.module_name,
+      version: s.version,
+      template_address: s.template_address,
+    }));
+
+    return { substates };
+  }
+
+  public async createFreeTestCoins(): Promise<Account> {
+    const method = "tari_createFreeTestCoins";
+    const params = {
+      account: { Name: "template_web" },
+      amount: 1000000,
+      max_fee: null,
+      key_id: 0,
+    };
+    const res = await this.sendRequest(method, params);
+    return {
+      account_id: res.account.key_index,
+      address: (res.account.address as { Component: string }).Component,
+      public_key: res.public_key,
+      resources: [],
+    };
+  }
+
+  async submitTransaction(req: SubmitTransactionRequest): Promise<SubmitTransactionResponse> {
+    const method = "tari_submitTransaction";
+    const params: TransactionSubmitRequest = {
+      transaction: {
+        V1: {
+          network: req.network,
+          fee_instructions: req.fee_instructions as Instruction[],
+          instructions: req.instructions as Instruction[],
+          inputs: req.required_substates.map((s) => ({
+            // TODO: Hmm The bindings want a SubstateId object, but the wallet only wants a string. Any is used to skip type checking here
+            substate_id: s.substate_id as any,
+            version: s.version ?? null,
+          })),
+          min_epoch: null,
+          max_epoch: null,
+          is_seal_signer_authorized: req.is_seal_signer_authorized,
+        },
+      },
+      signing_key_index: req.account_id,
+      autofill_inputs: [],
+      detect_inputs: true,
+      proof_ids: [],
+      detect_inputs_use_unversioned: req.detect_inputs_use_unversioned,
+    };
+
+    const res = await this.sendRequest(method, params);
+
+    return { transaction_id: res.transaction_id };
+  }
+
+  async getTransactionResult(transactionId: string): Promise<TransactionResult> {
+    const res = await this.sendRequest("tari_getTransactionResult", { transaction_id: transactionId });
+
+    return {
+      transaction_id: transactionId,
+      status: convertStringToTransactionStatus(res.status),
+      result: res.result,
+    };
+  }
+
+  async getTemplateDefinition(template_address: string): Promise<TemplateDefinition> {
+    let resp = await this.sendRequest("tari_getTemplate", { template_address });
+    return resp.template_definition as TemplateDefinition;
+  }
+
+  async getPublicKey(branch: string, index: number): Promise<string> {
+    const res = await this.sendRequest("tari_createKey", { branch: branch as KeyBranch, specific_index: index });
+    return res.public_key;
+  }
+
+  async getConfidentialVaultBalances(viewKeyId: number, vaultId: string, min: number | null, max: number | null): Promise<VaultBalances> {
+    const method = "tari_viewConfidentialVaultBalance";
+    const params = {
+      view_key_id: viewKeyId,
+      vault_id: vaultId,
+      minimum_expected_value: min,
+      maximum_expected_value: max,
+    };
+
+    const res = await this.sendRequest(method, params);
+    return { balances: res.balances as unknown as Map<string, number | null> };
+  }
+
+}
+
+function convertStringToTransactionStatus(status: string): TransactionStatus {
+  switch (status) {
+    case "New":
+      return TransactionStatus.New;
+    case "DryRun":
+      return TransactionStatus.DryRun;
+    case "Pending":
+      return TransactionStatus.Pending;
+    case "Accepted":
+      return TransactionStatus.Accepted;
+    case "Rejected":
+      return TransactionStatus.Rejected;
+    case "InvalidTransaction":
+      return TransactionStatus.InvalidTransaction;
+    case "OnlyFeeAccepted":
+      return TransactionStatus.OnlyFeeAccepted;
+    default:
+      throw new Error(`Unknown status: ${status}`);
+  }
+}

package/packages/walletconnect/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "module": "ES2020",
+    "target": "ESNext",
+    "moduleResolution": "Bundler",
+    "outDir": "./dist",
+    "rootDir": "./src"
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "references": [
+    {
+      "path": "../builders"
+    },
+    {
+      "path": "../tari_provider"
+    }
+  ]
+}

package/pnpm-workspace.yaml

@@ -0,0 +1,15 @@
+packages:
+  - packages/*
+  - apps/*
+  - docusaurus/*
+  - "!**/test/**"
+catalog:
+  typescript: ^5.0.4
+  vitest: ^3.0.4
+  vite: ^6.1.0
+  "@types/node": ^22.13.1
+  "@tari-project/typescript-bindings": ^1.4.0
+  "@tari-project/wallet_jrpc_client": ^1.4.0
+  "@metamask/providers": ^18.2.0
+  "@walletconnect/universal-provider": ^2.13.3
+  "@walletconnect/modal": ^2.6.2

package/tsconfig.json

@@ -0,0 +1,45 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "strictPropertyInitialization": false,
+    "allowSyntheticDefaultImports": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "composite": true
+  },
+  "references": [
+    {
+      "path": "docusaurus/tari-docs"
+    },
+    {
+      "path": "packages/builders"
+    },
+    {
+      "path": "packages/metamask_provider"
+    },
+    {
+      "path": "packages/tari_permissions"
+    },
+    {
+      "path": "packages/tari_provider"
+    },
+    {
+      "path": "packages/tari_universe"
+    },
+    {
+      "path": "packages/tarijs"
+    },
+    {
+      "path": "packages/tarijs_types"
+    },
+    {
+      "path": "packages/types"
+    },
+    {
+      "path": "packages/wallet_daemon"
+    },
+    {
+      "path": "packages/walletconnect"
+    }
+  ]
+}

package/dist/index.d.ts

@@ -1,14 +0,0 @@
-import { TariProvider } from "@tari-project/tari-provider";
-import * as utils from "./utils";
-import { Network } from "./network";
-import { Account, TransactionStatus, TransactionResult, SubmitTransactionResponse, SubmitTransactionRequest, VaultBalances, VaultData, TemplateDefinition, SubstateRequirement, Substate } from "@tari-project/tari-provider";
-import { MetamaskTariProvider } from "@tari-project/metamask-provider";
-import { MetaMaskInpageProvider } from "@metamask/providers";
-import { WalletDaemonTariProvider, WalletDaemonParameters, TariPermissions } from "@tari-project/wallet-daemon-provider";
-import { TariUniverseProvider, TariUniverseProviderParameters } from "@tari-project/tari-universe-provider";
-import * as permissions from "@tari-project/tari-permissions";
-import { WalletConnectTariProvider } from "@tari-project/wallet-connect-provider";
-import { TransactionBuilder, TransactionRequest, buildTransactionRequest, submitAndWaitForTransaction, waitForTransactionResult, fromWorkspace, toWorkspace } from "@tari-project/tarijs-builders";
-import * as templates from "./templates";
-export * from "@tari-project/tarijs-types";
-export { utils, Network, TariProvider, Account, TransactionStatus, TransactionResult, SubmitTransactionResponse, SubmitTransactionRequest, VaultBalances, VaultData, TemplateDefinition, SubstateRequirement, MetamaskTariProvider, WalletDaemonTariProvider, WalletDaemonParameters, TariUniverseProvider, TariUniverseProviderParameters, TariPermissions, MetaMaskInpageProvider, Substate, permissions, WalletConnectTariProvider, TransactionBuilder, TransactionRequest, buildTransactionRequest, submitAndWaitForTransaction, waitForTransactionResult, fromWorkspace, toWorkspace, templates, };

package/dist/index.js

@@ -1,13 +0,0 @@
-import * as utils from "./utils";
-import { Network } from "./network";
-import { TransactionStatus, } from "@tari-project/tari-provider";
-import { MetamaskTariProvider } from "@tari-project/metamask-provider";
-import { MetaMaskInpageProvider } from "@metamask/providers";
-import { WalletDaemonTariProvider, TariPermissions, } from "@tari-project/wallet-daemon-provider";
-import { TariUniverseProvider } from "@tari-project/tari-universe-provider";
-import * as permissions from "@tari-project/tari-permissions";
-import { WalletConnectTariProvider } from "@tari-project/wallet-connect-provider";
-import { TransactionBuilder, TransactionRequest, buildTransactionRequest, submitAndWaitForTransaction, waitForTransactionResult, fromWorkspace, toWorkspace, } from "@tari-project/tarijs-builders";
-import * as templates from "./templates";
-export * from "@tari-project/tarijs-types";
-export { utils, Network, TransactionStatus, MetamaskTariProvider, WalletDaemonTariProvider, TariUniverseProvider, TariPermissions, MetaMaskInpageProvider, permissions, WalletConnectTariProvider, TransactionBuilder, TransactionRequest, buildTransactionRequest, submitAndWaitForTransaction, waitForTransactionResult, fromWorkspace, toWorkspace, templates, };

package/dist/network.d.ts

@@ -1,8 +0,0 @@
-export declare enum Network {
-    MainNet = 0,
-    StageNet = 1,
-    NextNet = 2,
-    LocalNet = 16,
-    Igor = 36,
-    Esmeralda = 38
-}

package/dist/network.js

@@ -1,9 +0,0 @@
-export var Network;
-(function (Network) {
-    Network[Network["MainNet"] = 0] = "MainNet";
-    Network[Network["StageNet"] = 1] = "StageNet";
-    Network[Network["NextNet"] = 2] = "NextNet";
-    Network[Network["LocalNet"] = 16] = "LocalNet";
-    Network[Network["Igor"] = 36] = "Igor";
-    Network[Network["Esmeralda"] = 38] = "Esmeralda";
-})(Network || (Network = {}));

package/dist/templates/Account.d.ts

@@ -1,65 +0,0 @@
-import { ConfidentialWithdrawProof, NonFungibleId, ResourceAddress } from "@tari-project/typescript-bindings";
-import { Amount } from "@tari-project/tarijs-types";
-import { TariMethodDefinition, WorkspaceArg } from "@tari-project/tarijs-builders";
-import { TemplateFactory } from "./TemplateFactory";
-/**
- * Adds a fee instruction that calls the "take_fee" method on a component.
- * This method must exist and return a Bucket with containing revealed confidential XTR resource.
- * This allows the fee to originate from sources other than the transaction sender's account.
- * The fee instruction will lock up the "max_fee" amount for the duration of the transaction.
- * @param componentAddress
- * @param maxFee
- * @returns
- */
-interface PayFeeMethod extends TariMethodDefinition {
-    methodName: "pay_fee";
-    args?: [Amount];
-}
-interface PayFeeConfidentialMethod extends TariMethodDefinition {
-    methodName: "pay_fee_confidential";
-    args?: [ConfidentialWithdrawProof];
-}
-interface WithdrawMethod extends TariMethodDefinition {
-    methodName: "withdraw";
-    args?: [string, Amount];
-}
-interface DepositMethod extends TariMethodDefinition {
-    methodName: "deposit";
-    args?: WorkspaceArg[];
-}
-interface CreateProofForResourceMethod extends TariMethodDefinition {
-    methodName: "create_proof_for_resource";
-    args?: [ResourceAddress];
-}
-interface CreateProofByAmountMethod extends TariMethodDefinition {
-    methodName: "create_proof_by_amount";
-    args?: [ResourceAddress, Amount];
-}
-interface CreateProofByNonFungibleIdsMethod extends TariMethodDefinition {
-    methodName: "create_proof_by_non_fungible_ids";
-    args?: [ResourceAddress, NonFungibleId[]];
-}
-interface BalanceMethod extends TariMethodDefinition {
-    methodName: "balance";
-    args?: [ResourceAddress];
-}
-interface GetBalancesMethod extends TariMethodDefinition {
-    methodName: "get_balances";
-    args?: [];
-}
-export declare class AccountTemplate extends TemplateFactory {
-    templateAddress: string;
-    deposit: DepositMethod;
-    withdraw: WithdrawMethod;
-    createProofByAmount: CreateProofByAmountMethod;
-    createProofByNonFungibleIds: CreateProofByNonFungibleIdsMethod;
-    createProofForResource: CreateProofForResourceMethod;
-    balance: BalanceMethod;
-    getBalances: GetBalancesMethod;
-    payFee: PayFeeMethod;
-    payFeeConfidential: PayFeeConfidentialMethod;
-    constructor(templateAddress: string);
-    protected _initFunctions(): void;
-    protected _initMethods(): void;
-}
-export {};

package/dist/templates/Account.js

@@ -1,31 +0,0 @@
-import { TemplateFactory } from "./TemplateFactory";
-export class AccountTemplate extends TemplateFactory {
-    templateAddress;
-    deposit;
-    withdraw;
-    createProofByAmount;
-    createProofByNonFungibleIds;
-    createProofForResource;
-    balance;
-    getBalances;
-    payFee;
-    payFeeConfidential;
-    constructor(templateAddress) {
-        super(templateAddress);
-        this.templateAddress = templateAddress;
-        this._initFunctions();
-        this._initMethods();
-    }
-    _initFunctions() { }
-    _initMethods() {
-        this.deposit = this._defineMethod("deposit");
-        this.withdraw = this._defineMethod("withdraw");
-        this.createProofByAmount = this._defineMethod("create_proof_by_amount");
-        this.createProofByNonFungibleIds = this._defineMethod("create_proof_by_non_fungible_ids");
-        this.createProofForResource = this._defineMethod("create_proof_for_resource");
-        this.balance = this._defineMethod("balance");
-        this.getBalances = this._defineMethod("get_balances");
-        this.payFee = this._defineMethod("pay_fee");
-        this.payFeeConfidential = this._defineMethod("pay_fee_confidential");
-    }
-}

package/dist/templates/Pool.d.ts

@@ -1,29 +0,0 @@
-import { TariMethodDefinition, WorkspaceArg } from "@tari-project/tarijs-builders";
-import { TemplateFactory } from "./TemplateFactory";
-interface CreatePool extends TariMethodDefinition {
-    methodName: "create_pool";
-    args?: [string, string];
-}
-interface AddLiquidityMethod extends TariMethodDefinition {
-    methodName: "add_liquidity";
-    args?: WorkspaceArg[];
-}
-interface RemoveLiquidityMethod extends TariMethodDefinition {
-    methodName: "remove_liquidity";
-    args?: WorkspaceArg[];
-}
-interface SwapMethod extends TariMethodDefinition {
-    methodName: "swap";
-    args?: (WorkspaceArg | string)[];
-}
-export declare class PoolTemplate extends TemplateFactory {
-    templateAddress: string;
-    createPool: CreatePool;
-    addLiquidity: AddLiquidityMethod;
-    removeLiquidity: RemoveLiquidityMethod;
-    swap: SwapMethod;
-    constructor(templateAddress: string);
-    protected _initFunctions(): void;
-    protected _initMethods(): void;
-}
-export {};

package/dist/templates/Pool.js

@@ -1,20 +0,0 @@
-import { TemplateFactory } from "./TemplateFactory";
-export class PoolTemplate extends TemplateFactory {
-    templateAddress;
-    createPool;
-    addLiquidity;
-    removeLiquidity;
-    swap;
-    constructor(templateAddress) {
-        super(templateAddress);
-        this.templateAddress = templateAddress;
-        this._initFunctions();
-        this._initMethods();
-    }
-    _initFunctions() { }
-    _initMethods() {
-        this.addLiquidity = this._defineMethod("add_liquidity");
-        this.removeLiquidity = this._defineMethod("remove_liquidity");
-        this.swap = this._defineMethod("swap");
-    }
-}

package/dist/templates/Tariswap.d.ts

@@ -1,64 +0,0 @@
-import { Amount, ConfidentialWithdrawProof, ResourceAddress, TariFunctionDefinition, TariMethodDefinition, WorkspaceArg } from "@tari-project/tarijs-builders";
-import { TemplateFactory } from "./TemplateFactory";
-interface NewPoolFunction extends TariFunctionDefinition {
-    functionName: "new";
-    args?: [ResourceAddress, ResourceAddress, Amount];
-}
-interface MintFunction extends TariFunctionDefinition {
-    functionName: "mint";
-    args?: [Amount];
-}
-interface MintWithSymbolFunction extends TariFunctionDefinition {
-    functionName: "mint_with_symbol";
-    args?: [Amount, string];
-}
-interface PayFeeMethod extends TariMethodDefinition {
-    methodName: "pay_fee";
-    args?: [string];
-}
-interface PayFeeConfidentialMethod extends TariMethodDefinition {
-    methodName: "pay_fee_confidential";
-    args?: [ConfidentialWithdrawProof];
-}
-interface TotalSupplyMethod extends TariMethodDefinition {
-    methodName: "total_supply";
-    args?: [];
-}
-interface WithdrawMethod extends TariMethodDefinition {
-    methodName: "withdraw";
-    args?: [string, string];
-}
-interface AddLiquidityMethod extends TariMethodDefinition {
-    methodName: "add_liquidity";
-    args?: WorkspaceArg[];
-}
-interface RemoveLiquidityMethod extends TariMethodDefinition {
-    methodName: "remove_liquidity";
-    args?: WorkspaceArg[];
-}
-interface DepositMethod extends TariMethodDefinition {
-    methodName: "deposit";
-    args?: WorkspaceArg[];
-}
-interface SwapMethod extends TariMethodDefinition {
-    methodName: "swap";
-    args?: (WorkspaceArg | string)[];
-}
-export declare class TariswapTemplate extends TemplateFactory {
-    templateAddress: string;
-    newPool: NewPoolFunction;
-    mint: MintFunction;
-    mintWithSymbol: MintWithSymbolFunction;
-    totalSupply: TotalSupplyMethod;
-    payFee: PayFeeMethod;
-    payFeeConfidential: PayFeeConfidentialMethod;
-    withdraw: WithdrawMethod;
-    addLiquidity: AddLiquidityMethod;
-    removeLiquidity: RemoveLiquidityMethod;
-    deposit: DepositMethod;
-    swap: SwapMethod;
-    constructor(templateAddress: string);
-    protected _initFunctions(): void;
-    protected _initMethods(): void;
-}
-export {};