@tari-project/tarijs 0.4.2 → 0.5.0

package/packages/indexer_provider/src/transports/fetch.ts

@@ -0,0 +1,46 @@
+import { RpcRequest, RpcTransport, RpcTransportOptions } from "./rpc";
+
+export default class FetchRpcTransport implements RpcTransport {
+  private url: string;
+
+  constructor(url: string) {
+    this.url = url;
+  }
+
+  static new(url: string) {
+    return new FetchRpcTransport(url);
+  }
+
+  async sendRequest<T>(data: RpcRequest, options: RpcTransportOptions): Promise<T> {
+    const headers: { [key: string]: string } = {
+      "Content-Type": "application/json",
+    };
+    if (options?.token) {
+      headers["Authorization"] = `Bearer ${options.token}`;
+    }
+
+    let controller = new AbortController();
+    let signal = controller.signal;
+
+    const timeoutId = options.timeout_millis
+      ? setTimeout(() => {
+          controller.abort("Timeout");
+        }, options.timeout_millis)
+      : null;
+
+    const response = await fetch(this.url, {
+      method: "POST",
+      body: JSON.stringify(data),
+      headers,
+      signal,
+    });
+    if (timeoutId) {
+      clearTimeout(timeoutId);
+    }
+    const json = await response.json();
+    if (json.error) {
+      throw new Error(`${json.error.code}: ${json.error.message}`);
+    }
+    return json.result;
+  }
+}

package/packages/indexer_provider/src/transports/index.ts

@@ -0,0 +1,3 @@
+export { IndexerProviderClient } from "./IndexerProviderClient";
+export * from "./fetch";
+export * from "./rpc";

package/packages/indexer_provider/src/transports/rpc.ts

@@ -0,0 +1,19 @@
+import FetchRpcTransport from "./fetch";
+
+export { FetchRpcTransport };
+
+export interface RpcTransport {
+  sendRequest<T>(request: RpcRequest, options: RpcTransportOptions): Promise<T>;
+}
+
+export interface RpcTransportOptions {
+  token?: string;
+  timeout_millis?: number;
+}
+
+export interface RpcRequest {
+  id: number;
+  jsonrpc: string;
+  method: string;
+  params: any;
+}

package/packages/indexer_provider/tsconfig.json

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

package/packages/metamask_signer/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/{metamask_provider → metamask_signer}/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@tari-project/metamask-provider",
-  "version": "0.4.0",
+  "name": "@tari-project/metamask-signer",
+  "version": "0.5.0",
   "description": "",
   "type": "module",
   "publishConfig": {
@@ -14,7 +14,7 @@
   "license": "ISC",
   "dependencies": {
     "@metamask/providers": "catalog:",
-    "@tari-project/tari-provider": "workspace:^",
+    "@tari-project/tari-signer": "workspace:^",
     "@tari-project/tarijs-types": "workspace:^",
     "@tari-project/typescript-bindings": "catalog:"
   },

package/packages/{metamask_provider → metamask_signer}/src/index.ts

@@ -1,4 +1,4 @@
-import { TariProvider } from "@tari-project/tari-provider";
+import { TariSigner } from "@tari-project/tari-signer";
 import {
   SubmitTransactionRequest,
   TransactionResult,
@@ -8,11 +8,11 @@ import {
   TemplateDefinition,
   Substate,
   ListSubstatesResponse,
-  Account
-} from "@tari-project/tari-provider";
+  Account,
+} from "@tari-project/tari-signer";
 import { MetaMaskInpageProvider } from "@metamask/providers";
 import { connectSnap, getSnap, isFlask, Snap } from "./utils";
-import { SubstateType } from "@tari-project/typescript-bindings";
+import { ListAccountNftRequest, ListAccountNftResponse, SubstateType } from "@tari-project/typescript-bindings";
 
 export const MetamaskNotInstalled = "METAMASK_NOT_INSTALLED";
 export const MetamaskIsNotFlask = "METAMASK_IS_NOT_FLASK";
@@ -20,8 +20,8 @@ export const TariSnapNotInstalled = "TARI_SNAP_NOT_INSTALLED";
 
 type Maybe<T> = T | null | undefined;
 
-export class MetamaskTariProvider implements TariProvider {
-  public providerName = "Metamask";
+export class MetamaskTariSigner implements TariSigner {
+  public signerName = "Metamask";
   snapId: string;
   snapVersion: string | undefined;
   metamask: MetaMaskInpageProvider;
@@ -212,6 +212,11 @@ export class MetamaskTariProvider implements TariProvider {
 
     return resp as T;
   }
+
+  public async getNftsList(req: ListAccountNftRequest): Promise<ListAccountNftResponse> {
+    const resp = (await this.metamaskRequest("getNftsList", req)) as ListAccountNftResponse;
+    return resp;
+  }
 }
 
 function convertToStatus(result: any): TransactionStatus {

package/packages/metamask_signer/tsconfig.json

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

package/packages/tari_permissions/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tari-permissions",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "",
   "type": "module",
   "publishConfig": {
@@ -12,8 +12,7 @@
   "keywords": [],
   "author": "",
   "license": "ISC",
-  "dependencies": {
-  },
+  "dependencies": {},
   "devDependencies": {
     "@types/node": "catalog:",
     "typescript": "catalog:"

package/packages/tari_permissions/src/helpers.ts

@@ -0,0 +1,33 @@
+import {
+  TariPermission,
+  TariPermissionAccountBalance,
+  TariPermissionAccountInfo,
+  TariPermissionAccountList,
+  TariPermissionGetNft,
+  TariPermissionKeyList,
+  TariPermissionNftGetOwnershipProof,
+  TariPermissionTransactionGet,
+  TariPermissionTransactionSend,
+} from "./tari_permissions";
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export function createPermissionFromType(permission: any): TariPermission {
+  if (Object.prototype.hasOwnProperty.call(permission, "AccountBalance")) {
+    return new TariPermissionAccountBalance(permission.AccountBalance);
+  } else if (permission === "AccountInfo") {
+    return new TariPermissionAccountInfo();
+  } else if (Object.prototype.hasOwnProperty.call(permission, "AccountList")) {
+    return new TariPermissionAccountList(permission.AccountList);
+  } else if (permission == "KeyList") {
+    return new TariPermissionKeyList();
+  } else if (Object.prototype.hasOwnProperty.call(permission, "TransactionSend")) {
+    return new TariPermissionTransactionSend(permission.TransactionSend);
+  } else if (permission === "TransactionGet") {
+    return new TariPermissionTransactionGet();
+  } else if (Object.prototype.hasOwnProperty.call(permission, "GetNft")) {
+    return new TariPermissionGetNft(permission.GetNft);
+  } else if (Object.prototype.hasOwnProperty.call(permission, "NftGetOwnershipProof")) {
+    return new TariPermissionNftGetOwnershipProof(permission.NftGetOwnershipProof);
+  }
+  return permission;
+}

package/packages/tari_permissions/src/index.ts

@@ -1 +1,2 @@
-export * from './tari_permissions';
+export * from "./tari_permissions";
+export * from "./helpers";

package/packages/tari_permissions/src/tari_permissions.ts

@@ -26,11 +26,10 @@ export class Tagged {
     this.value = value;
   }
   toJSON() {
-    return { "@@TAGGED@@": [this.tag, this.value] }
+    return { "@@TAGGED@@": [this.tag, this.value] };
   }
 }
 
-
 export class ResourceAddress {
   private tagged: Tagged;
   constructor(hash: Hash) {
@@ -72,12 +71,12 @@ export class NonFungibleId {
   }
   toJSON() {
     switch (typeof this.value) {
-      case 'string':
-        return { 'string': this.value };
-      case 'number':
-        return { 'Uint64': this.value };
+      case "string":
+        return { string: this.value };
+      case "number":
+        return { Uint64: this.value };
     }
-    return { 'U256': this.value };
+    return { U256: this.value };
   }
 }
 
@@ -89,14 +88,14 @@ export class NonFungibleAddressContents {
     this.id = id;
   }
   toJSON() {
-    return { "resource_address": this.resource_address, "id": this.id }
+    return { resource_address: this.resource_address, id: this.id };
   }
 }
 
 export class NonFungibleAddress {
   private tagged: Tagged;
   constructor(value: NonFungibleAddressContents) {
-    this.tagged = new Tagged(TAG.NonFungibleAddress, value)
+    this.tagged = new Tagged(TAG.NonFungibleAddress, value);
   }
   toJSON() {
     return this.tagged.toJSON();
@@ -111,7 +110,7 @@ export class NonFungibleIndexAddress {
     this.index = index;
   }
   toJSON() {
-    return { "resource_address": this.resource_address, "index": this.index }
+    return { resource_address: this.resource_address, index: this.index };
   }
 }
 
@@ -121,7 +120,7 @@ export class ComponentAddress {
     this.tagged = new Tagged(TAG.ComponentAddress, hash);
   }
   toJSON() {
-    return this.tagged.toJSON()
+    return this.tagged.toJSON();
   }
 }
 
@@ -131,12 +130,17 @@ export class VaultId {
     this.tagged = new Tagged(TAG.VaultId, hash);
   }
   toJSON() {
-    return this.tagged.toJSON()
+    return this.tagged.toJSON();
   }
 }
 
-export type SubstateAddressType = ResourceAddress | ComponentAddress | VaultId | UnclaimedConfidentialOutputAddress | NonFungibleAddress | NonFungibleIndexAddress;
-
+export type SubstateAddressType =
+  | ResourceAddress
+  | ComponentAddress
+  | VaultId
+  | UnclaimedConfidentialOutputAddress
+  | NonFungibleAddress
+  | NonFungibleIndexAddress;
 
 export class SubstateAddress {
   private value: SubstateAddressType;
@@ -145,19 +149,19 @@ export class SubstateAddress {
   }
   toJSON() {
     if (this.value instanceof ComponentAddress) {
-      return { "Component": this.value }
+      return { Component: this.value };
     } else if (this.value instanceof ResourceAddress) {
-      return { "Resource": this.value }
+      return { Resource: this.value };
     } else if (this.value instanceof VaultId) {
-      return { "Vault": this.value }
+      return { Vault: this.value };
     } else if (this.value instanceof UnclaimedConfidentialOutputAddress) {
-      return { "UnclaimedConfidentialOutput": this.value }
+      return { UnclaimedConfidentialOutput: this.value };
     } else if (this.value instanceof NonFungibleAddress) {
-      return { "NonFungible": this.value }
+      return { NonFungible: this.value };
     } else if (this.value instanceof NonFungibleIndexAddress) {
-      return { "NonFungibleIndex": this.value }
+      return { NonFungibleIndex: this.value };
     }
-    throw "Unknown type"
+    throw "Unknown type";
   }
 }
 
@@ -167,15 +171,15 @@ export class TariPermissionAccountBalance {
     this.value = value;
   }
   toJSON() {
-    console.log("stringify", this.value)
-    return { "AccountBalance": this.value }
+    console.log("stringify", this.value);
+    return { AccountBalance: this.value };
   }
 }
 
 export class TariPermissionAccountInfo {
   constructor() {}
   toJSON() {
-    return "AccountInfo"
+    return "AccountInfo";
   }
 }
 
@@ -189,11 +193,11 @@ export class TariPermissionAccountList {
     }
   }
   toJSON() {
-    console.log('JSON TariPermissionAccountList', this.value)
+    console.log("JSON TariPermissionAccountList", this.value);
     if (this.value === undefined) {
-      return { "AccountList": null }
+      return { AccountList: null };
     } else {
-      return { "AccountList": this.value }
+      return { AccountList: this.value };
     }
   }
 }
@@ -201,14 +205,14 @@ export class TariPermissionAccountList {
 export class TariPermissionKeyList {
   constructor() {}
   toJSON() {
-    return "KeyList"
+    return "KeyList";
   }
 }
 
 export class TariPermissionTransactionGet {
   constructor() {}
   toJSON() {
-    return "TransactionGet"
+    return "TransactionGet";
   }
 }
 export class TariPermissionTransactionSend {
@@ -217,11 +221,11 @@ export class TariPermissionTransactionSend {
     this.value = value;
   }
   toJSON() {
-    console.log('JSON TariPermissionTransactionSend', this.value)
+    console.log("JSON TariPermissionTransactionSend", this.value);
     if (this.value === undefined) {
-      return { "TransactionSend": null }
+      return { TransactionSend: null };
     } else {
-      return { "TransactionSend": this.value }
+      return { TransactionSend: this.value };
     }
   }
 }
@@ -234,7 +238,7 @@ export class TariPermissionGetNft {
     this.value1 = value1;
   }
   toJSON() {
-    return { "GetNft": [this.value0, this.value1] }
+    return { GetNft: [this.value0, this.value1] };
   }
 }
 
@@ -244,32 +248,44 @@ export class TariPermissionNftGetOwnershipProof {
     this.value = value;
   }
   toJSON() {
-    return { "NftGetOwnershipProof": this.value }
+    return { NftGetOwnershipProof: this.value };
   }
 }
 
 export class TariPermissionTransactionsGet {
   constructor() {}
   toJSON() {
-    return "TransactionGet"
+    return "TransactionGet";
   }
 }
 
 export class TariPermissionSubstatesRead {
   constructor() {}
   toJSON() {
-    return "SubstatesRead"
+    return "SubstatesRead";
   }
 }
 
 export class TariPermissionTemplatesRead {
   constructor() {}
   toJSON() {
-    return "TemplatesRead"
+    return "TemplatesRead";
   }
 }
 
-export type TariPermission = TariPermissionNftGetOwnershipProof | TariPermissionAccountBalance | TariPermissionAccountInfo | TariPermissionAccountList | TariPermissionKeyList | TariPermissionTransactionGet | TariPermissionTransactionSend | TariPermissionGetNft | TariPermissionTransactionsGet | TariPermissionSubstatesRead | TariPermissionTemplatesRead | string;
+export type TariPermission =
+  | TariPermissionNftGetOwnershipProof
+  | TariPermissionAccountBalance
+  | TariPermissionAccountInfo
+  | TariPermissionAccountList
+  | TariPermissionKeyList
+  | TariPermissionTransactionGet
+  | TariPermissionTransactionSend
+  | TariPermissionGetNft
+  | TariPermissionTransactionsGet
+  | TariPermissionSubstatesRead
+  | TariPermissionTemplatesRead
+  | string;
 
 // export enum TariPermission {
 //   AccountBalance = "AccountBalance",
@@ -289,7 +305,7 @@ export class TariPermissions {
   private permissions: TariPermission[];
 
   constructor() {
-    this.permissions = []
+    this.permissions = [];
   }
 
   addPermission(permission: TariPermission): this {
@@ -307,6 +323,7 @@ export class TariPermissions {
   }
 }
 
-// TariPermissionType.prototype.toString = function () {
-//   return "wtf"
-// }
+export type TappletPermissions = {
+  requiredPermissions: TariPermission[];
+  optionalPermissions: TariPermission[];
+};

package/packages/tari_provider/package.json

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

package/packages/tari_provider/src/TariProvider.ts

@@ -1,34 +1,19 @@
-import type { SubstateType } from "@tari-project/typescript-bindings";
+import type { ListTemplatesResponse } from "@tari-project/typescript-bindings";
 import {
-  Account,
-  SubmitTransactionRequest,
   TransactionResult,
-  SubmitTransactionResponse,
-  VaultBalances,
   TemplateDefinition,
   Substate,
   ListSubstatesResponse,
+  GetSubstateRequest,
+  ListSubstatesRequest,
 } from "./types";
 
 export interface TariProvider {
   providerName: string;
   isConnected(): boolean;
-  getAccount(): Promise<Account>;
-  getSubstate(substate_address: string): Promise<Substate>;
-  submitTransaction(req: SubmitTransactionRequest): Promise<SubmitTransactionResponse>;
+  getSubstate(req: GetSubstateRequest): Promise<Substate>;
   getTransactionResult(transactionId: string): Promise<TransactionResult>;
   getTemplateDefinition(template_address: string): Promise<TemplateDefinition>;
-  getPublicKey(branch: string, index: number): Promise<string>;
-  getConfidentialVaultBalances(
-    viewKeyId: number,
-    vaultId: string,
-    min: number | null,
-    max: number | null,
-  ): Promise<VaultBalances>;
-  listSubstates(
-    filter_by_template: string | null,
-    filter_by_type: SubstateType | null,
-    limit: number | null,
-    offset: number | null,
-  ): Promise<ListSubstatesResponse>;
+  listSubstates(req: ListSubstatesRequest): Promise<ListSubstatesResponse>;
+  listTemplates(limit?: number): Promise<ListTemplatesResponse>;
 }

package/packages/tari_provider/src/index.ts

@@ -1,3 +1,2 @@
 export * from "./types";
-
-export { TariProvider } from "./TariProvider";
+export { TariProvider } from "./TariProvider";

package/packages/tari_provider/src/types.ts

@@ -1,4 +1,4 @@
-import { FinalizeResult } from "@tari-project/typescript-bindings";
+import { FinalizeResult, SubstateType } from "@tari-project/typescript-bindings";
 
 export type SubstateMetadata = {
   substate_id: string;
@@ -12,25 +12,6 @@ export type SubstateRequirement = {
   version?: number | null;
 };
 
-export type SubmitTransactionRequest = {
-  network: number;
-  account_id: number;
-  instructions: object[];
-  fee_instructions: object[];
-  inputs: object[];
-  input_refs: object[];
-  required_substates: SubstateRequirement[];
-  is_dry_run: boolean;
-  min_epoch: number | null;
-  max_epoch: number | null;
-  is_seal_signer_authorized: boolean;
-  detect_inputs_use_unversioned: boolean;
-};
-
-export type SubmitTransactionResponse = {
-  transaction_id: string;
-};
-
 export type TransactionResult = {
   transaction_id: string;
   status: TransactionStatus;
@@ -71,6 +52,41 @@ export interface TemplateDefinition {
   [key: string]: any;
 }
 
+export type SubmitTransactionRequest = {
+  network: number;
+  account_id: number;
+  instructions: object[];
+  fee_instructions: object[];
+  inputs: object[];
+  input_refs: object[];
+  required_substates: SubstateRequirement[];
+  is_dry_run: boolean;
+  min_epoch: number | null;
+  max_epoch: number | null;
+  is_seal_signer_authorized: boolean;
+  detect_inputs_use_unversioned: boolean;
+};
+
+export type SubmitTransactionResponse = {
+  transaction_id: string;
+};
+
+export type ListSubstatesRequest = {
+  filter_by_template: string | null;
+  filter_by_type: SubstateType | null;
+  limit: number | null;
+  offset: number | null;
+};
+
+export type ListSubstatesResponse = {
+  substates: Array<SubstateMetadata>;
+};
+
+export type GetSubstateRequest = {
+  substate_address: string;
+  version: number | null;
+};
+
 export interface Substate {
   value: any;
   address: {
@@ -78,7 +94,3 @@ export interface Substate {
     version: number;
   };
 }
-
-export type ListSubstatesResponse = {
-  substates: Array<SubstateMetadata>;
-};