Skip to main content

SupplyFlow

@liquidium/client


@liquidium/client / SupplyFlow

Interface: SupplyFlow

Defined in: external/liquidium-sdk/packages/client/src/modules/lending/types.ts:250

Supply receipt returned by lending.supply(...).

  • txid is populated when the SDK broadcast the transaction on your behalf (wallet-adapter path). When undefined, the caller is expected to broadcast themselves and call SupplyFlow.submit for flows that require txid registration.
  • submit registers a broadcast txid with the SDK API when needed. ETH stablecoin deposit-address transfers are indexed from ERC-20 transfer logs, so submit acknowledges the txid without posting it to the inflow endpoint.

The SDK does not poll inflow status. When you have a txid, it is your responsibility to track confirmation state with your own polling.

Properties

target

target: SupplyTarget

Defined in: external/liquidium-sdk/packages/client/src/modules/lending/types.ts:254

Destination where funds should be sent or were sent.


txid?

optional txid?: string

Defined in: external/liquidium-sdk/packages/client/src/modules/lending/types.ts:256

Transaction id when the SDK broadcast the transaction.


type

type: SupplyPlanType

Defined in: external/liquidium-sdk/packages/client/src/modules/lending/types.ts:252

Execution plan used by the supply flow.

Methods

submit()

submit(request): Promise<SubmitInflowResponse>

Defined in: external/liquidium-sdk/packages/client/src/modules/lending/types.ts:258

Registers a broadcast transaction id when the flow requires an indexing hint.

Parameters

request

SubmitInflowRequest

Returns

Promise<SubmitInflowResponse>