@fastxyz/allset-sdk 0.1.1 → 0.1.2

package/README.md

@@ -1,111 +1,78 @@
 # AllSet SDK
 
-Official TypeScript SDK for the AllSet bridge. Bridge tokens between Fast network and supported EVM routes, with the current branch focused on Arbitrum Sepolia and Fast testnet flows.
+Bridge tokens between Fast network and EVM chains.
 
-## Install
+## Installation
 
 ```bash
-npm install @fastxyz/allset-sdk
+npm install @fastxyz/sdk @fastxyz/allset-sdk
 ```
 
 ## Quick Start
 
-### Deposit (EVM → Fast)
-
 ```ts
-import { createEvmExecutor, allsetProvider } from '@fastxyz/allset-sdk';
-
-const evmExecutor = createEvmExecutor(
-  process.env.EVM_PRIVATE_KEY!,
-  'https://sepolia-rollup.arbitrum.io/rpc',
-  421614
-);
-
-const result = await allsetProvider.bridge({
-  fromChain: 'arbitrum',
-  toChain: 'fast',
-  fromToken: 'USDC',
-  toToken: 'fastUSDC',
-  fromDecimals: 6,
-  amount: '1000000', // 1 USDC (6 decimals)
-  senderAddress: '0xYourEvmAddress',
-  receiverAddress: 'fast1yourfastaddress',
+import { FastProvider, FastWallet } from '@fastxyz/sdk';
+import { AllSetProvider, createEvmExecutor, createEvmWallet } from '@fastxyz/allset-sdk';
+
+// Setup
+const fastProvider = new FastProvider({ network: 'testnet' });
+const allset = new AllSetProvider({ network: 'testnet' });
+const fastWallet = await FastWallet.fromKeyfile('~/.fast/keys/default.json', fastProvider);
+const evmWallet = createEvmWallet('~/.allset/.evm/keys/default.json');
+
+// Deposit: EVM → Fast
+const evmExecutor = createEvmExecutor(evmWallet.privateKey, 'https://sepolia-rollup.arbitrum.io/rpc', 421614);
+await allset.sendToFast({
+  chain: 'arbitrum',
+  token: 'USDC',
+  amount: '1000000',
+  from: evmWallet.address,
+  to: fastWallet.address,
   evmExecutor,
 });
 
-console.log(result.txHash);
-```
-
-### Withdraw (Fast → EVM)
-
-```ts
-import { createFastWallet } from '@fastxyz/allset-sdk';
-
-const wallet = createFastWallet();
-console.log(wallet.address);
-// Persist wallet.privateKey and wallet.publicKey securely.
+// Withdraw: Fast → EVM
+await allset.sendToExternal({
+  chain: 'arbitrum',
+  token: 'fastUSDC',
+  amount: '1000000',
+  from: fastWallet.address,
+  to: evmWallet.address,
+  fastWallet,
+});
 ```
 
-Store that keypair securely, then use it with `createFastClient()`:
+## Advanced: Custom Intents
 
 ```ts
-import { createFastClient, allsetProvider } from '@fastxyz/allset-sdk';
-
-const fastClient = createFastClient({
-  privateKey: process.env.FAST_PRIVATE_KEY!, // 32-byte hex
-  publicKey: process.env.FAST_PUBLIC_KEY!,   // 32-byte hex
-});
-
-const result = await allsetProvider.bridge({
-  fromChain: 'fast',
-  toChain: 'arbitrum',
-  fromToken: 'fastUSDC',
-  toToken: 'USDC',
-  fromDecimals: 6,
-  amount: '1000000', // 1 USDC (6 decimals)
-  senderAddress: fastClient.address!,
-  receiverAddress: '0xYourEvmAddress',
-  fastClient,
+import { buildTransferIntent, buildExecuteIntent } from '@fastxyz/allset-sdk';
+
+// Execute custom intents on EVM chain
+await allset.executeIntent({
+  chain: 'arbitrum',
+  fastWallet,
+  token: 'fastUSDC',
+  amount: '1000000',
+  intents: [
+    buildTransferIntent(USDC_ADDRESS, '0xRecipient'),
+    // Add more intents: swaps, protocol calls, etc.
+  ],
 });
-
-console.log(result.txHash);
-// { txHash: '0x...', orderId: '0x...', estimatedTime: '1-5 minutes' }
 ```
 
-Best practice: generate the Fast wallet once, store the private/public keys in your secret manager or environment, and pass those stored values into `createFastClient()`. Do not generate a fresh wallet on every app start unless that is explicitly what you want.
-
-## Features
-
-- **Deposit** - Bridge USDC from EVM chains to fastUSDC on Fast
-- **Withdraw** - Bridge fastUSDC from Fast to USDC on EVM chains
-- **EVM Executor** - Built-in viem-based transaction executor
-- **Fast Client** - Built-in Fast network client for withdrawals
-- **Fast Wallet Generator** - Generate a Fast keypair and address without another SDK
+For intents without a transfer recipient or execute target, pass `externalAddress` so the relayer has an explicit EVM target.
 
 ## Supported Networks
 
-Current SDK implementation in this branch:
-
-- Testnet-only bridge flows
-- Arbitrum Sepolia (`421614`) + Fast testnet
-- Token mapping for `USDC` <-> `fastUSDC`
-
-Environment target matrix for AllSet deployments:
-
-- Mainnet: Polygon, Arbitrum, Base with `USDC` -> `fastUSDC`
-- Testnet: Sepolia, Arbitrum Sepolia, Tempo with testnet `USDC` -> `testUSDC`
+| Network | Chain | Status |
+|---------|-------|--------|
+| Testnet | Arbitrum Sepolia | ✅ |
+| Testnet | Ethereum Sepolia | ✅ |
+| Mainnet | Coming soon | 🔜 |
 
 ## Documentation
 
-See [SKILL.md](./SKILL.md) for detailed API documentation and troubleshooting.
-
-## Development
-
-```bash
-npm install
-npm run build
-npm test
-```
+See [SKILL.md](./SKILL.md) for detailed API documentation.
 
 ## License
 

package/data/networks.json

@@ -0,0 +1,37 @@
+{
+  "testnet": {
+    "crossSignUrl": "https://testnet.cross-sign.allset.fast.xyz",
+    "chains": {
+      "ethereum": {
+        "chainId": 11155111,
+        "bridgeContract": "0x96A2a48Eb19144b01a23ec5B52085D848e1344F5",
+        "fastBridgeAddress": "fast1fxtkgpwcy7hnakw96gg7relph4wxx7ghrukm723p3l9adxuxljzsc6f958",
+        "relayerUrl": "https://testnet.allset.fast.xyz/ethereum-sepolia/relayer/relay",
+        "tokens": {
+          "USDC": {
+            "evmAddress": "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238",
+            "fastTokenId": "9c52fe9465f57bc526c11aa0c048fd8709aa46abc06d15c80cbed9263d4d4df8",
+            "decimals": 6
+          }
+        }
+      },
+      "arbitrum": {
+        "chainId": 421614,
+        "bridgeContract": "0x00d6aE842Bb6e13457b241e69d542560EdDAF224",
+        "fastBridgeAddress": "fast1tkmtqxulhnzeeg9zhuwxy3x95wr7waytm9cq40ndf7tkuwwcc6jseg24j8",
+        "relayerUrl": "https://testnet.allset.fast.xyz/arbitrum-sepolia/relayer/relay",
+        "tokens": {
+          "USDC": {
+            "evmAddress": "0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d",
+            "fastTokenId": "9c52fe9465f57bc526c11aa0c048fd8709aa46abc06d15c80cbed9263d4d4df8",
+            "decimals": 6
+          }
+        }
+      }
+    }
+  },
+  "mainnet": {
+    "crossSignUrl": "https://cross-sign.allset.fast.xyz",
+    "chains": {}
+  }
+}

package/dist/bridge.d.ts

@@ -7,6 +7,49 @@
  *   Deposit  (EVM → Fast): call bridge.deposit(token, amount, receiver) on the EVM bridge contract
  *   Withdraw (Fast → EVM): transfer on Fast network + submit ExternalClaim intent + POST to relayer
  */
-import type { BridgeProvider } from './types.js';
-export declare const allsetProvider: BridgeProvider;
+import type { BridgeParams, BridgeResult, ExecuteIntentParams } from './types.js';
+import { type ChainConfig, type TokenConfig } from './config.js';
+interface BridgeProviderConfig {
+    network: 'testnet' | 'mainnet';
+    crossSignUrl?: string;
+    getChainConfig(chain: string): ChainConfig | null;
+    getTokenConfig(chain: string, token: string): TokenConfig | null;
+    getNetworkConfig?(): {
+        chains: Record<string, ChainConfig>;
+    };
+}
+export interface EvmSignResult {
+    transaction: number[];
+    signature: string;
+}
+/**
+ * Request EVM cross-signing for a Fast network certificate.
+ *
+ * This is an AllSet-specific operation that requests the AllSet committee
+ * to sign a certificate for verification on EVM chains.
+ *
+ * @param certificate - The certificate from a FastWallet.send() or FastWallet.submit() call
+ * @param crossSignUrl - Optional custom cross-sign service URL
+ * @returns The signed transaction bytes and signature for relayer submission
+ *
+ * @example
+ * ```ts
+ * const result = await fastWallet.send({ to: bridgeAddress, amount: '1000000', token: 'fastUSDC' });
+ * const signed = await evmSign(result.certificate);
+ * // Use signed.transaction and signed.signature with the relayer
+ * ```
+ */
+export declare function evmSign(certificate: unknown, crossSignUrl?: string): Promise<EvmSignResult>;
+/**
+ * Execute a bridge operation with optional provider configuration.
+ * Called by AllSetProvider.bridge() or directly for low-level usage.
+ */
+export declare function executeBridge(params: BridgeParams, provider?: BridgeProviderConfig): Promise<BridgeResult>;
+/**
+ * Execute intents on an EVM chain after transferring tokens from Fast network.
+ * This is the core function used by sendToExternal and can be used directly for
+ * advanced use cases like swaps, multi-step operations, etc.
+ */
+export declare function executeIntent(params: ExecuteIntentParams, provider?: BridgeProviderConfig): Promise<BridgeResult>;
+export {};
 //# sourceMappingURL=bridge.d.ts.map

package/dist/bridge.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bridge.d.ts","sourceRoot":"","sources":["../src/bridge.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAKH,OAAO,KAAK,EAAE,cAAc,EAAsC,MAAM,YAAY,CAAC;AAuFrF,eAAO,MAAM,cAAc,EAAE,cA4S5B,CAAC"}
+{"version":3,"file":"bridge.d.ts","sourceRoot":"","sources":["../src/bridge.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAKH,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAsC,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACtH,OAAO,EAAoD,KAAK,WAAW,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AA0CnH,UAAU,oBAAoB;IAC5B,OAAO,EAAE,SAAS,GAAG,SAAS,CAAC;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAAC;IAClD,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAAC;IACjE,gBAAgB,CAAC,IAAI;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;KAAE,CAAC;CAC9D;AA+HD,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,OAAO,CAC3B,WAAW,EAAE,OAAO,EACpB,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,aAAa,CAAC,CA2CxB;AAID;;;GAGG;AACH,wBAAsB,aAAa,CAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC,CAiChH;AAgID;;;;GAIG;AACH,wBAAsB,aAAa,CACjC,MAAM,EAAE,mBAAmB,EAC3B,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,OAAO,CAAC,YAAY,CAAC,CAqLvB"}