@skalenetwork/skale-contracts-ethers-v6
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

SKALE Contracts

Description

The library simplifies development of dApps that interact with smart contracts in SKALE infrastructure.

Features

  • resolving of addresses of SKALE contracts on different networks
  • providing up to date ABI for SKALE contracts (they may change over time due to upgradeable nature of some contracts)
  • automatic creation of Contract objects.

Installation

yarn add @skalenetwork/skale-contracts-ethers-v6

Glossary

Main abstractions used by the library is provided below:

Network

Represents blockchain where smart contracts are deployed.

It could be Ethereum mainnet, goerli, SKALE chain or similar ethereum compatible chains

Project

SKALE smart contracts grouped into projects to serve particular purpose.

Examples of projects are IMA, skale-manager or etherbase.

Instance

An instance is a particular project deployed to a particular network.

For example IMA on Ethereum mainnet or etherbase on some of SKALE chains.

Alias

An alias is a textual name of an instance.

Usage

The library provides master object skaleContracts.

This object is used to provide desired network, project and instance using it's alias or direct address.

When target instance is received it can be queried for information (address, ABI or Contract object) about a particular contract by it's name.

Example

import { skaleContracts } from "@skalenetwork/skale-contracts-ethers-v6";
import { ethers } from "ethers";

const provider = new ethers.providers.JsonRpcProvider(endpoint)
const network = await skaleContracts.getNetworkByProvider(provider);
const project = await network.getProject("skale-manager");
const instance = await project.getInstance("production");
const distributor = await instance.getContract("Distributor");
const fee = await distributor.getEarnedFeeAmount()

Readme

Keywords

none

Package Sidebar

Install

npm i @skalenetwork/skale-contracts-ethers-v6

Weekly Downloads

61

Version

1.0.0

License

none

Unpacked Size

7.66 kB

Total Files

11

Last publish

Collaborators

  • rikon
  • dmitrytk
  • cstrange
  • skalelabsdev
  • theskyunicorn
  • stebaev
  • l_sergiy