UNPKG

@lifi/composer-sdk

Version:

Public Composer SDK for building and submitting flows

135 lines (134 loc) • 5.14 kB
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" }); const require_errors = require("./errors.cjs"); const require_reachability = require("./reachability.cjs"); const require_authoring_handles = require("./authoring/handles.cjs"); const require_authoring_raw = require("./authoring/raw.cjs"); const require_run_inputs = require("./run/inputs.cjs"); const require_run_simulate = require("./run/simulate.cjs"); const require_outputs = require("./outputs.cjs"); const require_sdk = require("./sdk.cjs"); const require_generated_guards_generated = require("./generated/guards.generated.cjs"); const require_generated_materialisers_generated = require("./generated/materialisers.generated.cjs"); const require_generated_preconditions_generated = require("./generated/preconditions.generated.cjs"); const require_raw = require("./raw.cjs"); const require_resources = require("./resources.cjs"); const require_routeAmount = require("./routeAmount.cjs"); let _lifi_compose_spec = require("@lifi/compose-spec"); //#region src/index.ts /** * Guard factories for protecting operation outputs (e.g. slippage tolerance). * Pass guards to an operation's `guards` array. * * @example * ```ts * builder.lifi.swap('swap1', { * bind: { amountIn: builder.inputs.token }, * config: { resourceOut: resources.native(1) }, * guards: [guards.slippage({ port: 'amountOut', bps: 300 })], * }); * ``` */ const guards = require_generated_guards_generated.guards_generated_exports; /** * Materialiser factories that tell the runtime how to resolve token input * amounts on-chain (e.g. read a wallet balance, accept a direct deposit). * * @example * ```ts * await builder.compile({ * inputs: { token: materialisers.balanceOf({}) }, * signer: '0x...', * }); * ``` */ const materialisers = require_generated_materialisers_generated.materialisers_generated_exports; /** * Precondition factories for asserting on-chain state before a flow executes * (e.g. minimum token balances, ERC-20 allowances). * * @example * ```ts * await builder.compile({ * inputs: { token: materialisers.balanceOf({}) }, * preconditions: [ * preconditions.erc20Balance({ wallet: '0x...', token: '0x...', balance: 1000n }), * ], * signer: '0x...', * }); * ``` */ const preconditions = require_generated_preconditions_generated.preconditions_generated_exports; /** * Resource declaration helpers for defining token inputs in a flow schema. * Use {@link resources.erc20} for ERC-20 tokens and {@link resources.native} * for the chain's native coin (ETH, MATIC, etc.). * * @example * ```ts * const builder = sdk.flow(1, { * inputs: { * usdc: resources.erc20('0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', 1), * eth: resources.native(1), * }, * }); * ``` */ const resources = require_resources.resources_exports; /** * Amount constructors for {@link ComposeSdk.route}. Use * {@link routeAmount.exact} to spend a fixed amount of the `fromToken`, and * {@link routeAmount.all} to spend the signer's whole balance. * * @example * ```ts * // USDC into the Aave v3 aEthUSDC position — one routing-catalog edge. * const result = await sdk.route({ * chainId: 1, * fromToken: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', * toToken: '0x98C23E9d8f34FEFb1B7BD6a91B7FF122F4e16F5c', * amount: routeAmount.exact(1_000_000n), * signer: '0xYourAddress...', * }); * ``` */ const routeAmount = require_routeAmount.routeAmount_exports; /** * Low-level escape hatch for constructing flow nodes, guards, and materialiser * inputs without the typed builder API. Prefer the generated operation methods * on {@link FlowBuilder} and the typed `guards`/`materialisers` namespaces * for most use cases. */ const raw = require_raw.raw_exports; //#endregion Object.defineProperty(exports, "SIMULATE_MAX_REQUIREMENTS", { enumerable: true, get: function() { return _lifi_compose_spec.SIMULATE_MAX_REQUIREMENTS; } }); Object.defineProperty(exports, "SIMULATE_MAX_TRACKED_BALANCES", { enumerable: true, get: function() { return _lifi_compose_spec.SIMULATE_MAX_TRACKED_BALANCES; } }); exports.buildReachability = require_reachability.buildReachability; exports.buildSimulateRequest = require_run_simulate.buildSimulateRequest; exports.createComposeSdk = require_sdk.createComposeSdk; exports.guards = guards; exports.isComposeDeliveryError = require_errors.isComposeDeliveryError; exports.isComposeError = require_errors.isComposeError; exports.isComposePreparationError = require_errors.isComposePreparationError; exports.isComposeSdkOutdatedError = require_errors.isComposeSdkOutdatedError; exports.isComposeServerOutdatedError = require_errors.isComposeServerOutdatedError; exports.isInputHandle = require_authoring_handles.isInputHandle; exports.isOutputHandle = require_authoring_handles.isOutputHandle; exports.materialiser = require_run_inputs.materialiser; exports.materialisers = materialisers; exports.preconditions = preconditions; exports.raw = raw; exports.ref = require_authoring_raw.ref; exports.resources = resources; exports.routeAmount = routeAmount; exports.terminalOutputs = require_outputs.terminalOutputs; //# sourceMappingURL=index.cjs.map