@azguardwallet/types 0.3.1 → 0.4.0

package/README.md

@@ -30,6 +30,7 @@ import type {
     CallAction,
     FailedResult,
     OkResult,
+    SendTransactionResult,
 } from "@azguardwallet/types";
 
 if (!window.azguard) {
@@ -58,11 +59,11 @@ const [result] = await azguard.request("execute", {
     ],
 });
 
-if (result.kind === "ok") {
-    const txHash = (result as OkResult<string>).result;
+if (result.status === "ok") {
+    const txHash = (result as OkResult<SendTransactionResult>).result;
     // ...
 }
-else if (result.kind === "failed") {
+else if (result.status === "failed") {
     const error = (result as FailedResult).error;
     // ...
 }

package/dist/operation.d.ts

@@ -2,22 +2,11 @@ import { Action, CallAction, EncodedCallAction } from "./action";
 import { Result } from "./result";
 import { CaipAccount, CaipChain } from "./dapp-session";
 /** Operation kind */
-export type OperationKind = "add_note" | "get_complete_address" | "register_contract" | "register_sender" | "send_transaction" | "simulate_transaction" | "simulate_unconstrained" | "simulate_views";
+export type OperationKind = "add_note" | "get_complete_address" | "register_contract" | "register_sender" | "send_transaction" | "simulate_transaction" | "simulate_utility" | "simulate_views";
 /** A request to perform some operation */
-export type Operation = AddNoteOperation | GetCompleteAddressOperation | RegisterContractOperation | RegisterSenderOperation | SendTransactionOperation | SimulateTransactionOperation | SimulateUnconstrainedOperation | SimulateViewsOperation;
+export type Operation = GetCompleteAddressOperation | RegisterContractOperation | RegisterSenderOperation | SendTransactionOperation | SimulateTransactionOperation | SimulateUtilityOperation | SimulateViewsOperation;
 /** Operation result */
-export type OperationResult = AddNoteResult | GetCompleteAddressResult | RegisterContractResult | RegisterSenderResult | SendTransactionResult | SimulateTransactionResult | SimulateUnconstrainedResult | SimulateViewsResult;
-/** A request to add a note to PXE */
-export type AddNoteOperation = {
-    /** Operation kind */
-    kind: "add_note";
-    /** Account to add the note for */
-    account: CaipAccount;
-    /** Note to add (ExtendedNote) */
-    note: unknown;
-};
-/** A result of the "add_note" operation */
-export type AddNoteResult = Result<void>;
+export type OperationResult = Result<GetCompleteAddressResult> | Result<RegisterContractResult> | Result<RegisterSenderResult> | Result<SendTransactionResult> | Result<SimulateTransactionResult> | Result<SimulateUtilityResult> | Result<SimulateViewsResult>;
 /** A request to get complete address of the specified account */
 export type GetCompleteAddressOperation = {
     /** Operation kind */
@@ -26,7 +15,7 @@ export type GetCompleteAddressOperation = {
     account: CaipAccount;
 };
 /** A result of the "get_complete_address" operation (CompleteAddress) */
-export type GetCompleteAddressResult = Result<unknown>;
+export type GetCompleteAddressResult = unknown;
 /** A request to register contract in PXE */
 export type RegisterContractOperation = {
     /** Operation kind */
@@ -47,7 +36,7 @@ export type RegisterContractOperation = {
     artifact?: unknown;
 };
 /** A result of the "register_contract" operation */
-export type RegisterContractResult = Result<void>;
+export type RegisterContractResult = void;
 /** A request to register sender in PXE */
 export type RegisterSenderOperation = {
     /** Operation kind */
@@ -58,7 +47,7 @@ export type RegisterSenderOperation = {
     address: string;
 };
 /** A result of the "register_sender" operation */
-export type RegisterSenderResult = Result<void>;
+export type RegisterSenderResult = void;
 /** A request to send the transaction */
 export type SendTransactionOperation = {
     /** Operation kind */
@@ -77,7 +66,7 @@ export type SendTransactionOperation = {
     setup?: Action[];
 };
 /** A result of the "send_transaction" operation (TxHash) */
-export type SendTransactionResult = Result<string>;
+export type SendTransactionResult = string;
 /** A request to simulate the transaction */
 export type SimulateTransactionOperation = {
     /** Operation kind */
@@ -97,8 +86,8 @@ export type SimulateTransactionOperation = {
     /** Whether to also simulate enqueued public calls or not */
     simulatePublic?: boolean;
 };
-/** Wrapped simulation results */
-export type SimulationReturn = {
+/** A result of the "simulate_transaction" operation */
+export type SimulateTransactionResult = {
     /** Gas usage info (GasUsed) */
     gasUsed: unknown;
     /** Private return values (NestedProcessReturnValues) */
@@ -106,12 +95,10 @@ export type SimulationReturn = {
     /** Public return values (NestedProcessReturnValues[]) */
     publicReturn: unknown[];
 };
-/** A result of the "simulate_transaction" operation */
-export type SimulateTransactionResult = Result<SimulationReturn>;
-/** A request to simulate the unconstrained function */
-export type SimulateUnconstrainedOperation = {
+/** A request to simulate the utility function */
+export type SimulateUtilityOperation = {
     /** Operation kind */
-    kind: "simulate_unconstrained";
+    kind: "simulate_utility";
     /** Address of the account to simulate for */
     account: CaipAccount;
     /** Address of the contract (AztecAddress) */
@@ -121,8 +108,8 @@ export type SimulateUnconstrainedOperation = {
     /** Arguments (unencoded) */
     args: any[];
 };
-/** A result of the "simulate_unconstrained" operation (AbiDecoded) */
-export type SimulateUnconstrainedResult = Result<unknown>;
+/** A result of the "simulate_utility" operation (AbiDecoded) */
+export type SimulateUtilityResult = unknown;
 /** A request to simulate the batch of view calls */
 export type SimulateViewsOperation = {
     /** Operation kind */
@@ -132,12 +119,10 @@ export type SimulateViewsOperation = {
     /** Batch of view calls to simulate */
     calls: (CallAction | EncodedCallAction)[];
 };
-/** Wrapped views simulation results */
-export type ViewsSimulationResult = {
+/** A result of the "simulate_views" operation */
+export type SimulateViewsResult = {
     /** List of results, encoded with function return types ABI (Fr[][]) */
     encoded: string[][];
     /** List of results, decoded with function return types ABI (AbiDecoded[]) */
     decoded: unknown[];
 };
-/** A result of the "simulate_views" operation */
-export type SimulateViewsResult = Result<ViewsSimulationResult>;

package/dist/result.d.ts

@@ -2,15 +2,15 @@
 export type Result<T> = OkResult<T> | FailedResult | SkippedResult;
 /** Successful result, containing returned value */
 export type OkResult<T> = {
-    /** Result kind */
-    kind: "ok";
+    /** Result status */
+    status: "ok";
     /** Returned value */
     result: T;
 };
 /** Failed result, containing error message */
 export type FailedResult = {
-    /** Result kind */
-    kind: "failed";
+    /** Result status */
+    status: "failed";
     /** Returned error */
     error: string;
 };
@@ -19,6 +19,6 @@ export type FailedResult = {
  * due to one of the previous operations in the same batch failed
  * */
 export type SkippedResult = {
-    /** Result kind */
-    kind: "skipped";
+    /** Result status */
+    status: "skipped";
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@azguardwallet/types",
-    "version": "0.3.1",
+    "version": "0.4.0",
     "description": "Typings for Azguard Wallet inpage RPC client",
     "author": "Azguard Wallet",
     "homepage": "https://github.com/AzguardWallet/azguard-wallet-types",