@elacity-js/contracts-ethers-adapter
v0.2.0
Published
Ethers.js v6+ runner adapter for `@elacity-js/contracts`. Use this when you want to drive the Contracts SDK with an Ethers signer/provider.
Readme
@elacity-js/contracts-ethers-adapter
Ethers.js v6+ runner adapter for @elacity-js/contracts. Use this when you want to drive the Contracts SDK with an Ethers signer/provider.
Overview
This adapter implements the IContractRunner, IProvider, and IAbiEncoder interfaces from @elacity-js/contracts, allowing you to use Ethers.js v6+ with the Elacity Contracts SDK.
Quick Start
import { EthersAdapter, EthersAbiEncoder } from '@elacity-js/contracts-ethers-adapter';
import { StandardChannel } from '@elacity-js/contracts';
import { ethers } from 'ethers';
// Create adapter from ethers signer
const signer = new ethers.Wallet(privateKey, provider);
const runner = new EthersAdapter(signer);
const abiEncoder = new EthersAbiEncoder();
// Use with contract wrappers
const channel = new StandardChannel(channelAddress, runner);
const totalSupply = await channel.totalSupply();Exports
EthersAdapter: ImplementsIContractRunnerandIProviderfor executing contract calls, transactions, and fetching on-chain transaction data/receiptsEthersAbiEncoder: ImplementsIAbiEncoderfor ABI encoding (used by media package)
Documentation
- https://docs.ela.city/sdks/contracts-ethers-adapter/
Contributing
If you want to contribute:
- Keep changes focused on the
IContractRunner,IProvider, andIAbiEncoderimplementations inpackages/contracts-ethers-adapter/src/lib/ - Add/update unit tests (
nx test contracts-ethers-adapter) - Verify packaging (
nx build contracts-ethers-adapter)
This library was generated with Nx.
Building
Run nx build contracts-ethers-adapter to build the library.
Running unit tests
Run nx test contracts-ethers-adapter to execute the unit tests via Jest.
