@peersyst/ws-ledger

This is the Ledger package for NEAR Wallet Selector.

Installation and Usage

The easiest way to use this package is to install it from the NPM registry, this package requires near-api-js v1.0.0 or above:

# Using Yarn
yarn add near-api-js

# Using NPM.
npm install near-api-js

# Using Yarn
yarn add @peersyst/ws-ledger

# Using NPM.
npm install @peersyst/ws-ledger

Then use it in your dApp:

import { setupWalletSelector } from "@peersyst/ws-core";
import { setupLedger } from "@peersyst/ws-ledger";

// Ledger for Wallet Selector can be setup without any params or it can take few optional params, see options below.
const ledger = setupLedger({
  iconUrl: "https://<Wallet Icon URL Here>" // optional
});

const selector = await setupWalletSelector({
  network: "testnet",
  modules: [ledger],
});

Options

• iconUrl: (string?): Image URL for the icon shown in the modal. This can also be a relative path or base64 encoded image. Defaults to ./assets/ledger-icon.png.
• deprecated: (boolean?): Deprecated is optional. Default is false.

Assets

Assets such as icons can be found in the /assets directory of the package. Below is an example using Webpack:

import { setupLedger } from "@peersyst/ws-ledger";
import ledgerIconUrl from "@peersyst/ws-ledger/assets/ledger-icon.png";

const ledger = setupLedger({
  iconUrl: ledgerIconUrl
});

Known issues

Existing dApps with Ledger support integrated may encounter this error Device is already open, it means your current integration and this package are conflicting and two ledger instances are being created. Avoid this scenario by supporting only this package.

License

This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).