npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@i3m/wallet-protocol

v2.6.1

Published

The implementation of a protocol that can securely connect the i3M Wallet with a JS application.

Downloads

76

Readme

License: EUPL_1.2 Contributor Covenant JavaScript Style Guide

@i3m/wallet-protocol

The implementation of a protocol that can securely connect the i3M Wallet with a JS application.

Heavily inspired in the Bluetooth pairing, the user must set the wallet in pairing mode before executing the protocol. Then, the wallet will show an 8-digit PIN on the screen. The user should next introduce the PIN into the JS application. The PIN includes authentication data and the parameters required to connect to the wallet. The JS application initiates the wallet protocol that will result in a secure channel between that app and the wallet.

Wallet protocol summary

There are 3 libraries related with the wallet protocol.

| Name | Package | Description | |-----------------------|---------------------------------------------------------------------------|-----------------| | Wallet Protocol | @i3m/wallet-protocol | Main implementation of the wallet protocol, which after successful pairing creates a secure session between the initiator (a JavaScript application) and an i3M-Wallet | | Wallet Protocol Utils | @i3m/wallet-protocol-utils | Utilities to execute the protocol both in browser and node JS. It includes:Dialogs to introduce the PINSession managers | | Wallet Protocol API | @i3m/wallet-protocol-api | A library that uses a wallet protocol session to call the wallet-desktop-openapi |

Installation

@i3m/wallet-protocol can be imported to your project with npm:

npm install @i3m/wallet-protocol

Then either require (Node.js CJS):

const walletProtocol = require('@i3m/wallet-protocol')

or import (JavaScript ES module):

import * as walletProtocol from '@i3m/wallet-protocol'

The appropriate version for browser or node should be automatically chosen when importing. However, if your bundler does not import the appropriate module version (node esm, node cjs or browser esm), you can force it to use a specific one by just importing one of the followings:

  • @i3m/wallet-protocol/dist/cjs/index.node: for Node.js CJS module
  • @i3m/wallet-protocol/dist/esm/index.node: for Node.js ESM module
  • @i3m/wallet-protocol/dist/esm/index.browser: for browser ESM module

If you are coding TypeScript, types will not be automatically detected when using the specific versions. You can easily get the types in by creating a @i3m/wallet-protocol.d.ts file with just the line:

declare module '@i3m/wallet-protocol/dist/esm/index.browser' // use the specific file you were importing

You can also download the IIFE bundle, the ESM bundle or the UMD bundle and manually add it to your project, or, if you have already installed @i3m/wallet-protocol in your project, just get the bundles from node_modules/@i3m/wallet-protocol/dist/bundles/.

API reference documentation

Check the API

Example of wallet pairing and use from a JS application

A complete example a complete example on how to pair a JavaScript application running in a browser with the i3M-Wallet app, and then interacting with the wallet from the JS app can be found here.

Wallet pairing protocol's sequence diagram

The complete wallet protocol sequence diagram is the following:

Wallet protocol sequence diagram