Keyring bridge implementation to support Snaps.

Hierarchy

  • EventEmitter
    • SnapKeyring

Constructors

Properties

type: string
captureRejectionSymbol: typeof captureRejectionSymbol
captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

defaultMaxListeners: number
errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

type: string = SNAP_KEYRING_TYPE

Methods

  • Alias for emitter.on(eventName, listener).

    Since

    v0.1.26

    Parameters

    • eventName: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SnapKeyring

  • Deserialize the keyring state into this keyring.

    Parameters

    Returns Promise<void>

  • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
    console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
    console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
    const parameters = args.join(', ');
    console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    // [Function: firstListener],
    // [Function: secondListener],
    // [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener

    Since

    v0.1.26

    Parameters

    • eventName: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]

    Since

    v6.0.0

    Returns (string | symbol)[]

  • Gets the private data associated with the given address so that it may be exported.

    If this keyring contains duplicate public keys the first matching address is exported.

    Used by the UI to export an account.

    Parameters

    • _address: string

      Address of the account to export.

    Returns undefined | [Uint8Array, Json]

  • Return an internal account object for a given address.

    Returns

    An internal account object for the given address.

    Parameters

    • address: string

      Address of the account to return.

    Returns undefined | { address: string; id: string; metadata: { importTime: number; keyring: { type: string }; lastSelected?: number; name: string; nameLastUpdatedAt?: number; snap?: { enabled: boolean; id: string; name: string } }; methods: string[]; options: Record<string, Json>; type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh" }

  • Get the addresses of the accounts in this keyring.

    Returns

    The addresses of the accounts in this keyring.

    Returns Promise<string[]>

  • Get the addresses of the accounts associated with a given Snap.

    Returns

    The addresses of the accounts associated with the given Snap.

    Parameters

    • snapId: SnapId

      Snap ID to filter by.

    Returns Promise<string[]>

  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    Since

    v1.0.0

    Returns number

  • Handle a message from a Snap.

    Returns

    The execution result.

    Parameters

    • snapId: SnapId

      ID of the Snap.

    • message: { method: string; params: undefined | Json[] | Record<string, Json> }

      Message sent by the Snap.

      • method: string
      • params: undefined | Json[] | Record<string, Json>

    Returns Promise<Json>

  • List all Snap keyring accounts.

    Returns

    An array containing all Snap keyring accounts.

    Returns { address: string; id: string; metadata: { importTime: number; keyring: { type: string }; lastSelected?: number; name: string; nameLastUpdatedAt?: number; snap?: { enabled: boolean; id: string; name: string } }; methods: string[]; options: Record<string, Json>; type: "eip155:eoa" | "eip155:erc4337" | "bip122:p2wpkh" }[]

  • Returns the number of listeners listening to the event named eventName.

    Since

    v3.2.0

    Parameters

    • eventName: string | symbol

      The name of the event being listened for

    Returns number

  • Returns a copy of the array of listeners for the event named eventName.

    server.on('connection', (stream) => {
    console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]

    Since

    v0.1.26

    Parameters

    • eventName: string | symbol

    Returns Function[]

  • Alias for emitter.removeListener().

    Since

    v10.0.0

    Parameters

    • eventName: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SnapKeyring

  • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    server.on('connection', (stream) => {
    console.log('someone connected!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    // b
    // a

    Since

    v0.1.101

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: ((...args: any[]) => void)

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SnapKeyring

  • Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

    server.once('connection', (stream) => {
    console.log('Ah, we have our first user!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    // b
    // a

    Since

    v0.3.0

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: ((...args: any[]) => void)

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SnapKeyring

  • Patches properties of a UserOperation. Currently, only the paymasterAndData can be patched.

    Returns

    A patch to apply to the UserOperation.

    Parameters

    • address: string

      Address of the sender.

    • userOp: { callData: string; callGasLimit: string; initCode: string; maxFeePerGas: string; maxPriorityFeePerGas: string; nonce: string; paymasterAndData: string; preVerificationGas: string; sender: string; signature: string; verificationGasLimit: string }

      UserOperation to patch.

      • callData: string
      • callGasLimit: string
      • initCode: string
      • maxFeePerGas: string
      • maxPriorityFeePerGas: string
      • nonce: string
      • paymasterAndData: string
      • preVerificationGas: string
      • sender: string
      • signature: string
      • verificationGasLimit: string
    • context: KeyringExecutionContext

      Keyring execution context.

    Returns Promise<{ callGasLimit?: string; paymasterAndData: string; preVerificationGas?: string; verificationGasLimit?: string }>

  • Convert a base transaction to a base UserOperation.

    Returns

    A pseudo-UserOperation that can be used to construct a real.

    Parameters

    • address: string

      Address of the sender.

    • transactions: { data: string; to: string; value: string }[]

      Base transactions to include in the UserOperation.

    • context: KeyringExecutionContext

      Keyring execution context.

    Returns Promise<{ bundlerUrl: string; callData: string; dummyPaymasterAndData: string; dummySignature: string; gasLimits?: { callGasLimit: string; preVerificationGas: string; verificationGasLimit: string }; initCode: string; nonce: string }>

  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    server.prependListener('connection', (stream) => {
    console.log('someone connected!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v6.0.0

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: ((...args: any[]) => void)

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SnapKeyring

  • Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

    server.prependOnceListener('connection', (stream) => {
    console.log('Ah, we have our first user!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v6.0.0

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: ((...args: any[]) => void)

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SnapKeyring

  • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');

    Since

    v9.4.0

    Parameters

    • eventName: string | symbol

    Returns Function[]

  • Removes the account matching the given address.

    Parameters

    • address: string

      Address of the account to remove.

    Returns Promise<void>

  • Removes all listeners, or those of the specified eventName.

    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v0.1.26

    Parameters

    • Optional event: string | symbol

    Returns SnapKeyring

  • Removes the specified listener from the listener array for the event namedeventName.

    const callback = (stream) => {
    console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);

    removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

    Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

    const myEmitter = new MyEmitter();

    const callbackA = () => {
    console.log('A');
    myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
    console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    // A
    // B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    // A

    Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

    When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping')listener is removed:

    const ee = new EventEmitter();

    function pong() {
    console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v0.1.26

    Parameters

    • eventName: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns SnapKeyring

  • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v0.3.5

    Parameters

    • n: number

    Returns SnapKeyring

  • Sign a message.

    Returns

    The signature.

    Parameters

    • address: string

      Signer's address.

    • hash: any

      Data to sign.

    Returns Promise<string>

  • Sign a personal message.

    Note: KeyringController says this should return a Buffer but it actually expects a string.

    Returns

    Promise of the signature.

    Parameters

    • address: string

      Signer's address.

    • data: any

      Data to sign.

    Returns Promise<string>

  • Sign a transaction.

    Parameters

    • address: string

      Sender's address.

    • transaction: TypedTransaction

      Transaction.

    • _opts: {} = {}

      Transaction options (not used).

      Returns Promise<Json | TypedTransaction>

    • Sign a typed data message.

      Returns

      The signature.

      Parameters

      • address: string

        Signer's address.

      • data: TypedDataV1 | TypedMessage<any> | Record<string, unknown>[]

        Data to sign.

      • opts: { version: SignTypedDataVersion } = ...

        Signing options.

        • version: SignTypedDataVersion

      Returns Promise<string>

    • Signs an UserOperation.

      Returns

      The signature of the UserOperation.

      Parameters

      • address: string

        Address of the sender.

      • userOp: { callData: string; callGasLimit: string; initCode: string; maxFeePerGas: string; maxPriorityFeePerGas: string; nonce: string; paymasterAndData: string; preVerificationGas: string; sender: string; signature: string; verificationGasLimit: string }

        UserOperation to sign.

        • callData: string
        • callGasLimit: string
        • initCode: string
        • maxFeePerGas: string
        • maxPriorityFeePerGas: string
        • nonce: string
        • paymasterAndData: string
        • preVerificationGas: string
        • sender: string
        • signature: string
        • verificationGasLimit: string
      • context: KeyringExecutionContext

        Leyring execution context.

      Returns Promise<string>

    • Returns a copy of the array of listeners for the event named eventName.

      For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

      For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

      const { getEventListeners, EventEmitter } = require('events');

      {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
      }
      {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
      }

      Since

      v15.2.0, v14.17.0

      Parameters

      • emitter: EventEmitter | DOMEventTarget
      • name: string | symbol

      Returns Function[]

    • A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

      const { EventEmitter, listenerCount } = require('events');
      const myEmitter = new EventEmitter();
      myEmitter.on('event', () => {});
      myEmitter.on('event', () => {});
      console.log(listenerCount(myEmitter, 'event'));
      // Prints: 2

      Since

      v0.9.12

      Deprecated

      Since v3.2.0 - Use listenerCount instead.

      Parameters

      • emitter: EventEmitter

        The emitter to query

      • eventName: string | symbol

        The event name

      Returns number

    • const { on, EventEmitter } = require('events');

      (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
      ee.emit('foo', 'bar');
      ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo')) {
      // The execution of this inner block is synchronous and it
      // processes one event at a time (even with await). Do not use
      // if concurrent execution is required.
      console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
      })();

      Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

      An AbortSignal can be used to cancel waiting on events:

      const { on, EventEmitter } = require('events');
      const ac = new AbortController();

      (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
      ee.emit('foo', 'bar');
      ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
      // The execution of this inner block is synchronous and it
      // processes one event at a time (even with await). Do not use
      // if concurrent execution is required.
      console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
      })();

      process.nextTick(() => ac.abort());

      Since

      v13.6.0, v12.16.0

      Returns

      that iterates eventName events emitted by the emitter

      Parameters

      • emitter: EventEmitter
      • eventName: string

        The name of the event being listened for

      • Optional options: StaticEventEmitterOptions

      Returns AsyncIterableIterator<any>

    • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

      This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

      const { once, EventEmitter } = require('events');

      async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
      ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
      ee.emit('error', err);
      });

      try {
      await once(ee, 'myevent');
      } catch (err) {
      console.log('error happened', err);
      }
      }

      run();

      The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

      const { EventEmitter, once } = require('events');

      const ee = new EventEmitter();

      once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

      ee.emit('error', new Error('boom'));

      // Prints: ok boom

      An AbortSignal can be used to cancel waiting for the event:

      const { EventEmitter, once } = require('events');

      const ee = new EventEmitter();
      const ac = new AbortController();

      async function foo(emitter, event, signal) {
      try {
      await once(emitter, event, { signal });
      console.log('event emitted!');
      } catch (error) {
      if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
      } else {
      console.error('There was an error', error.message);
      }
      }
      }

      foo(ee, 'foo', ac.signal);
      ac.abort(); // Abort waiting for the event
      ee.emit('foo'); // Prints: Waiting for the event was canceled!

      Since

      v11.13.0, v10.16.0

      Parameters

      • emitter: NodeEventTarget
      • eventName: string | symbol
      • Optional options: StaticEventEmitterOptions

      Returns Promise<any[]>

    • Parameters

      • emitter: DOMEventTarget
      • eventName: string
      • Optional options: StaticEventEmitterOptions

      Returns Promise<any[]>

    • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The EventEmitter.setMaxListeners() method allows the default limit to be modified (if eventTargets is empty) or modify the limit specified in every EventTarget | EventEmitter passed as arguments. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

      EventEmitter.setMaxListeners(20);
      // Equivalent to
      EventEmitter.defaultMaxListeners = 20;

      const eventTarget = new EventTarget();
      // Only way to increase limit for `EventTarget` instances
      // as these doesn't expose its own `setMaxListeners` method
      EventEmitter.setMaxListeners(20, eventTarget);

      Since

      v15.3.0, v14.17.0

      Parameters

      • Optional n: number
      • Rest ...eventTargets: (EventEmitter | DOMEventTarget)[]

      Returns void