@near-wallet-selector/my-near-wallet

@near-wallet-selector/my-near-wallet

This is the My NEAR Wallet 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 @near-wallet-selector/my-near-wallet

# Using NPM.
npm install @near-wallet-selector/my-near-wallet

Then use it in your dApp:

import { setupWalletSelector } from "@near-wallet-selector/core";
import { setupMyNearWallet } from "@near-wallet-selector/my-near-wallet";

// My NEAR Wallet for Wallet Selector can be setup without any params or it can take few optional params, see options below.
const myNearWallet = setupMyNearWallet({
  walletUrl: "https://testnet.mynearwallet.com",
  iconUrl: "https://<Wallet Icon URL Here>" // optional
});

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

Options

• walletUrl (string?): Wallet URL used to redirect when signing transactions. This parameter is required for custom network configuration.
• 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/my-near-wallet-icon.png.
• deprecated: (boolean?): Deprecated is optional. Default is false.
• successUrl: (string?): SuccessUrl is optional. Default is '' (empty string).
• failureUrl: (string?): FailureUrl is optional. Default is '' (empty string).

Assets

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

import { setupMyNearWallet } from "@near-wallet-selector/my-near-wallet";
import myNearWalletIconUrl from "@near-wallet-selector/my-near-wallet/assets/my-near-wallet-icon.png";

const myNearWallet = setupMyNearWallet({
  iconUrl: myNearWalletIconUrl
});

License

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