API documentation of Agoric SDK / Exports / @agoric/zoe / src/zoeService/types / ZoeService
Interface: ZoeService
@agoric/zoe.src/zoeService/types.ZoeService
Zoe provides a framework for deploying and working with smart contracts. It is accessed as a long-lived and well-trusted service that enforces offer safety for the contracts that use it. Zoe has a single invitationIssuer for the entirety of its lifetime. By having a reference to Zoe, a user can get the invitationIssuer and thus validate any invitation they receive from someone else.
Zoe has two different facets: the public Zoe service and the contract facet (ZCF). Each contract instance has a copy of ZCF within its vat. The contract and ZCF never have direct access to the users' payments or the Zoe purses.
Table of contents
Properties
- getBrands
- getBundleIDFromInstallation
- getConfiguration
- getFeeIssuer
- getInstallation
- getInstallationForInstance
- getInstance
- getInvitationDetails
- getInvitationIssuer
- getIssuers
- getOfferFilter
- getProposalShapeForInvitation
- getPublicFacet
- getTerms
- install
- installBundleID
- offer
- startInstance
Properties
getBrands
• getBrands: GetBrands
Defined in
zoe/src/zoeService/types.js:35
getBundleIDFromInstallation
• getBundleIDFromInstallation: GetBundleIDFromInstallation
Defined in
zoe/src/zoeService/types.js:46
getConfiguration
• getConfiguration: GetConfiguration
Defined in
zoe/src/zoeService/types.js:45
getFeeIssuer
• getFeeIssuer: GetFeeIssuer
Defined in
zoe/src/zoeService/types.js:44
getInstallation
• getInstallation: GetInstallation
Defined in
zoe/src/zoeService/types.js:40
getInstallationForInstance
• getInstallationForInstance: GetInstallationForInstance
Defined in
zoe/src/zoeService/types.js:38
getInstance
• getInstance: GetInstance
Defined in
zoe/src/zoeService/types.js:39
getInvitationDetails
• getInvitationDetails: GetInvitationDetails
Return an object with the instance, installation, description, invitation handle, and any custom properties specific to the contract.
Defined in
zoe/src/zoeService/types.js:41
getInvitationIssuer
• getInvitationIssuer: GetInvitationIssuer
Zoe has a single invitationIssuer for the entirety of its lifetime. By having a reference to Zoe, a user can get the invitationIssuer and thus validate any invitation they receive from someone else. The mint associated with the invitationIssuer creates the ERTP payments that represent the right to interact with a smart contract in particular ways.
Defined in
zoe/src/zoeService/types.js:20
getIssuers
• getIssuers: GetIssuers
Defined in
zoe/src/zoeService/types.js:34
getOfferFilter
• getOfferFilter: GetOfferFilter
Defined in
zoe/src/zoeService/types.js:37
getProposalShapeForInvitation
• getProposalShapeForInvitation: (invitationHandle: InvitationHandle) => any
Type declaration
▸ (invitationHandle): any
Parameters
| Name | Type |
|---|---|
invitationHandle | InvitationHandle |
Returns
any
Defined in
zoe/src/zoeService/types.js:47
getPublicFacet
• getPublicFacet: GetPublicFacet
Defined in
zoe/src/zoeService/types.js:33
getTerms
• getTerms: GetTerms
Defined in
zoe/src/zoeService/types.js:36
install
• install: InstallBundle
Defined in
zoe/src/zoeService/types.js:29
installBundleID
• installBundleID: InstallBundleID
Defined in
zoe/src/zoeService/types.js:30
offer
• offer: Offer
Defined in
zoe/src/zoeService/types.js:32
startInstance
• startInstance: StartInstance