salt-sdk 0.0.8 → 0.0.10

package/README.md

@@ -1,84 +1,46 @@
-# Salt SDK
+# Salt SDK [![NPM Version](https://img.shields.io/npm/v/salt-sdk)]()
 
-## Prerequesites
+TypeScript client for [Salt](https://salt.space), an open MPC self-custodial infrastructure for organisations. With Salt, anyone can spin up a system of self-sovereignty for self-custodial wealth management, including delegations to 3rd parties such as asset managers, robo-advisors or agents.
 
-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.
+## Documentation
 
-## Usage
+### [📃 developer.salt.space/sdk](https://developer.salt.space/sdk/classes/Salt.html)
 
-```typescript
-import { Salt } from 'salt-sdk';
-import { ethers } from 'ethers';
+You will need an existing Salt organisation to make use of the SDK. Visit [https://testnet.salt.space](https://testnet.salt.space) to set up a test account.
 
-//  ARBITRUM SEPOLIA RPC in TESTNET or ARBITRUM ONE RPC in mainnet
-const orchestration_network_provider =
-  new ethers.providers.StaticJsonRpcProvider({
-    url: '',
-    skipFetchSetup: true,
-  });
-// EVM NETWORK RPC WHERE YOU WISH TO BROADCAST
-const broadcasting_network_provider =
-  new ethers.providers.StaticJsonRpcProvider({
-    url: '',
-    skipFetchSetup: true,
-  });
+## Example
 
-const wallet = new ethers.Wallet('');
+```typescript
+import { Salt, TransferType } from 'salt-sdk';
+import { Wallet } from 'ethers';
 
-const signer = wallet.connect(orchestration_network_provider);
+// Create an instance of Salt SDK - https://developer.salt.space/sdk/classes/Salt.html#constructor
+const salt = new Salt({
+  environment: 'TESTNET',
+});
 
-const sdk = new Salt({ environment: 'TESTNET' });
-await sdk.authenticate(signer);
+// Substitute this with a proper signer creation
+const signer = Wallet.createRandom();
 
-const orgs = await sdk.getOrganisations();
-const accounts = await sdk.getAccounts(orgs[0]._id);
+// Authenticate with SIWE - https://developer.salt.space/sdk/classes/Salt.html#authenticate
+await salt.authenticate(signer);
 
-const transactionObj = await sdk.transfer({
-  accountId: accounts[0].id,
-  to: '0xaD94c511350Cced6DcffCcC34D36558Db86a42A8',
-  value: '0.0001',
-  chainId: broadcasting_network_provider.network.chainId,
-  decimals: 18,
+// Transfer funds - https://developer.salt.space/sdk/classes/Salt.html#transfer
+await salt.transfer({
   type: TransferType.Native,
+  accountId: '0123456', // Salt account ID - https://developer.salt.space/classes/Salt.html#getAccounts
+  to: '0x000000000000000000000000000000000000dEaD',
+  value: '1',
+  decimals: 18,
+  chainId: 1,
   signer: signer,
-  sendingProvider: broadcasting_network_provider,
 });
-
-//subscribe to state transition events
-
-transactionObj.onPropose((data) => console.log(data));
-transactionObj.onSign((data) => console.log(data));
-transactionObj.onCombine((data) => console.log(data));
-transactionObj.onBroadcast((data) => console.log(data));
-transactionObj.onEnd((data) => console.log(data));
-transactionObj.onTransition(4, 5, (data) =>
-  console.log('BROADCAST->END:', data)
-);
 ```
 
-## Transfer State Machine
+Examples and a full list of available functionality are available at **[https://developer.salt.space/sdk](https://developer.salt.space/sdk/index.html)**.
 
-```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] --> [*]
-```
+# Development
 
-## Notes
+See [ARCHITECTURE.md](./ARCHITECTURE.md) for more details.
 
-As of now the SDK is only available to use on TESTNETS via our testnet environment https://testnet.salt.space.
+![NPM Type Definitions](https://img.shields.io/npm/types/salt-sdk)

package/dist/{browser-qqJ1fujK.js → browser-Cw1djZTy.js}

@@ -1,4 +1,4 @@
-import { g as getDefaultExportFromCjs } from "./index-YvEK7vYp.js";
+import { g as getDefaultExportFromCjs } from "./index-C8WXLf_Q.js";
 function _mergeNamespaces(n, m) {
   for (var i = 0; i < m.length; i++) {
     const e = m[i];

package/dist/{ccip-BBUN2eEu.js → ccip-HHFnB-BQ.js}

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