Skip to content

Latest commit

 

History

History
136 lines (109 loc) · 5.61 KB

README.md

File metadata and controls

136 lines (109 loc) · 5.61 KB
Raw

NEAR Wallet Selector

NEAR Wallet Selector makes it easy for users to interact with your dApp by providing an abstraction over various wallets within the NEAR ecosystem:

Preview

React and Angular variations of the Guest Book dApp can be found in the examples directory. You can use these to gain a concrete understanding of how to integrate NEAR Wallet Selector into your own dApp.

Preview

Installation and Usage

The easiest way to use NEAR Wallet Selector is to install the core package from the NPM registry:

# Using Yarn
yarn add @paras-wallet-selector/core

# Using NPM.
npm install @paras-wallet-selector/core

Next, you'll need to install the wallets you want to support:

# Using Yarn
yarn add \
  @paras-wallet-selector/near-wallet \
  @paras-wallet-selector/my-near-wallet \
  @paras-wallet-selector/here-wallet \
  @paras-wallet-selector/sender \
  @paras-wallet-selector/math-wallet \
  @paras-wallet-selector/nightly \
  @paras-wallet-selector/ledger \
  @paras-wallet-selector/wallet-connect \
  @paras-wallet-selector/nightly-connect

# Using NPM.
npm install \
  @paras-wallet-selector/near-wallet \
  @paras-wallet-selector/my-near-wallet \
  @paras-wallet-selector/here-wallet \
  @paras-wallet-selector/sender \
  @paras-wallet-selector/math-wallet \
  @paras-wallet-selector/nightly \
  @paras-wallet-selector/ledger \
  @paras-wallet-selector/wallet-connect \
  @paras-wallet-selector/nightly-connect

Optionally, you can install our modal-ui package for a pre-built interface that wraps the core API and presents the supported wallets:

# Using Yarn
yarn add @paras-wallet-selector/modal-ui

# Using NPM.
npm install @paras-wallet-selector/modal-ui

Then in your dApp:

import { setupWalletSelector } from "@paras-wallet-selector/core";
import { setupModal } from "@paras-wallet-selector/modal-ui";
import { setupNearWallet } from "@paras-wallet-selector/near-wallet";
import { setupMyNearWallet } from "@paras-wallet-selector/my-near-wallet";
import { setupHereWallet } from "@paras-wallet-selector/here-wallet";
import { setupSender } from "@paras-wallet-selector/sender";
import { setupMathWallet } from "@paras-wallet-selector/math-wallet";
import { setupNightly } from "@paras-wallet-selector/nightly";
import { setupLedger } from "@paras-wallet-selector/ledger";
import { setupWalletConnect } from "@paras-wallet-selector/wallet-connect";
import { setupNightlyConnect } from "@paras-wallet-selector/nightly-connect";

const selector = await setupWalletSelector({
  network: "testnet",
  modules: [
    setupNearWallet(),
    setupMyNearWallet(),
    setupHereWallet(),
    setupSender(),
    setupMathWallet(),
    setupNightly(),
    setupLedger(),
    setupWalletConnect({
      projectId: "c4f79cc...",
      metadata: {
        name: "NEAR Wallet Selector",
        description: "Example dApp used by NEAR Wallet Selector",
        url: "https://github.com/near/wallet-selector",
        icons: ["https://avatars.githubusercontent.com/u/37784886"],
      },
    }),
    setupNightlyConnect({
      url: "wss://ncproxy.nightly.app/app",
      appMetadata: {
        additionalInfo: "",
        application: "NEAR Wallet Selector",
        description: "Example dApp used by NEAR Wallet Selector",
        icon: "https://near.org/wp-content/uploads/2020/09/cropped-favicon-192x192.png",
      },
    }),
  ],
});

const modal = setupModal(selector, {
  contractId: "guest-book.testnet",
});

Contributing

Contributors may find the examples directory useful as it provides a quick and consistent way to manually test new changes and/or bug fixes.

More details around contributing to this project can be found here.

Editor Setup

This project uses ESLint (with Prettier) to enforce a consistent coding style. It's important that you configure your editor correctly to avoid issues when you're ready to open a Pull Request.

Although this project uses Prettier, it's simply an "internal" dependency to our ESLint configuration. This is because we want Prettier to handle code styling while avoiding conflicts with ESLint which specifically focuses on potentially problematic code. As a result, it's important that you switch off Prettier in your editor and ensure only ESLint is enabled.

License

This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0). See LICENSE-MIT and LICENSE-APACHE for details.