API documentation of Agoric SDK / Exports / @agoric/zoe / src/zoeService/zoe
Module: src/zoeService/zoe
Table of contents
Type Aliases
Functions
Type Aliases
ZoeKit
Ƭ ZoeKit: ReturnType<typeof makeDurableZoeKit>
Defined in
Functions
makeDurableZoeKit
▸ makeDurableZoeKit(options): Object
Create a durable instance of Zoe.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
options | Object | undefined | - |
options.feeIssuerConfig | undefined | FeeIssuerConfig | defaultFeeIssuerConfig | - |
options.shutdownZoeVat | undefined | ShutdownWithFailure | undefined | a function to shutdown the Zoe Vat. This function needs to use the vatPowers available to a vat. |
options.vatAdminSvc | undefined | VatAdminSvc | Promise<VatAdminSvc> | undefined | The vatAdmin Service, which carries the power to create a new vat. If it's not available when makeZoe() is called, it must be provided later using setVatAdminService(). |
options.zcfSpec | undefined | ZCFSpec | undefined | Pointer to the contract facet bundle. |
options.zoeBaggage | Baggage | undefined | the baggage for Zoe durability. Must be provided by caller |
Returns
Object
| Name | Type |
|---|---|
feeMintAccess | FeeMintAccess |
setVatAdminService | (lateVatAdminSvc: any) => void & RemotableBrand<{}, (lateVatAdminSvc: any) => void> |
zoeConfigFacet | Guarded<{ updateZcfBundleId: (bundleId: any) => void }> |
zoeService | ZoeService |
Defined in
makeZoeKit
▸ makeZoeKit(vatAdminSvc?, shutdownZoeVat?, feeIssuerConfig?, zcfSpec?): Object
Parameters
| Name | Type | Description |
|---|---|---|
vatAdminSvc? | VatAdminSvc | Promise<VatAdminSvc> | The vatAdmin Service, which carries the power to create a new vat. If it's not available when makeZoe() is called, it must be provided later using setVatAdminService(). |
shutdownZoeVat? | ShutdownWithFailure | a function to shutdown the Zoe Vat. This function needs to use the vatPowers available to a vat. |
feeIssuerConfig? | FeeIssuerConfig | - |
zcfSpec? | ZCFSpec | Pointer to the contract facet bundle. |
Returns
Object
| Name | Type |
|---|---|
feeMintAccess | FeeMintAccess |
setVatAdminService | (lateVatAdminSvc: any) => void & RemotableBrand<{}, (lateVatAdminSvc: any) => void> |
zoeConfigFacet | Guarded<{ updateZcfBundleId: (bundleId: any) => void }> |
zoeService | ZoeService |
Deprecated
Create an instance of Zoe.
This will fail upgrades and should only be used in tests through the helper makeZoeKitForTest.