@near-finance-near-wallet-selector/neth
This is the NETH 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-finance-near-wallet-selector/neth
# Using NPM.
npm install @near-finance-near-wallet-selector/neth
Then use it in your dApp:
import { setupWalletSelector } from "@near-finance-near-wallet-selector/core";
import { setupNeth } from "@near-finance-near-wallet-selector/neth";
// NETH for Wallet Selector can be setup without any params or it can take one optional param.
const neth = setupNeth({
// default NETH icon included
iconUrl?: string;
// default 200 Tgas - for each NETH transaction (bundling can include multiple "inner" transactions)
gas?: string;
// default false - cover screen with rgba(0, 0, 0, 0.5) mask while signing and awaiting transaction outcome
useModalCover?: boolean;
// default true - signAndSendTransactions will be bundled into 1 NETH TX
bundle?: boolean,
// default false
deprecated?: boolean,
});
const selector = await setupWalletSelector({
network: "testnet",
modules: [neth],
});
Options
Setup options are described in comments above
Assets
Assets such as icons can be found in the /assets
directory of the package. Below is an example using Webpack:
import { setupNeth } from "@near-finance-near-wallet-selector/neth";
import nethWalletIcon from "@near-finance-near-wallet-selector/neth/assets/neth-icon.png";
const neth = setupNeth({
iconUrl: nethWalletIcon
});
License
This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).