API documentation of Agoric SDK / Exports / @agoric/zoe / tools/types-ambient
Module: tools/types-ambient
Table of contents
Interfaces
Type Aliases
Type Aliases
PriceCalculator
Ƭ PriceCalculator: (amount
: Amount
<"nat"
>) => Amount
<"nat"
>
Type declaration
▸ (amount
): Amount
<"nat"
>
Parameters
Name | Type |
---|---|
amount | Amount <"nat" > |
Returns
Amount
<"nat"
>
Defined in
zoe/tools/types-ambient.js:142
PriceQuery
Ƭ PriceQuery: (calcAmountIn
: PriceCalculator
, calcAmountOut
: PriceCalculator
) => { amountIn
: Amount
<"nat"
> ; amountOut
: Amount
<"nat"
> ; timestamp?
: TimestampRecord
} | undefined
Type declaration
▸ (calcAmountIn
, calcAmountOut
): { amountIn
: Amount
<"nat"
> ; amountOut
: Amount
<"nat"
> ; timestamp?
: TimestampRecord
} | undefined
Parameters
Name | Type |
---|---|
calcAmountIn | PriceCalculator |
calcAmountOut | PriceCalculator |
Returns
{ amountIn
: Amount
<"nat"
> ; amountOut
: Amount
<"nat"
> ; timestamp?
: TimestampRecord
} | undefined
Defined in
zoe/tools/types-ambient.js:146
PriceQuoteCreate
Ƭ PriceQuoteCreate: (priceQuery
: PriceQuery
) => ERef
<PriceQuote
> | undefined
Type declaration
▸ (priceQuery
): ERef
<PriceQuote
> | undefined
Parameters
Name | Type |
---|---|
priceQuery | PriceQuery |
Returns
ERef
<PriceQuote
> | undefined
Defined in
PriceQuoteTrigger
Ƭ PriceQuoteTrigger: (createQuote
: PriceQuoteCreate
) => any
Type declaration
▸ (createQuote
): any
Parameters
Name | Type |
---|---|
createQuote | PriceQuoteCreate |
Returns
any
Defined in
PriceQuoteValue
Ƭ PriceQuoteValue: [PriceDescription
]
A single-valued set of PriceDescriptions. This is the value
in PriceQuote.quoteAmount ({ brand, value: PriceQuoteValue }
).