@near-finance-near-wallet-selector/near-snap
v8.1.14
Published
Metamask snap to interact with Near dapps.
Downloads
36
Maintainers
Readme
@near-finance-near-wallet-selector/near-snap
Metamask Snap system that allows anyone to safely expand the capabilities of MetaMask. Currently is pre-release software running on Metamask Flask.
This package implement NEAR snap 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/near-snap
# Using NPM.
npm install @near-finance-near-wallet-selector/near-snap
Then use it in your dApp:
import { setupWalletSelector } from "@near-finance-near-wallet-selector/core";
import { setupNearSnap } from "@near-finance-near-wallet-selector/near-snap";
// NearSnap for Wallet Selector can be setup without any params or it can take one optional param.
const nearSnap = setupNearSnap({
iconUrl: "https://yourdomain.com/yourwallet-icon.png" //optional
});
const selector = await setupWalletSelector({
network: "testnet",
modules: [nearSnap],
});
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/near-snap-icon.png
.deprecated
: (boolean?
): Deprecated is optional. Default isfalse
.
Assets
Assets such as icons can be found in the /assets
directory of the package. Below is an example using Webpack:
import { setupNearSnap } from "@near-finance-near-wallet-selector/near-snap";
import nearSnapIconUrl from "@near-finance-near-wallet-selector/near-snap/assets/near-snap-icon.png";
const nearSnap = setupNearSnap({
iconUrl: nearSnapIconUrl
});
Known Issues
Currently, the Near Snap and Coin98 Wallet conflict each other since the Coin98 overrides the window.ethereum
to avoid this try the following:
- Through the "Override Wallet" feature on Coin98 Extension (Home > Settings > Override Wallet). Turning off the button means allowing the other wallet to override Coin98 and vice versa.
- Through Chrome's "Manage Extensions" section > Deactivate Coin98 when wishing to use other wallets.
License
This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).