feat: improve repo structure & types (#54)

Description
---
While testing v0.5.0 it turned out that some imports were unused, some
were redundant (eg the same type possible to import from different
repos), some were used as `any` or `unknown`. This PR is about fixing
all mentioned, solving TODOs and make the `tari.js` easier to use in
general.

Bump package to v0.5.1.

Motivation and Context
---
Cleanup, remove redundant types, improve exports & structure the repo. 

How Has This Been Tested?
---
Manually with the Tari Universe and Tex Tapplet.

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 -->

Author: karczuRF

TODO.md

@@ -2,7 +2,3 @@
 
 - For the example site:
   - 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)
-- Other
-  - Configure prettier to not change entire file while saving

docusaurus/tari-docs/docs/providers/indexer-provider.md

@@ -9,18 +9,18 @@ This provider is designed to provide connection to the blockchain, whch can be u
 ## Install required dependencies
 
 ```bash npm2yarn
-npm install @tari-project/tari-universe-signer @tari-project/tari-permissions
+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";
-import { TariUniverseSigner } from "@tari-project/tari-universe-signer";
 
 const permissions = new TariPermissions().addPermission("Admin");
 const optionalPermissions = new TariPermissions();
-const indexerJrpcUrl = "http://127.0.0.1:12006/json_rpc";
+const indexerJrpcUrl = "http://127.0.0.1:12006/json_rpc"; // example url
 
 const params: IndexerProviderParameters = {
   indexerJrpcUrl: indexerJrpcUrl,

docusaurus/tari-docs/package.json

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

package.json

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

packages/builders/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tarijs-builders",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "",
   "type": "module",
   "publishConfig": {
@@ -15,8 +15,7 @@
   "dependencies": {
     "@tari-project/tari-signer": "workspace:^",
     "@tari-project/tari-universe-signer": "workspace:^",
-    "@tari-project/tarijs-types": "workspace:^",
-    "@tari-project/typescript-bindings": "catalog:"
+    "@tari-project/tarijs-types": "workspace:^"
   },
   "devDependencies": {
     "@types/node": "catalog:",

packages/builders/src/helpers/submitTransaction.ts

@@ -1,5 +1,5 @@
 import { TariUniverseSigner } from "@tari-project/tari-universe-signer";
-import { TariSigner, SubmitTransactionRequest, SubstateRequirement } from "@tari-project/tari-signer";
+import { TariSigner } from "@tari-project/tari-signer";
 import {
   Transaction,
   TransactionResult,
@@ -9,21 +9,21 @@ import {
   FinalizeResultStatus,
   TxResultAccept,
   SubmitTxResult,
+  ReqSubstate,
+  SubmitTransactionRequest,
 } from "@tari-project/tarijs-types";
 
 export function buildTransactionRequest(
   transaction: Transaction,
   accountId: number,
-  requiredSubstates: SubstateRequirement[],
+  requiredSubstates: ReqSubstate[],
   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[],
@@ -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));
   }

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;
 }
 

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;
+  }
 }

packages/indexer_provider/package.json

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

packages/indexer_provider/src/provider.ts

@@ -1,11 +1,4 @@
-import {
-  GetSubstateRequest,
-  ListSubstatesRequest,
-  ListSubstatesResponse,
-  Substate,
-  TariProvider,
-  TransactionResult,
-} from "@tari-project/tari-provider";
+import { TariProvider } from "@tari-project/tari-provider";
 import { TariPermissions } from "@tari-project/tari-permissions";
 import { IndexerProviderClient } from "./transports";
 import {
@@ -15,7 +8,14 @@ import {
   substateIdToString,
   SubstatesListRequest,
 } from "@tari-project/typescript-bindings";
-import { convertStringToTransactionStatus } from "@tari-project/tarijs-types";
+import {
+  convertStringToTransactionStatus,
+  GetSubstateRequest,
+  GetTransactionResultResponse,
+  ListSubstatesRequest,
+  ListSubstatesResponse,
+  Substate,
+} from "@tari-project/tarijs-types";
 
 export interface IndexerProviderParameters {
   indexerJrpcUrl: string;
@@ -88,7 +88,7 @@ export class IndexerProvider implements TariProvider {
     return resp;
   }
 
-  public async getTransactionResult(transactionId: string): Promise<TransactionResult> {
+  public async getTransactionResult(transactionId: string): Promise<GetTransactionResultResponse> {
     const resp = await this.client.getTransactionResult({ transaction_id: transactionId });
 
     return {

packages/metamask_signer/package.json

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

packages/metamask_signer/src/index.ts

@@ -8,11 +8,18 @@ import {
   TemplateDefinition,
   Substate,
   ListSubstatesResponse,
-  Account,
-} from "@tari-project/tari-signer";
+  AccountData,
+  ListSubstatesRequest,
+  GetTransactionResultResponse,
+} from "@tari-project/tarijs-types";
 import { MetaMaskInpageProvider } from "@metamask/providers";
 import { connectSnap, getSnap, isFlask, Snap } from "./utils";
-import { ListAccountNftRequest, ListAccountNftResponse, SubstateType } from "@tari-project/typescript-bindings";
+import {
+  ConfidentialViewVaultBalanceRequest,
+  ListAccountNftRequest,
+  ListAccountNftResponse,
+  SubstateType,
+} from "@tari-project/typescript-bindings";
 
 export const MetamaskNotInstalled = "METAMASK_NOT_INSTALLED";
 export const MetamaskIsNotFlask = "METAMASK_IS_NOT_FLASK";
@@ -64,7 +71,7 @@ export class MetamaskTariSigner implements TariSigner {
     return this.metamaskConnected;
   }
 
-  public async createFreeTestCoins(account_id: number): Promise<Account> {
+  public async createFreeTestCoins(account_id: number): Promise<AccountData> {
     const res = (await this.metamaskRequest("getFreeTestCoins", {
       amount: 1000000,
       account_id,
@@ -78,7 +85,7 @@ export class MetamaskTariSigner implements TariSigner {
     };
   }
 
-  async getAccount(): Promise<Account> {
+  async getAccount(): Promise<AccountData> {
     return (await this.metamaskRequest("getAccountData", { account_id: 0 })) as any;
   }
 
@@ -91,12 +98,12 @@ export class MetamaskTariSigner implements TariSigner {
     return { value: substate, address: { substate_id, version } };
   }
 
-  async listSubstates(
-    filter_by_template: string | null,
-    filter_by_type: SubstateType | null,
-    limit: number | null,
-    offset: number | null,
-  ): Promise<ListSubstatesResponse> {
+  async listSubstates({
+    filter_by_template,
+    filter_by_type,
+    limit,
+    offset,
+  }: ListSubstatesRequest): Promise<ListSubstatesResponse> {
     const res = (await this.metamaskRequest("listSubstates", {
       filter_by_template,
       filter_by_type,
@@ -126,7 +133,7 @@ export class MetamaskTariSigner implements TariSigner {
     return { transaction_id: resp.transaction_id };
   }
 
-  public async getTransactionResult(transactionId: string): Promise<TransactionResult> {
+  public async getTransactionResult(transactionId: string): Promise<GetTransactionResultResponse> {
     // This request returns the response from the indexer get_transaction_result request
     const resp: Maybe<any> = await this.metamaskRequest("getTransactionResult", { transaction_id: transactionId });
 
@@ -139,7 +146,7 @@ export class MetamaskTariSigner implements TariSigner {
         transaction_id: transactionId,
         status: TransactionStatus.Pending,
         result: null,
-      } as TransactionResult;
+      } as GetTransactionResultResponse;
     }
 
     if (!resp?.result?.Finalized) {
@@ -152,7 +159,7 @@ export class MetamaskTariSigner implements TariSigner {
       transaction_id: transactionId,
       status: newStatus,
       result: resp.result.Finalized.execution_result.finalize,
-    } as TransactionResult;
+    } as GetTransactionResultResponse;
   }
 
   public async getPublicKey(_branch: string, index: number): Promise<string> {
@@ -165,20 +172,20 @@ export class MetamaskTariSigner implements TariSigner {
     return resp.public_key;
   }
 
-  public async getConfidentialVaultBalances(
-    viewKeyId: number,
-    vaultId: string,
-    min: number | null = null,
-    max: number | null = null,
-  ): Promise<VaultBalances> {
-    const res = (await this.metamaskRequest("getConfidentialVaultBalances", {
-      view_key_id: viewKeyId,
-      vault_id: vaultId,
-      minimum_expected_value: min,
-      maximum_expected_value: max,
-    })) as any;
+  public async getConfidentialVaultBalances({
+    vault_id,
+    maximum_expected_value,
+    minimum_expected_value,
+    view_key_id,
+  }: ConfidentialViewVaultBalanceRequest): Promise<VaultBalances> {
+    const resp = await this.metamaskRequest("getConfidentialVaultBalances", {
+      view_key_id,
+      vault_id,
+      minimum_expected_value,
+      maximum_expected_value,
+    });
 
-    return { balances: res as unknown as Map<string, number | null> };
+    return { balances: resp as Map<string, number | null> };
   }
 
   getTemplateDefinition(template_address: string): Promise<TemplateDefinition> {

packages/tari_permissions/package.json

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