Class HostAccountCeremony

An AccountCeremony hosted by the account creator. Adds the host-only ability to nudge co-signers who have not yet joined the huddle.

Obtained from Salt.createAccount. Co-signers who join an existing ceremony — via Salt.joinAccountCeremony or a NudgeListener nudge — receive a plain AccountCeremony, which has no nudge method: only the host that minted the session can announce it.

Example: Wire a nudge button while the huddle fills up

const ceremony = await salt.createAccount({ ... });
nudgeButton.onclick = () => ceremony.nudge();
const { account } = await ceremony.wait();

Hierarchy (View Summary)

AccountCeremony
- HostAccountCeremony

Index

Properties

`Readonly`sessionId

sessionId: string

MPC session ID for this ceremony.

`Static`prefixed

prefixed: string | boolean

Accessors

accountId

get accountId(): string
The account this ceremony is creating. Available before completion (e.g. during keygen), so consumers can act on the account mid-ceremony — notably to re-nudge co-signers who are not yet in the huddle.

Returns string
Inherited from AccountCeremony.accountId

isReady

get isReady(): boolean
true once all required parties are present.

Returns boolean
Inherited from AccountCeremony.isReady

onlineSigners

get onlineSigners(): string[]
Addresses currently present in the huddle, mapped from numeric party indices.

Returns string[]
Inherited from AccountCeremony.onlineSigners

Methods

addListener

addListener<T extends keyof AccountCeremonyEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<AccountCeremonyEvents>[Extract<
            T,
            keyof AccountCeremonyEvents,
        >],
    ) => void,
    context?: any,
): this
Type Parameters
- T extends keyof AccountCeremonyEvents
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<AccountCeremonyEvents>[Extract<
          T,
          keyof AccountCeremonyEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from AccountCeremony.addListener

emit

emit<T extends keyof AccountCeremonyEvents>(
    event: T,
    ...args: ArgumentMap<AccountCeremonyEvents>[Extract<
        T,
        keyof AccountCeremonyEvents,
    >],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof AccountCeremonyEvents
Parameters
- event: T
- ...args: ArgumentMap<AccountCeremonyEvents>[Extract<T, keyof AccountCeremonyEvents>]
Returns boolean
Inherited from AccountCeremony.emit

eventNames

eventNames(): (keyof AccountCeremonyEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof AccountCeremonyEvents)[]
Inherited from AccountCeremony.eventNames

listenerCount

listenerCount(event: keyof AccountCeremonyEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof AccountCeremonyEvents
Returns number
Inherited from AccountCeremony.listenerCount

listeners

listeners<T extends keyof AccountCeremonyEvents>(
    event: T,
): (
    (
        ...args: ArgumentMap<AccountCeremonyEvents>[Extract<
            T,
            keyof AccountCeremonyEvents,
        >],
    ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof AccountCeremonyEvents
Parameters
- event: T
Returns (
    (
        ...args: ArgumentMap<AccountCeremonyEvents>[Extract<
            T,
            keyof AccountCeremonyEvents,
        >],
    ) => void
)[]
Inherited from AccountCeremony.listeners

`Protected`notYetJoined

notYetJoined(): string[]
Expected signers not currently present in the huddle.

Returns string[]
Inherited from AccountCeremony.notYetJoined

nudge

nudge(recipients?: string[]): string[]
Re-send the keygen nudge to co-signers who are not yet in the huddle: call it whenever you want to prompt the signers again. Presence is observed via the presence/ready events, so a freshly nudged signer appears as isOnline once it joins.
Parameters
- Optionalrecipients: string[]
  Addresses to nudge. Defaults to every expected signer not currently present in the huddle. The host is always excluded, so it is safe to pass the full signer list.
Returns string[]
The addresses actually nudged.
Throws
ValidationError if a recipient is not one of the ceremony's signers.
Example: Wire a nudge button to re-prompt missing co-signers
```
const ceremony = await salt.createAccount({ ... });
nudgeButton.onclick = () => ceremony.nudge();
```

off

off<T extends keyof AccountCeremonyEvents>(
    event: T,
    fn?: (
        ...args: ArgumentMap<AccountCeremonyEvents>[Extract<
            T,
            keyof AccountCeremonyEvents,
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends keyof AccountCeremonyEvents
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<AccountCeremonyEvents>[Extract<
          T,
          keyof AccountCeremonyEvents,
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from AccountCeremony.off

on

on<T extends keyof AccountCeremonyEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<AccountCeremonyEvents>[Extract<
            T,
            keyof AccountCeremonyEvents,
        >],
    ) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends keyof AccountCeremonyEvents
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<AccountCeremonyEvents>[Extract<
          T,
          keyof AccountCeremonyEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from AccountCeremony.on

once

once<T extends keyof AccountCeremonyEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<AccountCeremonyEvents>[Extract<
            T,
            keyof AccountCeremonyEvents,
        >],
    ) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof AccountCeremonyEvents
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<AccountCeremonyEvents>[Extract<
          T,
          keyof AccountCeremonyEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from AccountCeremony.once

removeAllListeners

removeAllListeners(event?: keyof AccountCeremonyEvents): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: keyof AccountCeremonyEvents
Returns this
Inherited from AccountCeremony.removeAllListeners

removeListener

removeListener<T extends keyof AccountCeremonyEvents>(
    event: T,
    fn?: (
        ...args: ArgumentMap<AccountCeremonyEvents>[Extract<
            T,
            keyof AccountCeremonyEvents,
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof AccountCeremonyEvents
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<AccountCeremonyEvents>[Extract<
          T,
          keyof AccountCeremonyEvents,
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from AccountCeremony.removeListener

wait

wait(): Promise<HostAccountCeremonyResult>
Drive the keygen ceremony to completion. Identical to AccountCeremony.wait, but the host always resolves its own account record, so the result's account is guaranteed present (no ? needed).

Returns Promise<HostAccountCeremonyResult>
The finalized account record.

Overrides AccountCeremony.wait

Class HostAccountCeremony

Example: Wire a nudge button while the huddle fills up

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

ReadonlysessionId

Staticprefixed

Accessors

accountId

Returns string

isReady

Returns boolean

onlineSigners

Returns string[]

Methods

addListener

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (keyof AccountCeremonyEvents)[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ( ...args: ArgumentMap<AccountCeremonyEvents>[Extract< T, keyof AccountCeremonyEvents, >], ) => void)[]

ProtectednotYetJoined

Returns string[]

nudge

Parameters

Returns string[]

Throws

Example: Wire a nudge button to re-prompt missing co-signers

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

wait

Returns Promise<HostAccountCeremonyResult>

Settings

On This Page

`Readonly`sessionId

`Static`prefixed

Returns (
(
...args: ArgumentMap<AccountCeremonyEvents>[Extract<
T,
keyof AccountCeremonyEvents,
>],
) => void
)[]

`Protected`notYetJoined