API documentation of Agoric SDK / Exports / @agoric/smart-wallet / types

Module: types

Table of contents

Type Aliases

• BridgeActionCapData
• Cell
• InvitationMakers
• OfferMaker
• Petname
• PublicSubscribers
• WalletActionMsg
• WalletBridgeMsg
• WalletSpendActionMsg

Variables

• CapDataShape

Type Aliases

BridgeActionCapData

Ƭ BridgeActionCapData: WalletCapData<smartWallet>

Defined in

types.d.ts:36

---

Cell

Ƭ Cell<T>: Object

Type parameters

Name
T

Type declaration

Name	Type
get	() => T
set	(val: T) => void

Defined in

types.d.ts:31

---

InvitationMakers

Ƭ InvitationMakers: Record<string, (...args: any[]) => Promise<Invitation>>

Defined in

types.d.ts:24

---

OfferMaker

Ƭ OfferMaker: (agoricNames: AgoricNamesRemotes, ...rest: any[]) => OfferSpec

Used for clientSupport helpers

Type declaration

▸ (agoricNames, ...rest): OfferSpec

Parameters

Name	Type
agoricNames	AgoricNamesRemotes
...rest	any[]

Returns

OfferSpec

Defined in

types.d.ts:82

---

Petname

Ƭ Petname: string | string[]

A petname can either be a plain string or a path for which the first element is a petname for the origin, and the rest of the elements are a snapshot of the names that were first given by that origin. We are migrating away from using plain strings, for consistency.

Defined in

types.d.ts:22

---

PublicSubscribers

Ƭ PublicSubscribers: Record<string, ERef<StoredFacet>>

Defined in

types.d.ts:29

---

WalletActionMsg

Ƭ WalletActionMsg: Object

Defined by walletAction struct in msg_server.go

See

and walletSpendAction in msg_server.go

Type declaration

Name	Type	Description
action	string	JSON of BridgeActionCapData
blockHeight	unknown	-
blockTime	unknown	-
owner	string	base64 of Uint8Array of bech32 data
type	"WALLET_ACTION"	-

Defined in

types.d.ts:45

---

WalletBridgeMsg

Ƭ WalletBridgeMsg: WalletActionMsg | WalletSpendActionMsg

Messages transmitted over Cosmos chain, cryptographically verifying that the message came from the 'owner'.

The two wallet actions are distinguished by whether the user had to confirm the sending of the message (as is the case for WALLET_SPEND_ACTION).

Defined in

types.d.ts:77

---

WalletSpendActionMsg

Ƭ WalletSpendActionMsg: Object

Defined by walletSpendAction struct in msg_server.go

See

and walletSpendAction in msg_server.go

Type declaration

Name	Type	Description
blockHeight	unknown	-
blockTime	unknown	-
owner	string	base64 of Uint8Array of bech32 data
spendAction	string	JSON of BridgeActionCapData
type	"WALLET_SPEND_ACTION"	-

Defined in

types.d.ts:60

Variables

CapDataShape

• Const CapDataShape: unique symbol

Defined in

types.d.ts:14