salt-sdk 0.0.2 → 0.0.4

package/README.md

@@ -1,5 +1,9 @@
 # Salt SDK
 
+## Prerequesites
+
+We currently do not support account creation via the sdk. In order to use the sdk please visit https://testnet.salt.space. Once you're on Salt please create or join an Organisation and create an account.
+
 ## Usage
 
 ```typescript
@@ -40,17 +44,39 @@ const transfer = await sdk.transfer({
   sendingProvider: broadcasting_network_provider,
 });
 
-//event listeners
+//subscribe to state transition events
 
 transfer.onTransition(0, 1, (data) => console.log('IDLE->PROPOSE:', data));
 transfer.onTransition(1, 2, (data) => console.log('PROPOSE->SIGN:', data));
-
-// in case of policy breach
 transfer.onTransition(2, 5, (data) => console.log('SIGN->END:', data));
-
 transfer.onTransition(2, 3, (data) => console.log('SIGN->COMBINE:', data));
 transfer.onTransition(3, 4, (data) => console.log('COMBINE->BROADCAST:', data));
-
-//transaction hash in the data
 transfer.onTransition(4, 5, (data) => console.log('BROADCAST->END:', data));
 ```
+
+## Transfer State Machine
+
+```mermaid
+stateDiagram-v2
+    [*] --> IDLE[0]
+
+    IDLE[0] --> PROPOSE[1] : Start Transfer
+    IDLE[0] --> END[5] : Error Starting Transfer
+
+    PROPOSE[1] --> SIGN[2] : Proposal Created
+    PROPOSE[1] --> END[5] : Policy Breach
+
+    SIGN[2] --> COMBINE[3] : collected_signatures >= signature_threshold
+    SIGN[2] --> END[5] : Error Signing
+
+    COMBINE[3] --> BROADCAST[4] : Signatures Combined
+    COMBINE[3] --> END[5] : Error Combining
+
+    BROADCAST[4] --> END[5] : Transaction Broadcasted
+
+    END[5] --> [*]
+```
+
+## Notes
+
+As of now the SDK is only available to use on TESTNETS via our testnet environment https://testnet.salt.space.

package/dist/{ccip-BghU8qQS.js → ccip-nMOI806K.js}

@@ -1,4 +1,4 @@
-import { B as BaseError, g as getUrl, s as stringify, d as decodeErrorResult, i as isAddressEqual, l as localBatchGatewayUrl, a as localBatchGatewayRequest, c as call, b as concat, e as encodeAbiParameters, H as HttpRequestError, f as isHex } from "./index-DHF1u4T7.js";
+import { B as BaseError, g as getUrl, s as stringify, d as decodeErrorResult, i as isAddressEqual, l as localBatchGatewayUrl, a as localBatchGatewayRequest, c as call, b as concat, e as encodeAbiParameters, H as HttpRequestError, f as isHex } from "./index-pLKoquxy.js";
 class OffchainLookupError extends BaseError {
   constructor({ callbackSelector, cause, data, extraData, sender, urls }) {
     super(cause.shortMessage || "An error occurred while fetching for an offchain result.", {

package/dist/{index-DHF1u4T7.js → index-pLKoquxy.js}

@@ -30408,7 +30408,7 @@ async function call(client2, args) {
     return { data: response };
   } catch (err) {
     const data2 = getRevertErrorData(err);
-    const { offchainLookup, offchainLookupSignature } = await import("./ccip-BghU8qQS.js");
+    const { offchainLookup, offchainLookupSignature } = await import("./ccip-nMOI806K.js");
     if (client2.ccipRead !== false && data2?.slice(0, 10) === offchainLookupSignature && to)
       return { data: await offchainLookup(client2, { data: data2, to }) };
     if (deploylessCall && data2?.slice(0, 10) === "0x101bb98d")
@@ -73849,6 +73849,49 @@ function requireSiwe() {
   return siwe;
 }
 var siweExports = requireSiwe();
+const SIGNER_COUNTS = {
+  twoHumans: {
+    humanCount: 2,
+    roboCount: 1,
+    totalSigners: 3
+  },
+  threeHumans: {
+    humanCount: 3,
+    roboCount: 2,
+    totalSigners: 5
+  },
+  fourHumans: {
+    humanCount: 4,
+    roboCount: 3,
+    totalSigners: 7
+  }
+};
+Math.min(
+  ...Object.values(SIGNER_COUNTS).map((config) => config.roboCount)
+);
+function getRoboConfigForAccountsize(accountSize) {
+  const robo_count = Object.values(SIGNER_COUNTS).find(
+    (config) => config.totalSigners === accountSize
+  )?.roboCount;
+  if (!robo_count) {
+    throw new Error(
+      `Invalid account size: ${accountSize}. Must be either ${SIGNER_COUNTS.twoHumans.totalSigners}, ${SIGNER_COUNTS.threeHumans.totalSigners} or ${SIGNER_COUNTS.fourHumans.totalSigners}`
+    );
+  }
+  return robo_count;
+}
+class SocketConnectError extends Error {
+  cause;
+  constructor(message, originalError) {
+    super(message);
+    this.name = "SocketConnectError";
+    this.cause = originalError;
+    if (originalError?.stack) {
+      this.stack = `${this.stack}
+Caused by: ${originalError.stack}`;
+    }
+  }
+}
 class InvalidTransitionError extends Error {
   cause;
   constructor(message, originalError) {
@@ -73878,6 +73921,15 @@ async function signTransaction(txId, params) {
     throw new Error("Invalid sign result");
   }
 }
+var TRANSFER_STATES = /* @__PURE__ */ ((TRANSFER_STATES2) => {
+  TRANSFER_STATES2[TRANSFER_STATES2["IDLE"] = 0] = "IDLE";
+  TRANSFER_STATES2[TRANSFER_STATES2["PROPOSE"] = 1] = "PROPOSE";
+  TRANSFER_STATES2[TRANSFER_STATES2["SIGN"] = 2] = "SIGN";
+  TRANSFER_STATES2[TRANSFER_STATES2["COMBINE"] = 3] = "COMBINE";
+  TRANSFER_STATES2[TRANSFER_STATES2["BROADCAST"] = 4] = "BROADCAST";
+  TRANSFER_STATES2[TRANSFER_STATES2["END"] = 5] = "END";
+  return TRANSFER_STATES2;
+})(TRANSFER_STATES || {});
 const validTransitions = {
   [
     0
@@ -74165,49 +74217,6 @@ class Transfer {
     return true;
   }
 }
-const SIGNER_COUNTS = {
-  twoHumans: {
-    humanCount: 2,
-    roboCount: 1,
-    totalSigners: 3
-  },
-  threeHumans: {
-    humanCount: 3,
-    roboCount: 2,
-    totalSigners: 5
-  },
-  fourHumans: {
-    humanCount: 4,
-    roboCount: 3,
-    totalSigners: 7
-  }
-};
-Math.min(
-  ...Object.values(SIGNER_COUNTS).map((config) => config.roboCount)
-);
-function getRoboConfigForAccountsize(accountSize) {
-  const robo_count = Object.values(SIGNER_COUNTS).find(
-    (config) => config.totalSigners === accountSize
-  )?.roboCount;
-  if (!robo_count) {
-    throw new Error(
-      `Invalid account size: ${accountSize}. Must be either ${SIGNER_COUNTS.twoHumans.totalSigners}, ${SIGNER_COUNTS.threeHumans.totalSigners} or ${SIGNER_COUNTS.fourHumans.totalSigners}`
-    );
-  }
-  return robo_count;
-}
-class SocketConnectError extends Error {
-  cause;
-  constructor(message, originalError) {
-    super(message);
-    this.name = "SocketConnectError";
-    this.cause = originalError;
-    if (originalError?.stack) {
-      this.stack = `${this.stack}
-Caused by: ${originalError.stack}`;
-    }
-  }
-}
 if (typeof window !== "undefined") {
   window.process = {
     env: {
@@ -74394,15 +74403,18 @@ class Salt {
   }
 }
 export {
-  InvalidProvider as A,
+  assertValidValue as A,
   BaseError$1 as B,
-  assertValidProvider as C,
-  InvalidSigner as D,
-  assertValidSigner as E,
-  assertCorrectChain as F,
-  InsufficientGas as G,
+  InvalidParams as C,
+  assertValidParams as D,
+  InvalidProvider as E,
+  assertValidProvider as F,
+  InvalidSigner as G,
   HttpRequestError as H,
   InvalidAuthToken as I,
+  assertValidSigner as J,
+  assertCorrectChain as K,
+  InsufficientGas as L,
   Salt as S,
   TransferType as T,
   ValidationError as V,
@@ -74419,18 +74431,18 @@ export {
   InvalidAddress as j,
   InvalidValue as k,
   localBatchGatewayUrl as l,
-  assertValidAddress as m,
-  InvalidUrl as n,
-  assertValidUrl as o,
+  Transfer as m,
+  TRANSFER_STATES as n,
+  assertValidAddress as o,
   process as p,
-  assertValidUrlNoTrailingSlash as q,
-  InvalidEnvironment as r,
+  InvalidUrl as q,
+  assertValidUrl as r,
   stringify$2 as s,
-  assertValidEnvironment as t,
-  assertHasAuthToken as u,
-  assertValidAuthToken as v,
-  assertValidChain as w,
-  assertValidValue as x,
-  InvalidParams as y,
-  assertValidParams as z
+  assertValidUrlNoTrailingSlash as t,
+  InvalidEnvironment as u,
+  validTransitions as v,
+  assertValidEnvironment as w,
+  assertHasAuthToken as x,
+  assertValidAuthToken as y,
+  assertValidChain as z
 };

package/dist/index.d.ts

@@ -644,6 +644,14 @@ declare interface SignTxResponse {
     locked?: boolean;
 }
 
+export declare type STATE_TRANSITIONS = {
+    [TRANSFER_STATES.PROPOSE]: TRANSFER_STATES.SIGN | TRANSFER_STATES.END;
+    [TRANSFER_STATES.SIGN]: TRANSFER_STATES.COMBINE | TRANSFER_STATES.END;
+    [TRANSFER_STATES.COMBINE]: TRANSFER_STATES.BROADCAST | TRANSFER_STATES.END;
+    [TRANSFER_STATES.BROADCAST]: TRANSFER_STATES.END;
+    [TRANSFER_STATES.END]: never;
+};
+
 declare type StateTransitionHandler = (data: TransitionData) => void | Promise<void>;
 
 declare interface SubmitTransactionResult {
@@ -781,7 +789,7 @@ export declare interface TransactionParams {
     vaultPublicKey: string;
 }
 
-declare class Transfer {
+export declare class Transfer {
     /**
      * The authentication token for the Salt SDK. See {@link authenticate} for the full authentication flow,
      * or {@link setAuthToken} to set a pre-existing token.
@@ -854,7 +862,7 @@ declare class Transfer {
     submitTransaction(): Promise<boolean>;
 }
 
-declare enum TRANSFER_STATES {
+export declare enum TRANSFER_STATES {
     IDLE = 0,
     PROPOSE = 1,
     SIGN = 2,
@@ -880,6 +888,8 @@ export declare class ValidationError extends Error {
     constructor(message: string, originalError?: Error);
 }
 
+export declare const validTransitions: Record<TRANSFER_STATES, TRANSFER_STATES[]>;
+
 export declare class WrongChain extends Error {
     readonly cause?: Error;
     constructor(message: string, originalError?: Error);

package/dist/salt.es.js

@@ -1,30 +1,33 @@
-import { G, j, I, h, r, y, A, D, n, k, S, T, V, W, F, u, m, v, w, t, z, C, E, o, q, x, p } from "./index-DHF1u4T7.js";
+import { L, j, I, h, u, C, E, G, q, k, S, n, m, T, V, W, K, x, o, y, z, w, D, F, J, r, t, A, p, v } from "./index-pLKoquxy.js";
 export {
-  G as InsufficientGas,
+  L as InsufficientGas,
   j as InvalidAddress,
   I as InvalidAuthToken,
   h as InvalidChain,
-  r as InvalidEnvironment,
-  y as InvalidParams,
-  A as InvalidProvider,
-  D as InvalidSigner,
-  n as InvalidUrl,
+  u as InvalidEnvironment,
+  C as InvalidParams,
+  E as InvalidProvider,
+  G as InvalidSigner,
+  q as InvalidUrl,
   k as InvalidValue,
   S as Salt,
+  n as TRANSFER_STATES,
+  m as Transfer,
   T as TransferType,
   V as ValidationError,
   W as WrongChain,
-  F as assertCorrectChain,
-  u as assertHasAuthToken,
-  m as assertValidAddress,
-  v as assertValidAuthToken,
-  w as assertValidChain,
-  t as assertValidEnvironment,
-  z as assertValidParams,
-  C as assertValidProvider,
-  E as assertValidSigner,
-  o as assertValidUrl,
-  q as assertValidUrlNoTrailingSlash,
-  x as assertValidValue,
-  p as process
+  K as assertCorrectChain,
+  x as assertHasAuthToken,
+  o as assertValidAddress,
+  y as assertValidAuthToken,
+  z as assertValidChain,
+  w as assertValidEnvironment,
+  D as assertValidParams,
+  F as assertValidProvider,
+  J as assertValidSigner,
+  r as assertValidUrl,
+  t as assertValidUrlNoTrailingSlash,
+  A as assertValidValue,
+  p as process,
+  v as validTransitions
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "salt-sdk",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "SDK for interacting with Salt's MPC self custody & treasury",
   "author": "Salt",
   "homepace": {