API documentation of Agoric SDK / Exports / @agoric/zoe / src/zoeService/types
Module: src/zoeService/types
Table of contents
Interfaces
- AfterDeadlineExitRule
- FeeIssuerConfig
- InvitationDetails
- OnDemandExitRule
- UserSeat
- VatAdminSvc
- WaivedExitRule
- Waker
- ZoeFeesConfig
- ZoeService
Type Aliases
- AmountKeywordRecord
- ExitRule
- FeeMintAccess
- GetBrands
- GetBundleIDFromInstallation
- GetConfiguration
- GetFeeIssuer
- GetInstallation
- GetInstallationForInstance
- GetInstance
- GetInvitationDetails
- GetInvitationIssuer
- GetIssuers
- GetOfferFilter
- InstallBundle
- InstallBundleID
- Installation
- InstallationStart
- Instance
- Offer
- PaymentKeywordRecord
- PaymentPKeywordRecord
- Proposal
- ProposalRecord
- SetOfferFilter
- SourceBundle
- ZCFSpec
Type Aliases
AmountKeywordRecord
Ƭ AmountKeywordRecord: Record
<Keyword
, Amount
<any
>>
The keys are keywords, and the values are amounts. For example: { Asset: AmountMath.make(assetBrand, 5n), Price: AmountMath.make(priceBrand, 9n) }
Defined in
zoe/src/zoeService/types.js:235
ExitRule
Ƭ ExitRule: OnDemandExitRule
| WaivedExitRule
| AfterDeadlineExitRule
The possible keys are 'waived', 'onDemand', and 'afterDeadline'. timer
and deadline
only are used for the afterDeadline
key. The possible records are: { waived: null }
{ onDemand: null }
{ afterDeadline: { timer :Timer<Deadline>, deadline :Deadline } }
Defined in
zoe/src/zoeService/types.js:263
FeeMintAccess
Ƭ FeeMintAccess: Handle
<"feeMintAccess"
>
Defined in
zoe/src/zoeService/types.js:327
GetBrands
Ƭ GetBrands: (instance
: src/zoeService/utils
) => Promise
<BrandKeywordRecord
>
Type declaration
▸ (instance
): Promise
<BrandKeywordRecord
>
Parameters
Name | Type |
---|---|
instance | src/zoeService/utils |
Returns
Promise
<BrandKeywordRecord
>
Defined in
zoe/src/zoeService/types.js:74
GetBundleIDFromInstallation
Ƭ GetBundleIDFromInstallation: (allegedInstallation
: ERef
<Installation
>) => Promise
<BundleID
>
Verify that an alleged Installation is real, and return the Bundle ID it will use for contract code.
Type declaration
▸ (allegedInstallation
): Promise
<BundleID
>
Parameters
Name | Type |
---|---|
allegedInstallation | ERef <Installation > |
Returns
Promise
<BundleID
>
Defined in
zoe/src/zoeService/types.js:141
GetConfiguration
Ƭ GetConfiguration: () => { feeIssuerConfig
: FeeIssuerConfig
}
Type declaration
▸ (): Object
Returns
Object
Name | Type |
---|---|
feeIssuerConfig | FeeIssuerConfig |
Defined in
zoe/src/zoeService/types.js:61
GetFeeIssuer
Ƭ GetFeeIssuer: () => Promise
<Issuer
<"nat"
>>
Type declaration
▸ (): Promise
<Issuer
<"nat"
>>
Returns
Promise
<Issuer
<"nat"
>>
Defined in
zoe/src/zoeService/types.js:56
GetInstallation
Ƭ GetInstallation: (invitation
: ERef
<Invitation
>) => Promise
<Installation
>
Type declaration
▸ (invitation
): Promise
<Installation
>
Parameters
Name | Type |
---|---|
invitation | ERef <Invitation > |
Returns
Promise
<Installation
>
Defined in
zoe/src/zoeService/types.js:104
GetInstallationForInstance
Ƭ GetInstallationForInstance: (instance
: src/zoeService/utils
) => Promise
<Installation
>
Type declaration
▸ (instance
): Promise
<Installation
>
Parameters
Name | Type |
---|---|
instance | src/zoeService/utils |
Returns
Promise
<Installation
>
Defined in
zoe/src/zoeService/types.js:92
GetInstance
Ƭ GetInstance: (invitation
: ERef
<Invitation
>) => Promise
<src/zoeService/utils
>
Type declaration
▸ (invitation
): Promise
<src/zoeService/utils
>
Parameters
Name | Type |
---|---|
invitation | ERef <Invitation > |
Returns
Promise
<src/zoeService/utils
>
Defined in
zoe/src/zoeService/types.js:98
GetInvitationDetails
Ƭ GetInvitationDetails: (invitation
: ERef
<Invitation
<any
, any
>>) => Promise
<InvitationDetails
>
Type declaration
▸ (invitation
): Promise
<InvitationDetails
>
Parameters
Name | Type |
---|---|
invitation | ERef <Invitation <any , any >> |
Returns
Promise
<InvitationDetails
>
Defined in
zoe/src/zoeService/types.js:110
GetInvitationIssuer
Ƭ GetInvitationIssuer: () => Promise
<Issuer
<"set"
>>
Type declaration
▸ (): Promise
<Issuer
<"set"
>>
Returns
Promise
<Issuer
<"set"
>>
Defined in
zoe/src/zoeService/types.js:51
GetIssuers
Ƭ GetIssuers: (instance
: src/zoeService/utils
) => Promise
<IssuerKeywordRecord
>
Type declaration
▸ (instance
): Promise
<IssuerKeywordRecord
>
Parameters
Name | Type |
---|---|
instance | src/zoeService/utils |
Returns
Promise
<IssuerKeywordRecord
>
Defined in
zoe/src/zoeService/types.js:68
GetOfferFilter
Ƭ GetOfferFilter: (instance
: src/zoeService/utils
) => string
[]
Type declaration
▸ (instance
): string
[]
Parameters
Name | Type |
---|---|
instance | src/zoeService/utils |
Returns
string
[]
Defined in
zoe/src/zoeService/types.js:80
InstallBundle
Ƭ InstallBundle: (bundle
: Bundle
| SourceBundle
, bundleLabel?
: string
) => Promise
<Installation
>
Create an installation by safely evaluating the code and registering it with Zoe. Returns an installation.
Type declaration
▸ (bundle
, bundleLabel?
): Promise
<Installation
>
Parameters
Name | Type |
---|---|
bundle | Bundle | SourceBundle |
bundleLabel? | string |
Returns
Promise
<Installation
>
Defined in
zoe/src/zoeService/types.js:118
InstallBundleID
Ƭ InstallBundleID: (bundleID
: BundleID
, bundleLabel?
: string
) => Promise
<Installation
>
Create an installation from a Bundle ID. Returns an installation.
Type declaration
▸ (bundleID
, bundleLabel?
): Promise
<Installation
>
Parameters
Name | Type |
---|---|
bundleID | BundleID |
bundleLabel? | string |
Returns
Promise
<Installation
>
Defined in
zoe/src/zoeService/types.js:131
Installation
Ƭ Installation<SF
>: Object
Type parameters
Name |
---|
SF |
Type declaration
Name | Type |
---|---|
[StartFunction] | SF |
getBundle | () => SourceBundle |
getBundleLabel | () => string |
Defined in
zoe/src/zoeService/utils.d.ts:18
InstallationStart
Ƭ InstallationStart<I
>: I
extends Installation
<infer SF> ? SF
: never
Type parameters
Name |
---|
I |
Defined in
zoe/src/zoeService/utils.d.ts:29
Instance
Ƭ Instance: src/zoeService/utils
Defined in
zoe/src/zoeService/types.js:274
Offer
Ƭ Offer: <Result, Args>(invitation
: ERef
<Invitation
<Result
, Args
>>, proposal?
: Proposal
, paymentKeywordRecord?
: PaymentPKeywordRecord
, offerArgs?
: Args
) => Promise
<UserSeat
<Result
>>
To redeem an invitation, the user normally provides a proposal (their rules for the offer) as well as payments to be escrowed by Zoe. If either the proposal or payments would be empty, indicate this by omitting that argument or passing undefined, rather than passing an empty record.
The proposal has three parts: want
and give
are used by Zoe to enforce offer safety, and exit
is used to specify the particular payout-liveness policy that Zoe can guarantee. want
and give
are objects with keywords as keys and amounts as values. paymentKeywordRecord
is a record with keywords as keys, and the values are the actual payments to be escrowed. A payment is expected for every rule under give
.
Type declaration
▸ <Result
, Args
>(invitation
, proposal?
, paymentKeywordRecord?
, offerArgs?
): Promise
<UserSeat
<Result
>>
Type parameters
Name | Type |
---|---|
Result | Result |
Args | undefined |
Parameters
Name | Type |
---|---|
invitation | ERef <Invitation <Result , Args >> |
proposal? | Proposal |
paymentKeywordRecord? | PaymentPKeywordRecord |
offerArgs? | Args |
Returns
Promise
<UserSeat
<Result
>>
Defined in
zoe/src/zoeService/types.js:157
PaymentKeywordRecord
Ƭ PaymentKeywordRecord: Record
<Keyword
, Payment
<any
>>
Defined in
zoe/src/zoeService/types.js:292
PaymentPKeywordRecord
Ƭ PaymentPKeywordRecord: Record
<Keyword
, ERef
<Payment
<any
>>>
Defined in
zoe/src/zoeService/types.js:291
Proposal
Ƭ Proposal: Partial
<ProposalRecord
>
Defined in
zoe/src/zoeService/types.js:226
ProposalRecord
Ƭ ProposalRecord: Object
Type declaration
Name | Type |
---|---|
exit | ExitRule |
give | AmountKeywordRecord |
want | AmountKeywordRecord |
Defined in
zoe/src/zoeService/types.js:231
SetOfferFilter
Ƭ SetOfferFilter: (instance
: Instance
, strings
: string
[]) => any
Type declaration
▸ (instance
, strings
): any
Parameters
Name | Type |
---|---|
instance | Instance |
strings | string [] |
Returns
any
Defined in
zoe/src/zoeService/types.js:86
SourceBundle
Ƭ SourceBundle: Record
<string
, any
>
Opaque type for a JSONable source bundle
Defined in
zoe/src/zoeService/types.js:286
ZCFSpec
Ƭ ZCFSpec: { bundleCap
: @agoric/swingset-vat
} | { name
: string
} | { id
: BundleID
}