Skip to content

API documentation of Agoric SDK / Exports / @agoric/vats / src/core/types-ambient

Module: src/core/types-ambient

Table of contents

Type Aliases

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

NameType
devicesT
vatPowers{ D: DProxy }
vatPowers.DDProxy

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

NameType
argv{ FIXME_GCI: string ; PROVISIONER_INDEX?: number ; hardcodedClientAddresses?: string[] }
argv.FIXME_GCIstring
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

NameTypeDescription
agoricNamesNameHub-
agoricNamesAdminindex-
bankManagerBankManager-
bldIssuerKitRemoteIssuerKit-
boardindex-
bridgeManagerBridgeManager | undefined-
chainStorageStorageNode | null-
chainTimerServiceTimerService-
clientClientManager-
clientCreatorany-
contractKitsMapStore<Instance, StartedInstanceKitWithLabel>kits stored by startUpgradable
coreEvalBridgeHandlerBridgeHandler-
diagnostics{ savePrivateArgs: (instance: Instance, privateArgs: unknown) => void }Utilities to support debugging
diagnostics.savePrivateArgs(instance: Instance, privateArgs: unknown) => void-
feeMintAccessFeeMintAccessSuper powerful ability to mint IST. ("License to print money")
governedContractKitsMapStore<Instance, GovernanceFacetKit<any> & { label: string }>kits stored by startGovernedUpgradable
highPrioritySendersManagerPrioritySendersManager | undefined | null-
initialSupplyPayment<"nat">-
instancePrivateArgsMap<Instance, unknown>Very powerful. Has the private args for critical contract instances such as Vault Factory. ONLY FOR DISASTER RECOVERY
mints?MintsVat-
namesByAddressNameHub-
namesByAddressAdminNamesByAddressAdmin-
pegasusConnectionsindex-
pegasusConnectionsAdminindex-
priceAuthorityPriceAuthority-
priceAuthorityAdminPriceAuthorityRegistryAdmin-
priceAuthorityVatAwaited<PriceAuthorityVat>-
provisionBridgeManagerScopedBridgeManager | undefined-
provisionPoolStartResultGovernanceFacetKit<start>-
provisionWalletBridgeManagerScopedBridgeManager | undefined-
provisioningAwaited<ProvisioningVat> | undefined-
startGovernedUpgradableStartGovernedUpgradableConvience function for starting contracts governed by the Econ Committee
startUpgradableStartUpgradableConvienence function for starting a contract (ungoverned) and saving its facets (including adminFacet)
storageBridgeManagerScopedBridgeManager | undefined-
testFirstAnchorKitAssetIssuerKitUsed only for testing. Should not appear in any production proposals.
vatStoreVatStore-
vatUpgradeInfoMapStore-
walletBridgeManagerScopedBridgeManager | undefined-
walletFactoryStartResultWalletFactoryStartResult-
zoeZoeService-

Defined in

packages/vats/src/core/types-ambient.d.ts:311


ChainDevices

Ƭ ChainDevices: Object

Type declaration

NameType
bridge?BridgeDevice
mailboxMailboxDevice
timerTimerDevice
vatAdminVatAdminDevice

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

NameType
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

NameType
createUserBundleCreateUserBundle
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

NameType
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

NameType
assignBundle(ps: PropertyMaker[]) => void

Defined in

packages/vats/src/core/types-ambient.d.ts:118


ClientProvider

Ƭ ClientProvider: Object

Type declaration

NameType
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
NameType
nicknamestring
clientAddressstring
powerFlagsstring[]
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

NameType
Tany

Type declaration

▸ (target): T

Parameters
NameType
targetDevice<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

NameType
namedVatPromiseSpaceOf<{ 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

NameType
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

NameTypeDescription
BBBidirectional
C{}Consume only
P{}Produce only

Type declaration

NameType
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
NameType
addrstring
flagsstring[]
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

NameType
brandBrand
issuerERef<Issuer>
mintERef<Mint>

Defined in

packages/vats/src/core/types-ambient.d.ts:439


SoloDevices

Ƭ SoloDevices: Object

Type declaration

NameType
commandCommandDevice
mailboxMailboxDevice
pluginPluginDevice
timerTimerDevice
vatAdminVatAdminDevice

Defined in

packages/vats/src/core/types-ambient.d.ts:85


SoloVats

Ƭ SoloVats: Object

Type declaration

NameType
bootstrapunknown
httpHttpVat
networkNetworkVat
spawnerSpawnerVat
uploadsUploadsVat

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
NameType
SFextends GovernableStartFn
Parameters
NameType
optsStartGovernedUpgradableOpts<SF>
Returns

Promise<GovernanceFacetKit<SF>>

Defined in

packages/vats/src/core/types-ambient.d.ts:275


StartGovernedUpgradableOpts

Ƭ StartGovernedUpgradableOpts<SF>: Object

Type parameters

NameType
SFextends GovernableStartFn

Type declaration

NameType
governedParamsRecord<string, unknown>
installationERef<Installation<SF>>
issuerKeywordRecord?IssuerKeywordRecord
labelstring
privateArgsOmit<src/zoeService/utils["privateArgs"], "initialPoserInvitation">
termsOmit<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
NameType
SFextends src/zoeService/utils
Parameters
NameType
optsStartUpgradableOpts<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

NameType
SFextends src/zoeService/utils

Type declaration

NameType
installationERef<Installation<SF>>
issuerKeywordRecord?IssuerKeywordRecord
labelstring
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

NameType
commsCommsVatRoot
timerTimerVat
vatAdminVatAdminVat
vattpVattpVat

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
NameType
namestring
sourceRef?VatSourceRef
Returns

T

Defined in

packages/vats/src/core/types-ambient.d.ts:112


VatSourceRef

Ƭ VatSourceRef: Object

Type declaration

NameType
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

NameType
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"
issuerTokenKeyword | "Invitation" | "AUSD"
oracleBrand"USD"
uiConfig"VaultFactory"

Defined in

packages/vats/src/core/types-ambient.d.ts:160


WellKnownSpaces

Ƭ WellKnownSpaces: Object

Type declaration

NameType
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.consumeRecord<WellKnownName["issuer"], Promise<Brand>> & { BLD: Promise<Brand<"nat">> ; IST: Promise<Brand<"nat">> ; timer: Producer<TimerBrand> }
brand.produceRecord<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.consumeRecord<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.produceRecord<WellKnownName["installation"], Producer<Installation>>
instance{ consume: Record<WellKnownName["instance"], Promise<Instance>> ; produce: Record<WellKnownName["instance"], Producer<Instance>> }
instance.consumeRecord<WellKnownName["instance"], Promise<Instance>>
instance.produceRecord<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.consumeRecord<WellKnownName["issuer"], Promise<Issuer>> & { BLD: Promise<Issuer<"nat">> ; IST: Promise<Issuer<"nat">> }
issuer.produceRecord<WellKnownName["issuer"], Producer<Issuer>>
oracleBrand{ consume: Record<WellKnownName["oracleBrand"], Promise<Brand>> ; produce: Record<WellKnownName["oracleBrand"], Producer<Brand>> }
oracleBrand.consumeRecord<WellKnownName["oracleBrand"], Promise<Brand>>
oracleBrand.produceRecord<WellKnownName["oracleBrand"], Producer<Brand>>
uiConfig{ consume: Record<WellKnownName["uiConfig"], Promise<Record<string, any>>> ; produce: Record<WellKnownName["uiConfig"], Producer<Record<string, any>>> }
uiConfig.consumeRecord<WellKnownName["uiConfig"], Promise<Record<string, any>>>
uiConfig.produceRecord<WellKnownName["uiConfig"], Producer<Record<string, any>>>

Defined in

packages/vats/src/core/types-ambient.d.ts:206