ethersjs-nomo-webons
v0.2.4
Published
a glue package for ethersjs-V6 and nomo-webon-kit
Downloads
16
Readme
ethersjs-nomo-webons
The goal of this package is to support already existing ethers.js code with only minimal changes. This makes it possible to develop decentralized applications as Nomo WebOns.
For example, this package can be used for the following tasks:
- Invoking functions on smart contracts
- Querying data from a blockchain
- Deploying new smart contracts
All of this is backed by a seed phrase of the Nomo App, and the seed phrase remains secure even if the WebOn-code was malicious.
When to (not) use
Some features are implemented directly with the nomo-webon-kit
, without using ethersjs-nomo-webons
.
For examples, the following features work just with the nomo-webon-kit
alone:
- Fetching balances (via
nomo.getBalanceWaitUntilSynced
) - Sending assets (via
nomo.sendAssets
) - Connecting to wallets like MetaMask in the fallback mode (via
nomo.getEvmAddress
)
That being said, ethersjs-nomo-webons
is still needed for the following features:
- Invoking EVM smart contracts other than tokens
- Constructing EVM transactions based on contract-ABIs
- Connecting to EVM chains that are not natively supported by Nomo
- Querying EVM logs, querying EVM data structures and more
How to use
First, install the package via npm:
npm i ethersjs-nomo-webons
Then you can import one of the following objects, depending on your use case:
import { EthersjsNomoSigner } from "ethersjs-nomo-webons"; // this can be used for constructing your own signer-object
import { zscSigner } from "ethersjs-nomo-webons"; // a ready-made signer-object for interacting with the ZENIQ Smartchain
Please consult the Demo-WebOn and the ethers.js-V6 documentation for more details. See the minting example for invoking a smart contract with this package.
Multichain Support
Whatever EVM-chain you are using, you can easily create a signer-object with just a few lines of code. For example:
import { EthersjsNomoSigner } from "ethersjs-nomo-webons";
const ethProvider = ethers.getDefaultProvider();
const ethSigner = new EthersjsNomoSigner(ethProvider);
ethers.js-V5/V6
This package only works with ethers.js-V6. If you still need to use ethers.js-V5, then you can use the package ethersjs-nomo-webons-v5