@lifi/composer-sdk
Version:
Public Composer SDK for building and submitting flows
64 lines (53 loc) • 2.31 kB
text/typescript
// AUTO-GENERATED from manifest.json — do not edit by hand.
// Regenerate with: yarn generate:composer-sdk
import type {
MaterialiserConfigOf,
MaterialiserInput,
} from '@lifi/compose-spec';
import type {
BalanceOfMaterialiserConfig as BalanceOfMaterialiserConfigSchema,
CallMaterialiserConfig as CallMaterialiserConfigSchema,
DirectDepositMaterialiserConfig as DirectDepositMaterialiserConfigSchema,
FlashloanMaterialiserConfig as FlashloanMaterialiserConfigSchema,
} from './config.generated.js';
export type BalanceOfMaterialiserConfig =
MaterialiserConfigOf<BalanceOfMaterialiserConfigSchema>;
/** Read the on-chain token balance of an address as the input amount — accepts: resource */
export const balanceOf = (
config: BalanceOfMaterialiserConfig,
): MaterialiserInput => ({
kind: 'balanceOf',
...config,
});
export type DirectDepositMaterialiserConfig =
MaterialiserConfigOf<DirectDepositMaterialiserConfigSchema>;
/** Deposit tokens into the VM — native via msg.value, ERC-20 via transferFrom — accepts: resource */
export const directDeposit = (
config: DirectDepositMaterialiserConfig,
): MaterialiserInput => ({
kind: 'directDeposit',
...config,
});
export type CallMaterialiserConfig =
MaterialiserConfigOf<CallMaterialiserConfigSchema>;
/** Execute an arbitrary contract call and measure the resulting token balance diff — accepts: resource */
export const call = (config: CallMaterialiserConfig): MaterialiserInput => ({
kind: 'call',
...config,
});
export type FlashloanMaterialiserConfig =
MaterialiserConfigOf<FlashloanMaterialiserConfigSchema>;
/**
* Experimental definitions, grouped like the stable ones. They carry no
* compatibility guarantee: any release, a patch included, can change,
* rename or remove one, or move it to its stable location. A backend that
* does not enable one rejects the flow with `validation_error`;
* `sdk.client.getManifest()` lists what a backend accepts.
*/
export const experimental = {
/** Borrow tokens from a flashloan provider; the flashloan runtime borrows amount into the proxy before the program runs and settles the loan after it — accepts: resource */
flashloan: (config: FlashloanMaterialiserConfig): MaterialiserInput => ({
kind: 'flashloan',
...config,
}),
} as const;