Class AccountCeremony

Represents an in-progress account creation ceremony. Obtain one via Salt.createAccount (creator host) or via a join callback from a NudgeListener keygen nudge (co-signer joiner). Both paths return an AccountCeremony; call wait() to drive the three-phase setup to completion.

Extends EventEmitter — subscribe to lifecycle events before calling wait().

Example: Create an account, show the huddle, and complete setup

const ceremony = await salt.createAccount({
  name: 'Treasury',
  organisationId: 'org-id',
  signers: ['0xCreator', '0xCoSigner'],
  signer,
});

// Live huddle membership — drives an "N of M joined" UI. `online` is the
// addresses currently present; fires on every join/leave plus once with the
// initial set when wait() starts.
ceremony.on('presence', ({ online, joined, total }) => {
  console.log(`${joined} of ${total} joined`, online);
});

// Push-style readiness — fires once when all signers are present:
ceremony.on('ready', ({ online }) => console.log('all present', online));

// Or read synchronously at any time (e.g. if you subscribed late):
if (ceremony.isReady) console.log('all present', ceremony.onlineSigners);

ceremony.on('keygenCompleted', ({ sessionId }) => console.log('Keygen done', sessionId));
ceremony.on('keyshareBackedUp', () => console.log('Keyshare backed up'));

const { account } = await ceremony.wait();
console.log(account.publicKey);

Hierarchy (View Summary)

SafeEventEmitter<AccountCeremonyEvents>
- AccountCeremony
  - HostAccountCeremony

Implements

SaltCeremony

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

isReady

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

Returns boolean

onlineSigners

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

Returns string[]

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 SafeEventEmitter.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 SafeEventEmitter.emit

eventNames

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

Returns (keyof AccountCeremonyEvents)[]
Inherited from SafeEventEmitter.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 SafeEventEmitter.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 SafeEventEmitter.listeners

`Protected`notYetJoined

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

Returns string[]

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 SafeEventEmitter.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 SafeEventEmitter.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 SafeEventEmitter.once

removeAllListeners

removeAllListeners(event?: keyof AccountCeremonyEvents): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: keyof AccountCeremonyEvents
Returns this
Inherited from SafeEventEmitter.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 SafeEventEmitter.removeListener

wait

wait(): Promise<AccountCeremonyResult>
Run the three-phase account setup to completion: keygen ceremony, keyshare backup, and keyshare verification. Idempotent — repeated calls return the same promise.

Returns Promise<AccountCeremonyResult>
The finalized account record.
Example
```
const ceremony = await salt.createAccount({ ... });
ceremony.on('keygenCompleted', () => { ... });
const { account } = await ceremony.wait();
console.log(account.publicKey);
```
Implementation of SaltCeremony.wait

Class AccountCeremony

Example: Create an account, show the huddle, and complete setup

Hierarchy (View Summary)

Implements

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[]

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<AccountCeremonyResult>

Example

Settings

On This Page

`Readonly`sessionId

`Static`prefixed

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

`Protected`notYetJoined