API documentation of Agoric SDK / Exports / @agoric/inter-protocol / clientSupport
Module: clientSupport
Table of contents
Variables
Functions
Variables
Offers
• Const Offers: Object
Type declaration
| Name | Type |
|---|---|
auction | { Bid: (agoricNames: Pick<AgoricNamesRemotes, "brand" | "vbankAsset">, opts: { give: string ; maxBuy: string ; offerId: string ; wantMinimum?: string } & { price: number } | { discount: number }) => OfferSpec = makeBidOffer } |
auction.Bid | (agoricNames: Pick<AgoricNamesRemotes, "brand" | "vbankAsset">, opts: { give: string ; maxBuy: string ; offerId: string ; wantMinimum?: string } & { price: number } | { discount: number }) => OfferSpec |
fluxAggregator | { PushPrice: (_agoricNames: unknown, opts: { offerId: string ; roundId?: bigint ; unitPrice: bigint }, previousOffer: string) => OfferSpec = makePushPriceOffer } |
fluxAggregator.PushPrice | (_agoricNames: unknown, opts: { offerId: string ; roundId?: bigint ; unitPrice: bigint }, previousOffer: string) => OfferSpec |
psm | { swap: (agoricNames: Pick<AgoricNamesRemotes, "brand">, instance: Instance, opts: { feePct?: number ; offerId: string ; pair: [string, string] } & { wantMinted: number } | { giveMinted: number }) => OfferSpec = makePsmSwapOffer } |
psm.swap | (agoricNames: Pick<AgoricNamesRemotes, "brand">, instance: Instance, opts: { feePct?: number ; offerId: string ; pair: [string, string] } & { wantMinted: number } | { giveMinted: number }) => OfferSpec |
reserve | { AddCollateral: (agoricNames: Pick<AgoricNamesRemotes, "brand">, opts: { collateralBrandKey: string ; give: number ; offerId: string }) => OfferSpec = makeAddCollateralOffer } |
reserve.AddCollateral | (agoricNames: Pick<AgoricNamesRemotes, "brand">, opts: { collateralBrandKey: string ; give: number ; offerId: string }) => OfferSpec |
vaults | { AdjustBalances: (agoricNames: Pick<AgoricNamesRemotes, "brand">, opts: { collateralBrandKey?: string ; giveCollateral?: number ; giveMinted?: number ; offerId: string ; wantCollateral?: number ; wantMinted?: number }, previousOffer: string) => OfferSpec = makeAdjustOffer; CloseVault: (agoricNames: Pick<AgoricNamesRemotes, "brand">, opts: { collateralBrandKey?: string ; giveMinted: number ; offerId: string }, previousOffer: string) => OfferSpec = makeCloseOffer; OpenVault: (agoricNames: Pick<AgoricNamesRemotes, "brand">, opts: { collateralBrandKey: string ; giveCollateral: number ; offerId: string ; wantMinted: number }) => OfferSpec = makeOpenOffer } |
vaults.AdjustBalances | (agoricNames: Pick<AgoricNamesRemotes, "brand">, opts: { collateralBrandKey?: string ; giveCollateral?: number ; giveMinted?: number ; offerId: string ; wantCollateral?: number ; wantMinted?: number }, previousOffer: string) => OfferSpec |
vaults.CloseVault | (agoricNames: Pick<AgoricNamesRemotes, "brand">, opts: { collateralBrandKey?: string ; giveMinted: number ; offerId: string }, previousOffer: string) => OfferSpec |
vaults.OpenVault | (agoricNames: Pick<AgoricNamesRemotes, "brand">, opts: { collateralBrandKey: string ; giveCollateral: number ; offerId: string ; wantMinted: number }) => OfferSpec |
Defined in
Functions
lookupOfferIdForVault
▸ lookupOfferIdForVault(vaultId, currentP): Promise<string>
Parameters
| Name | Type |
|---|---|
vaultId | string |
currentP | Promise<CurrentWalletRecord> |
Returns
Promise<string>
offer id in which the vault was made
Defined in
makeParseAmount
▸ makeParseAmount(agoricNames, makeError?): (a: string) => Amount<"nat">
Parameters
| Name | Type | Description |
|---|---|---|
agoricNames | Pick<AgoricNamesRemotes, "brand" | "vbankAsset"> | - |
makeError | (msg: string) => Error | error constructor |
Returns
fn
▸ (a): Amount<"nat">
Parameters
| Name | Type |
|---|---|
a | string |
Returns
Amount<"nat">