CreateSimpleLoanBorrow
@liquidium/client / CreateSimpleLoanBorrow
Type Alias: CreateSimpleLoanBorrow
CreateSimpleLoanBorrow =
AssetIdentifier&object
Defined in: packages/client/src/modules/simple-loans/types.ts:46
Borrow leg used when creating a simple loan.
chain and asset form the canonical asset identifier. For example,
{ chain: "ICP", asset: "USDT" } means ckUSDT.
Type Declaration
amount
amount:
bigint
Amount to borrow, in the borrow asset's base units.
For USDC/USDT, convert the UI amount using the selected borrow pool's
decimals value before passing it here.
destination
destination:
SimpleLoanDestination
Destination that receives the borrowed asset after the loan starts.
Pass either a string shorthand or a typed destination. For BTC/ETH chain
outflows this is usually the user's chain address. Chain-key assets on ICP
require an IcPrincipal; native ICP also accepts IcpAccountIdentifier
and IcrcAccount destinations.
poolId
poolId:
string
Principal text of the pool that funds the borrow.
This should be the id of the borrow Pool selected from
client.market.listPools(). The pool asset must match asset.