API documentation of Agoric SDK / Exports / @agoric/smart-wallet / invitations
Module: invitations
Table of contents
Type Aliases
- AgoricContractInvitationSpec
- ContinuingInvitationSpec
- ContractInvitationSpec
- InvitationSpec
- InvitationsPurseQuery
- PurseInvitationSpec
Functions
Type Aliases
AgoricContractInvitationSpec
Ƭ AgoricContractInvitationSpec: Object
source of invitation is a chain of calls starting with an agoricName
- the start of the pipe is a lookup of instancePath within agoricNames
- each entry in the callPipe executes a call on the preceding result
- the end of the pipe is expected to return an Invitation
Type declaration
| Name | Type |
|---|---|
callPipe | [methodName: string, methodArgs?: any[]][] |
instancePath | string[] |
source | "agoricContract" |
Defined in
ContinuingInvitationSpec
Ƭ ContinuingInvitationSpec: Object
continuing invitation in which the offer result from a previous invitation had an invitationMakers property
Type declaration
| Name | Type |
|---|---|
invitationArgs? | any[] |
invitationMakerName | string |
previousOffer | offers |
source | "continuing" |
Defined in
ContractInvitationSpec
Ƭ ContractInvitationSpec: Object
source is a contract (in which case this takes an Instance to look up in zoe)
Type declaration
| Name | Type |
|---|---|
instance | Instance |
invitationArgs? | any[] |
publicInvitationMaker | string |
source | "contract" |
Defined in
InvitationSpec
Ƭ InvitationSpec: AgoricContractInvitationSpec | ContractInvitationSpec | PurseInvitationSpec | ContinuingInvitationSpec
Specify how to produce an invitation. See each type in the union for details.
Defined in
InvitationsPurseQuery
Ƭ InvitationsPurseQuery: Pick<InvitationDetails, "description" | "instance">
Defined in
PurseInvitationSpec
Ƭ PurseInvitationSpec: Object
the invitation is already in your Zoe "invitation" purse so we need to query it
- use the find/query invitation by kvs thing
Type declaration
| Name | Type |
|---|---|
description | string |
instance | Instance |
source | "purse" |
Defined in
Functions
makeInvitationsHelper
▸ makeInvitationsHelper(zoe, agoricNames, invitationBrand, invitationsPurse, getInvitationContinuation): (spec: InvitationSpec) => ERef<Invitation<unknown, undefined>>
Parameters
| Name | Type |
|---|---|
zoe | ERef<ZoeService> |
agoricNames | ERef<NameHub> |
invitationBrand | Brand<"set"> |
invitationsPurse | Purse<"set"> |
getInvitationContinuation | (fromOfferId: string) => InvitationMakers |
Returns
fn
▸ (spec): ERef<Invitation<unknown, undefined>>
Parameters
| Name | Type |
|---|---|
spec | InvitationSpec |
Returns
ERef<Invitation<unknown, undefined>>