API documentation of Agoric SDK / Exports / @agoric/vats / src/core/types-ambient
Module: src/core/types-ambient
Table of contents
Type Aliases
- AgoricNamesVat
- BankManager
- BankVat
- BoardVat
- BootDevices
- BootstrapPowers
- BootstrapSpace
- BootstrapVatParams
- BridgeDevice
- ChainBootstrapSpace
- ChainBootstrapSpaceT
- ChainDevices
- ChainStorageVat
- ChainStorageVatParams
- ClientCreator
- ClientFacet
- ClientManager
- ClientProvider
- CommandDevice
- CommsVatRoot
- ContractInstallationPromises
- CreateUserBundle
- DProxy
- DemoFaucetPowers
- Device
- HttpVat
- IBCVat
- MailboxDevice
- MintsVat
- NamedVatPowers
- NetworkVat
- PluginDevice
- PriceAuthorityVat
- Producer
- PromiseSpaceOf
- PropertyMaker
- ProvisioningVat
- RemoteIssuerKit
- SoloDevices
- SoloVats
- SpawnerVat
- StartGovernedUpgradable
- StartGovernedUpgradableOpts
- StartUpgradable
- StartUpgradableOpts
- StartedInstanceKit
- StartedInstanceKitWithLabel
- SwingsetVats
- TimerDevice
- TimerVat
- UploadsVat
- VatAdminDevice
- VatAdminVat
- VatLoader
- VatSourceRef
- VattpVat
- WellKnownName
- WellKnownSpaces
Type Aliases
AgoricNamesVat
Ƭ AgoricNamesVat: ERef
<ReturnType
<buildRootObject
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:444
BankManager
Ƭ BankManager: Awaited
<ReturnType
<Awaited
<BankVat
>["makeBankManager"
]>>
Defined in
packages/vats/src/core/types-ambient.d.ts:456
BankVat
Ƭ BankVat: ERef
<ReturnType
<buildRootObject
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:447
BoardVat
Ƭ BoardVat: ERef
<ReturnType
<buildRootObject
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:450
BootDevices
Ƭ BootDevices<T
>: Object
Type parameters
Name |
---|
T |
Type declaration
Name | Type |
---|---|
devices | T |
vatPowers | { D : DProxy } |
vatPowers.D | DProxy |
Defined in
packages/vats/src/core/types-ambient.d.ts:9
BootstrapPowers
Ƭ BootstrapPowers: BootstrapSpace
& { devices
: SoloDevices
| ChainDevices
; modules
: BootstrapModules
; runBehaviors
: (manifest
: unknown
) => Promise
<unknown
> ; vatParameters
: BootstrapVatParams
; vatPowers
: { [prop: string]
: any
; D
: DProxy
} ; vats
: SwingsetVats
; zone
: @agoric/zone
}
Defined in
packages/vats/src/core/types-ambient.d.ts:394
BootstrapSpace
Ƭ BootstrapSpace: WellKnownSpaces
& PromiseSpaceOf
<ChainBootstrapSpaceT
& { vatAdminSvc
: VatAdminSvc
}, {}, { loadCriticalVat
: VatLoader
<unknown
> ; loadVat
: VatLoader
<unknown
> }>
Defined in
packages/vats/src/core/types-ambient.d.ts:404
BootstrapVatParams
Ƭ BootstrapVatParams: Object
Type declaration
Name | Type |
---|---|
argv | { FIXME_GCI : string ; PROVISIONER_INDEX? : number ; hardcodedClientAddresses? : string [] } |
argv.FIXME_GCI | string |
argv.PROVISIONER_INDEX? | number |
argv.hardcodedClientAddresses? | string [] |
Defined in
packages/vats/src/core/types-ambient.d.ts:386
BridgeDevice
Ƭ BridgeDevice: Device
<ReturnType
<buildRootDeviceNode
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:11
ChainBootstrapSpace
Ƭ ChainBootstrapSpace: PromiseSpaceOf
<ChainBootstrapSpaceT
>
Defined in
packages/vats/src/core/types-ambient.d.ts:384
ChainBootstrapSpaceT
Ƭ ChainBootstrapSpaceT: Object
Type declaration
Name | Type | Description |
---|---|---|
agoricNames | NameHub | - |
agoricNamesAdmin | index | - |
bankManager | BankManager | - |
bldIssuerKit | RemoteIssuerKit | - |
board | index | - |
bridgeManager | BridgeManager | undefined | - |
chainStorage | StorageNode | null | - |
chainTimerService | TimerService | - |
client | ClientManager | - |
clientCreator | any | - |
contractKits | MapStore <Instance , StartedInstanceKitWithLabel > | kits stored by startUpgradable |
coreEvalBridgeHandler | BridgeHandler | - |
diagnostics | { savePrivateArgs : (instance : Instance , privateArgs : unknown ) => void } | Utilities to support debugging |
diagnostics.savePrivateArgs | (instance : Instance , privateArgs : unknown ) => void | - |
feeMintAccess | FeeMintAccess | Super powerful ability to mint IST. ("License to print money") |
governedContractKits | MapStore <Instance , GovernanceFacetKit <any > & { label : string }> | kits stored by startGovernedUpgradable |
highPrioritySendersManager | PrioritySendersManager | undefined | null | - |
initialSupply | Payment <"nat" > | - |
instancePrivateArgs | Map <Instance , unknown > | Very powerful. Has the private args for critical contract instances such as Vault Factory. ONLY FOR DISASTER RECOVERY |
mints? | MintsVat | - |
namesByAddress | NameHub | - |
namesByAddressAdmin | NamesByAddressAdmin | - |
pegasusConnections | index | - |
pegasusConnectionsAdmin | index | - |
priceAuthority | PriceAuthority | - |
priceAuthorityAdmin | PriceAuthorityRegistryAdmin | - |
priceAuthorityVat | Awaited <PriceAuthorityVat > | - |
provisionBridgeManager | ScopedBridgeManager | undefined | - |
provisionPoolStartResult | GovernanceFacetKit <start > | - |
provisionWalletBridgeManager | ScopedBridgeManager | undefined | - |
provisioning | Awaited <ProvisioningVat > | undefined | - |
startGovernedUpgradable | StartGovernedUpgradable | Convience function for starting contracts governed by the Econ Committee |
startUpgradable | StartUpgradable | Convienence function for starting a contract (ungoverned) and saving its facets (including adminFacet) |
storageBridgeManager | ScopedBridgeManager | undefined | - |
testFirstAnchorKit | AssetIssuerKit | Used only for testing. Should not appear in any production proposals. |
vatStore | VatStore | - |
vatUpgradeInfo | MapStore | - |
walletBridgeManager | ScopedBridgeManager | undefined | - |
walletFactoryStartResult | WalletFactoryStartResult | - |
zoe | ZoeService | - |
Defined in
packages/vats/src/core/types-ambient.d.ts:311
ChainDevices
Ƭ ChainDevices: Object
Type declaration
Name | Type |
---|---|
bridge? | BridgeDevice |
mailbox | MailboxDevice |
timer | TimerDevice |
vatAdmin | VatAdminDevice |
Defined in
packages/vats/src/core/types-ambient.d.ts:93
ChainStorageVat
Ƭ ChainStorageVat: ERef
<ReturnType
<buildRootObject
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:453
ChainStorageVatParams
Ƭ ChainStorageVatParams: Object
Type declaration
Name | Type |
---|---|
vatParameters | { chainStorageEntries? : [k: string, v: string][] } |
vatParameters.chainStorageEntries? | [k: string, v: string][] |
Defined in
packages/vats/src/core/types-ambient.d.ts:81
ClientCreator
Ƭ ClientCreator: Object
Type declaration
Name | Type |
---|---|
createUserBundle | CreateUserBundle |
createClientFacet | (nickname : string , clientAddress : string , powerFlags : string []) => Promise <ClientFacet > |
Defined in
packages/vats/src/core/types-ambient.d.ts:151
ClientFacet
Ƭ ClientFacet: Object
Type declaration
Name | Type |
---|---|
getChainBundle | () => ERef <Record <string , any >> |
getConfiguration | () => AsyncIterable <{ clientAddress : string ; clientHome : Record <string , any > }> |
Defined in
packages/vats/src/core/types-ambient.d.ts:137
ClientManager
Ƭ ClientManager: Object
tool to put properties onto the home
object of the client
Type declaration
Name | Type |
---|---|
assignBundle | (ps : PropertyMaker []) => void |
Defined in
packages/vats/src/core/types-ambient.d.ts:118
ClientProvider
Ƭ ClientProvider: Object
Type declaration
Name | Type |
---|---|
getChainBundle | () => unknown |
getChainConfigNotifier | () => Notifier <unknown > |
Defined in
packages/vats/src/core/types-ambient.d.ts:100
CommandDevice
Ƭ CommandDevice: Device
<ReturnType
<buildRootDeviceNode
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:17
CommsVatRoot
Ƭ CommsVatRoot: ERef
<{ addEgress
: (addr
: string
, ix
: number
, provider
: unknown
) => void
; addIngress
: (remoteID
: string
, remoteRefID
: number
, label?
: string
) => Promise
<any
> ; addRemote
: (name
: string
, tx
: unknown
, rx
: unknown
) => void
}>
Defined in
packages/vats/src/core/types-ambient.d.ts:64
ContractInstallationPromises
Ƭ ContractInstallationPromises<StartFns
>: { [Property in keyof StartFns]: Promise<Installation<StartFns[Property]>> }
Type parameters
Name |
---|
StartFns |
Defined in
packages/vats/src/core/types-ambient.d.ts:202
CreateUserBundle
Ƭ CreateUserBundle: (nickname
: string
, clientAddress
: string
, powerFlags
: string
[]) => Promise
<Record
<string
, Promise
<any
>>>
Type declaration
▸ (nickname
, clientAddress
, powerFlags
): Promise
<Record
<string
, Promise
<any
>>>
Parameters
Name | Type |
---|---|
nickname | string |
clientAddress | string |
powerFlags | string [] |
Returns
Promise
<Record
<string
, Promise
<any
>>>
Defined in
packages/vats/src/core/types-ambient.d.ts:131
DProxy
Ƭ DProxy<T
>: (target
: Device
<T
>) => T
(approximately)
Type parameters
Name | Type |
---|---|
T | any |
Type declaration
▸ (target
): T
Parameters
Name | Type |
---|---|
target | Device <T > |
Returns
T
Defined in
packages/vats/src/core/types-ambient.d.ts:7
DemoFaucetPowers
Ƭ DemoFaucetPowers: PromiseSpaceOf
<{ mints
: MintsVat
}>
Defined in
packages/vats/src/core/types-ambient.d.ts:458
Device
Ƭ Device<T
>: "Device"
& { __deviceType__
: T
}
This type conflicts with packages/SwingSet/src/vats/plugin-manager.js
Type parameters
Name |
---|
T |
Defined in
packages/vats/src/core/types-ambient.d.ts:4
HttpVat
Ƭ HttpVat: ERef
<ReturnType
<buildRootObject
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:474
IBCVat
Ƭ IBCVat: ERef
<ReturnType
<buildRootObject
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:431
MailboxDevice
Ƭ MailboxDevice: Device
<ReturnType
<buildRootDeviceNode
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:23
MintsVat
Ƭ MintsVat: ERef
<ReturnType
<buildRootObject
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:420
NamedVatPowers
Ƭ NamedVatPowers: Object
Type declaration
Name | Type |
---|---|
namedVat | PromiseSpaceOf <{ agoricNames : Awaited <AgoricNamesVat > ; board : Awaited <BoardVat > }> |
Defined in
packages/vats/src/core/types-ambient.d.ts:432
NetworkVat
Ƭ NetworkVat: ERef
<ReturnType
<buildRootObject
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:428
PluginDevice
Ƭ PluginDevice: Device
<ReturnType
<buildRootDeviceNode
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:29
PriceAuthorityVat
Ƭ PriceAuthorityVat: ERef
<ReturnType
<buildRootObject
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:424
Producer
Ƭ Producer<T
>: Object
Type parameters
Name |
---|
T |
Type declaration
Name | Type |
---|---|
reject | (r : unknown ) => void |
reset | (reason? : unknown ) => void |
resolve | (v : ERef <T >) => void |
Defined in
packages/vats/src/core/types-ambient.d.ts:105
PromiseSpaceOf
Ƭ PromiseSpaceOf<B
, C
, P
>: Object
Type parameters
Name | Type | Description |
---|---|---|
B | B | Bidirectional |
C | {} | Consume only |
P | {} | Produce only |
Type declaration
Name | Type |
---|---|
consume | { [K in keyof (B & C)]: Promise<(B & C)[K]> } |
produce | { [K in keyof (B & P)]: Producer<(B & P)[K]> } |
Defined in
packages/vats/src/core/types-ambient.d.ts:126
PropertyMaker
Ƭ PropertyMaker: (addr
: string
, flags
: string
[]) => Record
<string
, unknown
>
callback to assign a property onto the home
object of the client
Type declaration
▸ (addr
, flags
): Record
<string
, unknown
>
Parameters
Name | Type |
---|---|
addr | string |
flags | string [] |
Returns
Record
<string
, unknown
>
Defined in
packages/vats/src/core/types-ambient.d.ts:115
ProvisioningVat
Ƭ ProvisioningVat: ERef
<ReturnType
<buildRootObject
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:416
RemoteIssuerKit
Ƭ RemoteIssuerKit: Object
Type declaration
Name | Type |
---|---|
brand | Brand |
issuer | ERef <Issuer > |
mint | ERef <Mint > |
Defined in
packages/vats/src/core/types-ambient.d.ts:439
SoloDevices
Ƭ SoloDevices: Object
Type declaration
Name | Type |
---|---|
command | CommandDevice |
mailbox | MailboxDevice |
plugin | PluginDevice |
timer | TimerDevice |
vatAdmin | VatAdminDevice |
Defined in
packages/vats/src/core/types-ambient.d.ts:85
SoloVats
Ƭ SoloVats: Object
Type declaration
Name | Type |
---|---|
bootstrap | unknown |
http | HttpVat |
network | NetworkVat |
spawner | SpawnerVat |
uploads | UploadsVat |
Defined in
packages/vats/src/core/types-ambient.d.ts:462
SpawnerVat
Ƭ SpawnerVat: ERef
<ReturnType
<buildRootObject
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:470
StartGovernedUpgradable
Ƭ StartGovernedUpgradable: <SF>(opts
: StartGovernedUpgradableOpts
<SF
>) => Promise
<GovernanceFacetKit
<SF
>>
Type declaration
▸ <SF
>(opts
): Promise
<GovernanceFacetKit
<SF
>>
Type parameters
Name | Type |
---|---|
SF | extends GovernableStartFn |
Parameters
Name | Type |
---|---|
opts | StartGovernedUpgradableOpts <SF > |
Returns
Promise
<GovernanceFacetKit
<SF
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:275
StartGovernedUpgradableOpts
Ƭ StartGovernedUpgradableOpts<SF
>: Object
Type parameters
Name | Type |
---|---|
SF | extends GovernableStartFn |
Type declaration
Name | Type |
---|---|
governedParams | Record <string , unknown > |
installation | ERef <Installation <SF >> |
issuerKeywordRecord? | IssuerKeywordRecord |
label | string |
privateArgs | Omit <src/zoeService/utils ["privateArgs" ], "initialPoserInvitation" > |
terms | Omit <src/zoeService/utils ["terms" ], "brands" | "issuers" | "governedParams" | "electionManager" > |
Defined in
packages/vats/src/core/types-ambient.d.ts:260
StartUpgradable
Ƭ StartUpgradable: <SF>(opts
: StartUpgradableOpts
<SF
>) => Promise
<src/zoeService/utils
& { label
: string
}>
Type declaration
▸ <SF
>(opts
): Promise
<src/zoeService/utils
& { label
: string
}>
Type parameters
Name | Type |
---|---|
SF | extends src/zoeService/utils |
Parameters
Name | Type |
---|---|
opts | StartUpgradableOpts <SF > |
Returns
Promise
<src/zoeService/utils
& { label
: string
}>
Defined in
packages/vats/src/core/types-ambient.d.ts:292
StartUpgradableOpts
Ƭ StartUpgradableOpts<SF
>: Object
Type parameters
Name | Type |
---|---|
SF | extends src/zoeService/utils |
Type declaration
Name | Type |
---|---|
installation | ERef <Installation <SF >> |
issuerKeywordRecord? | IssuerKeywordRecord |
label | string |
privateArgs? | Parameters <SF >[1 ] |
terms? | Omit <src/zoeService/utils ["terms" ], "brands" | "issuers" > |
Defined in
packages/vats/src/core/types-ambient.d.ts:279
StartedInstanceKit
Ƭ StartedInstanceKit<T
>: src/zoeService/utils
Type parameters
Name |
---|
T |
Defined in
packages/vats/src/core/types-ambient.d.ts:302
StartedInstanceKitWithLabel
Ƭ StartedInstanceKitWithLabel: { label
: string
} & StartedInstanceKit
<src/zoeService/utils
>
Defined in
packages/vats/src/core/types-ambient.d.ts:305
SwingsetVats
Ƭ SwingsetVats: Object
Type declaration
Name | Type |
---|---|
comms | CommsVatRoot |
timer | TimerVat |
vatAdmin | VatAdminVat |
vattp | VattpVat |
Defined in
packages/vats/src/core/types-ambient.d.ts:74
TimerDevice
Ƭ TimerDevice: Device
<ReturnType
<buildRootDeviceNode
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:35
TimerVat
Ƭ TimerVat: ERef
<ReturnType
<buildRootObject
>>
See
deliverToController in packages/SwingSet/src/vats/comms/controller.js
Defined in
packages/vats/src/core/types-ambient.d.ts:58
UploadsVat
Ƭ UploadsVat: ERef
<ReturnType
<buildRootObject
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:478
VatAdminDevice
Ƭ VatAdminDevice: Device
<VatAdminRootDeviceNode
>
Defined in
packages/vats/src/core/types-ambient.d.ts:41
VatAdminVat
Ƭ VatAdminVat: ERef
<ReturnType
<buildRootObject
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:51
VatLoader
Ƭ VatLoader<T
>: (name
: string
, sourceRef?
: VatSourceRef
) => T
Type parameters
Name |
---|
T |
Type declaration
▸ (name
, sourceRef?
): T
Parameters
Name | Type |
---|---|
name | string |
sourceRef? | VatSourceRef |
Returns
T
Defined in
packages/vats/src/core/types-ambient.d.ts:112
VatSourceRef
Ƭ VatSourceRef: Object
Type declaration
Name | Type |
---|---|
bundleID? | string |
bundleName? | string |
Defined in
packages/vats/src/core/types-ambient.d.ts:111
VattpVat
Ƭ VattpVat: ERef
<ReturnType
<buildRootObject
>>
Defined in
packages/vats/src/core/types-ambient.d.ts:45
WellKnownName
Ƭ WellKnownName: Object
Type declaration
Name | Type |
---|---|
installation | "centralSupply" | "mintHolder" | "walletFactory" | "provisionPool" | "auctioneer" | "feeDistributor" | "contractGovernor" | "committee" | "noActionElectorate" | "binaryVoteCounter" | "VaultFactory" | "liquidate" | "Pegasus" | "reserve" | "psm" | "scaledPriceAuthority" | "stakeBld" | "econCommitteeCharter" | "priceAggregator" |
instance | "economicCommittee" | "feeDistributor" | "auctioneer" | "VaultFactory" | "VaultFactoryGovernor" | "econCommitteeCharter" | "walletFactory" | "provisionPool" | "reserve" | "reserveGovernor" | "stakeBld" | "Pegasus" |
issuer | TokenKeyword | "Invitation" | "AUSD" |
oracleBrand | "USD" |
uiConfig | "VaultFactory" |
Defined in
packages/vats/src/core/types-ambient.d.ts:160
WellKnownSpaces
Ƭ WellKnownSpaces: Object
Type declaration
Name | Type |
---|---|
brand | { consume : Record <WellKnownName ["issuer" ], Promise <Brand >> & { BLD : Promise <Brand <"nat" >> ; IST : Promise <Brand <"nat" >> ; timer : Producer <TimerBrand > } ; produce : Record <WellKnownName ["issuer" ], Producer <Brand >> & { timer : Producer <TimerBrand > } } |
brand.consume | Record <WellKnownName ["issuer" ], Promise <Brand >> & { BLD : Promise <Brand <"nat" >> ; IST : Promise <Brand <"nat" >> ; timer : Producer <TimerBrand > } |
brand.produce | Record <WellKnownName ["issuer" ], Producer <Brand >> & { timer : Producer <TimerBrand > } |
installation | { consume : Record <WellKnownName ["installation" ], Promise <Installation <unknown >>> & ContractInstallationPromises <{ VaultFactory : start ; auctioneer : start ; centralSupply : start ; committee : start ; contractGovernor : start ; econCommitteeCharter : start ; feeDistributor : start ; mintHolder : start ; provisionPool : start ; psm : start ; reserve : start ; walletFactory : walletFactory }> ; produce : Record <WellKnownName ["installation" ], Producer <Installation >> } |
installation.consume | Record <WellKnownName ["installation" ], Promise <Installation <unknown >>> & ContractInstallationPromises <{ VaultFactory : start ; auctioneer : start ; centralSupply : start ; committee : start ; contractGovernor : start ; econCommitteeCharter : start ; feeDistributor : start ; mintHolder : start ; provisionPool : start ; psm : start ; reserve : start ; walletFactory : walletFactory }> |
installation.produce | Record <WellKnownName ["installation" ], Producer <Installation >> |
instance | { consume : Record <WellKnownName ["instance" ], Promise <Instance >> ; produce : Record <WellKnownName ["instance" ], Producer <Instance >> } |
instance.consume | Record <WellKnownName ["instance" ], Promise <Instance >> |
instance.produce | Record <WellKnownName ["instance" ], Producer <Instance >> |
issuer | { consume : Record <WellKnownName ["issuer" ], Promise <Issuer >> & { BLD : Promise <Issuer <"nat" >> ; IST : Promise <Issuer <"nat" >> } ; produce : Record <WellKnownName ["issuer" ], Producer <Issuer >> } |
issuer.consume | Record <WellKnownName ["issuer" ], Promise <Issuer >> & { BLD : Promise <Issuer <"nat" >> ; IST : Promise <Issuer <"nat" >> } |
issuer.produce | Record <WellKnownName ["issuer" ], Producer <Issuer >> |
oracleBrand | { consume : Record <WellKnownName ["oracleBrand" ], Promise <Brand >> ; produce : Record <WellKnownName ["oracleBrand" ], Producer <Brand >> } |
oracleBrand.consume | Record <WellKnownName ["oracleBrand" ], Promise <Brand >> |
oracleBrand.produce | Record <WellKnownName ["oracleBrand" ], Producer <Brand >> |
uiConfig | { consume : Record <WellKnownName ["uiConfig" ], Promise <Record <string , any >>> ; produce : Record <WellKnownName ["uiConfig" ], Producer <Record <string , any >>> } |
uiConfig.consume | Record <WellKnownName ["uiConfig" ], Promise <Record <string , any >>> |
uiConfig.produce | Record <WellKnownName ["uiConfig" ], Producer <Record <string , any >>> |