UNPKG

@agoric/zoe

Version:

Zoe: the Smart Contract Framework for Offer Enforcement

github.com/Agoric/agoric-sdk

Agoric/agoric-sdk

63 lines (59 loc) • 2.83 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/** * @typedef {object} SellItemsPublicFacet * @property {() => Issuer} getItemsIssuer * @property {() => Amount} getAvailableItems * * @typedef {object} SellItemsCreatorOnly * @property {() => Promise<import('../types-index').Invitation>} makeBuyerInvitation * * @typedef {SellItemsPublicFacet & SellItemsCreatorOnly} SellItemsCreatorFacet */ /** * @typedef {object} SellItemsParameters * @property {Record<string, any>} customValueProperties * @property {number} count * @property {Issuer} moneyIssuer * @property {Installation} sellItemsInstallation * @property {Amount} pricePerItem * * @typedef {object} SellItemsResult * @property {UserSeat} sellItemsCreatorSeat * @property {SellItemsCreatorFacet} sellItemsCreatorFacet * @property {Instance} sellItemsInstance * @property {SellItemsPublicFacet} sellItemsPublicFacet * * @typedef {object} MintAndSellNFTCreatorFacet * @property {(sellParams: SellItemsParameters) => Promise<SellItemsResult>} sellTokens * @property {() => Issuer} getIssuer */ /** * @typedef {object} AutomaticRefundPublicFacet * @property {() => bigint} getOffersCount * @property {() => Promise<import('../types-index').Invitation>} makeInvitation */ /** * @typedef {object} AutoswapPublicFacet * @property {() => Promise<import('../types-index').Invitation>} makeSwapInvitation synonym for * makeSwapInInvitation * @property {() => Promise<import('../types-index').Invitation>} makeSwapInInvitation make an invitation * that allows one to do a swap in which the In amount is specified and the Out * amount is calculated * @property {() => Promise<import('../types-index').Invitation>} makeSwapOutInvitation make an invitation * that allows one to do a swap in which the Out amount is specified and the In * amount is calculated * @property {() => Promise<import('../types-index').Invitation>} makeAddLiquidityInvitation make an * invitation that allows one to add liquidity to the pool. * @property {() => Promise<import('../types-index').Invitation>} makeRemoveLiquidityInvitation make an * invitation that allows one to remove liquidity from the pool. * @property {() => Issuer} getLiquidityIssuer * @property {() => bigint} getLiquiditySupply get the current value of * liquidity held by investors. * @property {(amountIn: Amount, brandOut: Brand) => Amount} getInputPrice * calculate the amount of brandOut that will be returned if the amountIn is * offered using makeSwapInInvitation at the current price. * @property {(amountOut: Amount, brandIn: Brand) => Amount} getOutputPrice * calculate the amount of brandIn that is required in order to get amountOut * using makeSwapOutInvitation at the current price * @property {() => Record<string, Amount>} getPoolAllocation get an * AmountKeywordRecord showing the current balances in the pool. */