@lifi/composer-sdk 0.2.0 → 0.3.0

package/src/examples/splitAndZap.ts

@@ -7,7 +7,7 @@ import {
   resources,
 } from '../index.js';
 
-import { BASE_URL, OWNER } from './config.js';
+import { API_KEY, BASE_URL, OWNER } from './config.js';
 const USDC = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
 // Aave v3 aEthUSDC receipt token on Ethereum mainnet
 const A_ETH_USDC = '0x98C23E9d8f34FEFb1B7BD6a91B7FF122F4e16F5c';
@@ -26,7 +26,7 @@ export const buildSplitAndZapExample = (): {
   flow: Flow;
   request: ComposeCompileRequest;
 } => {
-  const sdk = createComposeSdk({ baseUrl: BASE_URL });
+  const sdk = createComposeSdk({ baseUrl: BASE_URL, apiKey: API_KEY });
 
   const builder = sdk.flow(1, {
     name: 'split-usdc-to-two-vaults',

package/src/examples/splitWithArithmetic.ts

@@ -3,7 +3,7 @@ import type { ComposeCompileRequest, Flow } from '@lifi/compose-spec';
 import { createComposeSdk, materialisers, resources } from '../index.js';
 import type { Address } from '../types.js';
 
-import { BASE_URL } from './config.js';
+import { API_KEY, BASE_URL } from './config.js';
 
 const USDC = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
 
@@ -29,7 +29,7 @@ export const buildSplitWithArithmetic = ({
   flow: Flow;
   request: ComposeCompileRequest;
 } => {
-  const sdk = createComposeSdk({ baseUrl: BASE_URL });
+  const sdk = createComposeSdk({ baseUrl: BASE_URL, apiKey: API_KEY });
 
   const builder = sdk.flow(1, {
     name: 'split-with-arithmetic',

package/src/examples/swapAndZap.ts

@@ -7,7 +7,7 @@ import {
   resources,
 } from '../index.js';
 
-import { BASE_URL, OWNER } from './config.js';
+import { API_KEY, BASE_URL, OWNER } from './config.js';
 const WETH = '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2';
 const USDC = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
 // Aave aEthUSDC receipt token on Ethereum mainnet
@@ -25,7 +25,7 @@ export const buildSwapAndZapExample = (): {
   flow: Flow;
   request: ComposeCompileRequest;
 } => {
-  const sdk = createComposeSdk({ baseUrl: BASE_URL });
+  const sdk = createComposeSdk({ baseUrl: BASE_URL, apiKey: API_KEY });
 
   // Declare the flow with a single WETH input on Ethereum mainnet.
   const builder = sdk.flow(1, {

package/src/examples/swapToRecipient.ts

@@ -3,7 +3,7 @@ import type { ComposeCompileRequest, Flow } from '@lifi/compose-spec';
 import { createComposeSdk, materialisers, resources } from '../index.js';
 import type { Address } from '../types.js';
 
-import { BASE_URL } from './config.js';
+import { API_KEY, BASE_URL } from './config.js';
 
 const WETH = '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2';
 const USDC = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
@@ -35,7 +35,7 @@ export const buildSwapToRecipient = ({
   flow: Flow;
   request: ComposeCompileRequest;
 } => {
-  const sdk = createComposeSdk({ baseUrl: BASE_URL });
+  const sdk = createComposeSdk({ baseUrl: BASE_URL, apiKey: API_KEY });
 
   // Declare the flow on Ethereum mainnet with two token inputs and one address input.
   const builder = sdk.flow(1, {

package/src/examples/swapWithAllowRevert.ts

@@ -2,7 +2,7 @@ import type { ComposeCompileRequest, Flow } from '@lifi/compose-spec';
 
 import { createComposeSdk, materialisers, resources } from '../index.js';
 
-import { BASE_URL, OWNER } from './config.js';
+import { API_KEY, BASE_URL, OWNER } from './config.js';
 const WETH = '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2';
 const USDC = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
 
@@ -25,7 +25,7 @@ export const buildSwapWithAllowRevertExample = (): {
   flow: Flow;
   request: ComposeCompileRequest;
 } => {
-  const sdk = createComposeSdk({ baseUrl: BASE_URL });
+  const sdk = createComposeSdk({ baseUrl: BASE_URL, apiKey: API_KEY });
 
   const builder = sdk.flow(1, {
     name: 'swap-weth-to-usdc-allow-revert',
@@ -70,7 +70,7 @@ export const buildSwapWithAllowRevertExample = (): {
  * but demonstrates the branching pattern callers should use.
  */
 export const handleCompileResult = async (): Promise<void> => {
-  const sdk = createComposeSdk({ baseUrl: BASE_URL });
+  const sdk = createComposeSdk({ baseUrl: BASE_URL, apiKey: API_KEY });
 
   const builder = sdk.flow(1, {
     inputs: { amountIn: resources.erc20(WETH, 1) },

package/src/examples/swapWithBalanceCheck.ts

@@ -3,7 +3,7 @@ import type { ComposeCompileRequest, Flow } from '@lifi/compose-spec';
 import { createComposeSdk, materialisers, resources } from '../index.js';
 import type { Address } from '../types.js';
 
-import { BASE_URL } from './config.js';
+import { API_KEY, BASE_URL } from './config.js';
 
 const WETH = '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2';
 const USDC = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
@@ -29,7 +29,7 @@ export const buildSwapWithBalanceCheck = ({
   flow: Flow;
   request: ComposeCompileRequest;
 } => {
-  const sdk = createComposeSdk({ baseUrl: BASE_URL });
+  const sdk = createComposeSdk({ baseUrl: BASE_URL, apiKey: API_KEY });
 
   // Declare the flow with a single WETH input on Ethereum mainnet.
   const builder = sdk.flow(1, {

package/src/examples/swapWithFee.ts

@@ -2,7 +2,7 @@ import type { ComposeCompileRequest, Flow } from '@lifi/compose-spec';
 
 import { createComposeSdk, materialisers, resources } from '../index.js';
 
-import { BASE_URL, OWNER } from './config.js';
+import { API_KEY, BASE_URL, OWNER } from './config.js';
 
 const WETH = '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2';
 const USDC = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
@@ -22,7 +22,7 @@ export const buildSwapWithFeeExample = (): {
   flow: Flow;
   request: ComposeCompileRequest;
 } => {
-  const sdk = createComposeSdk({ baseUrl: BASE_URL });
+  const sdk = createComposeSdk({ baseUrl: BASE_URL, apiKey: API_KEY });
 
   // Declare the flow with a single WETH input on Ethereum mainnet.
   const builder = sdk.flow(1, {

package/src/examples/swapWithOutputValidation.ts

@@ -3,7 +3,7 @@ import type { ComposeCompileRequest, Flow } from '@lifi/compose-spec';
 import { createComposeSdk, materialisers, resources } from '../index.js';
 import type { Address } from '../types.js';
 
-import { BASE_URL } from './config.js';
+import { API_KEY, BASE_URL } from './config.js';
 
 const WETH = '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2';
 const USDC = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
@@ -31,7 +31,7 @@ export const buildSwapWithOutputValidation = ({
   flow: Flow;
   request: ComposeCompileRequest;
 } => {
-  const sdk = createComposeSdk({ baseUrl: BASE_URL });
+  const sdk = createComposeSdk({ baseUrl: BASE_URL, apiKey: API_KEY });
 
   const builder = sdk.flow(1, {
     name: 'swap-with-output-validation',

package/src/examples/transferTokens.ts

@@ -3,7 +3,7 @@ import type { ComposeCompileRequest, Flow } from '@lifi/compose-spec';
 import { createComposeSdk, materialisers, resources } from '../index.js';
 import type { Address } from '../types.js';
 
-import { BASE_URL } from './config.js';
+import { API_KEY, BASE_URL } from './config.js';
 
 const USDC = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48';
 
@@ -31,7 +31,7 @@ export const buildTransferTokens = ({
   flow: Flow;
   request: ComposeCompileRequest;
 } => {
-  const sdk = createComposeSdk({ baseUrl: BASE_URL });
+  const sdk = createComposeSdk({ baseUrl: BASE_URL, apiKey: API_KEY });
 
   const builder = sdk.flow(1, {
     name: 'transfer-usdc',
@@ -79,7 +79,7 @@ export const buildPartialTransfer = ({
   flow: Flow;
   request: ComposeCompileRequest;
 } => {
-  const sdk = createComposeSdk({ baseUrl: BASE_URL });
+  const sdk = createComposeSdk({ baseUrl: BASE_URL, apiKey: API_KEY });
 
   const builder = sdk.flow(1, {
     name: 'partial-transfer-usdc',

package/src/examples/untypedOpWithTypedRef.ts

@@ -3,7 +3,7 @@ import type { ComposeCompileRequest, Flow } from '@lifi/compose-spec';
 import { createComposeSdk, raw } from '../index.js';
 import type { Address } from '../types.js';
 
-import { BASE_URL } from './config.js';
+import { API_KEY, BASE_URL } from './config.js';
 
 // Real ERC-4626 vault (Steakhouse USDC on Ethereum mainnet) queried through
 // the untyped escape hatch.
@@ -38,7 +38,7 @@ export const buildUntypedOpWithTypedRef = ({
   flow: Flow;
   request: ComposeCompileRequest;
 } => {
-  const sdk = createComposeSdk({ baseUrl: BASE_URL });
+  const sdk = createComposeSdk({ baseUrl: BASE_URL, apiKey: API_KEY });
 
   const builder = sdk.flow(1, {
     name: 'untyped-op-with-typed-ref',

package/src/generated/config.generated.ts

@@ -3,8 +3,13 @@
 
 import type { Address, IntegerStringInput } from '../types.js';
 
+/**
+ * a number between 0 and 10000
+ */
+export type Between010000 = number;
+
 export interface CoreSplitConfig {
-  bps: number;
+  bps: Between010000;
 }
 
 /**
@@ -89,12 +94,17 @@ export interface InvariantNeqConfig {
   threshold: IntegerStringInput;
 }
 
+/**
+ * a non-negative number
+ */
+export type NonNegative = number;
+
 export interface CoreBpsDownConfig {
-  bps: number;
+  bps: NonNegative;
 }
 
 export interface CoreBpsUpConfig {
-  bps: number;
+  bps: NonNegative;
 }
 
 export interface CoreApproveConfig {
@@ -634,6 +644,33 @@ export interface LifiFlashloanRepayConfig {
   fee?: string;
 }
 
+export type ContinuationAssertReadyConfig =
+  | {
+      kind: 'erc20BalanceGte';
+      chainId: Positive;
+      token: StartsWith0X;
+      owner: StartsWith0X;
+      minAmount: string;
+    }
+  | {
+      kind: 'nativeBalanceGte';
+      chainId: Positive;
+      owner: StartsWith0X;
+      minAmount: string;
+    }
+  | {
+      kind: 'call';
+      chainId: Positive;
+      to: StartsWith0X;
+      calldata: StartsWith0X;
+      comparator: 'gte' | 'eq' | 'lte';
+      value: string;
+    };
+/**
+ * a string starting with "0x"
+ */
+export type StartsWith0X = string;
+
 export interface LifiZapConfig {
   resourceOut:
     | {
@@ -647,15 +684,6 @@ export interface LifiZapConfig {
       };
 }
 
-/**
- * a non-negative number
- */
-export type GreaterThanOrEqualTo0 = number;
-/**
- * a number between 0 and 10000
- */
-export type Between010000 = number;
-
 export interface ParaswapBuyConfig {
   resourceOut:
     | {
@@ -668,8 +696,8 @@ export interface ParaswapBuyConfig {
         chainId: Positive;
       };
   exactAmountOut: string;
-  srcDecimals: GreaterThanOrEqualTo0;
-  destDecimals: GreaterThanOrEqualTo0;
+  srcDecimals: NonNegative;
+  destDecimals: NonNegative;
   maxSlippageBps?: Between010000;
   partner?: string;
   partnerAddress?: string;

package/src/index.ts

@@ -63,6 +63,12 @@ export type {
   Erc20BalanceRequirement,
   NativeBalanceRequirement,
   Erc20AllowanceRequirement,
+  ContinuationIntent,
+  ContinuationOutcome,
+  Check,
+  CheckComparator,
+  Phase1ArtifactWire,
+  ContinuationPlanWire,
 } from '@lifi/compose-spec';
 export {
   SIMULATE_MAX_TRACKED_BALANCES,

package/src/sdk.ts

@@ -63,8 +63,8 @@ export interface ComposeSdkOptions {
   readonly baseUrl: string;
   /** Optional custom `fetch` implementation. Defaults to `globalThis.fetch`. */
   readonly fetch?: typeof globalThis.fetch;
-  /** Optional LI.FI API key for authenticated access. Sent as the `x-lifi-api-key` header on every request. */
-  readonly apiKey?: string;
+  /** LI.FI API key, sent as the `x-lifi-api-key` header on every request. Required — the Compose API rejects unauthenticated requests. */
+  readonly apiKey: string;
 }
 
 /**
@@ -77,7 +77,7 @@ export interface ComposeSdkOptions {
  * ```ts
  * import { createComposeSdk, resources, materialisers } from '@lifi/composer-sdk';
  *
- * const sdk = createComposeSdk({ baseUrl: 'https://li.quest' });
+ * const sdk = createComposeSdk({ baseUrl: 'https://li.quest', apiKey: 'YOUR_API_KEY' });
  *
  * const builder = sdk.flow(1, {
  *   inputs: { usdc: resources.erc20('0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', 1) },
@@ -136,12 +136,12 @@ export interface ComposeSdk {
 /**
  * Creates a new Compose SDK instance.
  *
- * @param options - SDK configuration including the API base URL and optional fetch implementation.
+ * @param options - SDK configuration including the API base URL, required API key, and optional fetch implementation.
  * @returns A {@link ComposeSdk} instance.
  *
  * @example
  * ```ts
- * const sdk = createComposeSdk({ baseUrl: 'https://li.quest' });
+ * const sdk = createComposeSdk({ baseUrl: 'https://li.quest', apiKey: 'YOUR_API_KEY' });
  * ```
  */
 export const createComposeSdk = (options: ComposeSdkOptions): ComposeSdk => {