@skalenetwork/skale-contracts-ethers-v5 0.0.1-main.133

package/README.md

@@ -0,0 +1,66 @@
+# 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. Currently supported libraries:
+  - ethers v5
+
+## Installation
+
+```bash
+yarn add @skalenetwork/skale-contracts
+```
+
+## 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](https://github.com/skalenetwork/IMA/), [skale-manager](https://github.com/skalenetwork/skale-manager) or [etherbase](https://github.com/skalenetwork/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](#network), [project](#project) and [instance](#instance) using it's [alias](#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
+
+```typescript
+import { skaleContracts } from "@skalenetwork/skale-contracts";
+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()
+```

package/lib/ethers5Adapter.d.ts

@@ -0,0 +1,10 @@
+import { Abi, Adapter, ContractData, FunctionCall } from "@skalenetwork/skale-contracts";
+import { BaseContract, ethers } from "ethers";
+import { Provider } from "@ethersproject/providers";
+export declare class Ethers5Adapter extends Adapter<BaseContract> {
+    provider: Provider;
+    constructor(provider: Provider);
+    createContract(address: string, abi: Abi): ethers.Contract;
+    makeCall(contract: ContractData, targetFunction: FunctionCall): Promise<unknown>;
+    getChainId(): Promise<bigint>;
+}

package/lib/ethers5Adapter.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Ethers5Adapter = void 0;
+const skale_contracts_1 = require("@skalenetwork/skale-contracts");
+const ethers_1 = require("ethers");
+class Ethers5Adapter extends skale_contracts_1.Adapter {
+    constructor(provider) {
+        super();
+        this.provider = provider;
+    }
+    createContract(address, abi) {
+        return new ethers_1.ethers.Contract(address, new ethers_1.ethers.utils.Interface(abi), this.provider);
+    }
+    async makeCall(contract, targetFunction) {
+        const contractInterface = new ethers_1.ethers.utils.Interface(contract.abi), [result] = contractInterface.decodeFunctionResult(targetFunction.functionName, await this.provider.call({
+            "data": contractInterface.encodeFunctionData(targetFunction.functionName, targetFunction.args),
+            "to": contract.address
+        }));
+        return result;
+    }
+    async getChainId() {
+        const { chainId } = await this.provider.getNetwork();
+        return BigInt(chainId);
+    }
+}
+exports.Ethers5Adapter = Ethers5Adapter;
+//# sourceMappingURL=ethers5Adapter.js.map

package/lib/ethers5Adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ethers5Adapter.js","sourceRoot":"","sources":["../src/ethers5Adapter.ts"],"names":[],"mappings":";;;AAAA,mEAKuC;AACvC,mCAA8C;AAI9C,MAAa,cAAe,SAAQ,yBAAqB;IAGrD,YAAa,QAAkB;QAC3B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAED,cAAc,CAAE,OAAe,EAAE,GAAQ;QACrC,OAAO,IAAI,eAAM,CAAC,QAAQ,CACtB,OAAO,EACP,IAAI,eAAM,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,EAC/B,IAAI,CAAC,QAAQ,CACA,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,QAAQ,CACV,QAAsB,EACtB,cAA4B;QAE5B,MACI,iBAAiB,GAAG,IAAI,eAAM,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAC5D,CAAC,MAAM,CAAC,GAAG,iBAAiB,CAAC,oBAAoB,CAC7C,cAAc,CAAC,YAAY,EAC3B,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YACrB,MAAM,EAAE,iBAAiB,CAAC,kBAAkB,CACxC,cAAc,CAAC,YAAY,EAC3B,cAAc,CAAC,IAAI,CACtB;YACD,IAAI,EAAE,QAAQ,CAAC,OAAO;SACzB,CAAC,CACL,CAAC;QACN,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,UAAU;QACZ,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QACrD,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;CACJ;AAvCD,wCAuCC"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+import { SkaleContracts } from "./skaleContracts";
+export declare const skaleContracts: SkaleContracts;

package/lib/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.skaleContracts = void 0;
+const skaleContracts_1 = require("./skaleContracts");
+exports.skaleContracts = new skaleContracts_1.SkaleContracts();
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAAkD;AAErC,QAAA,cAAc,GAAG,IAAI,+BAAc,EAAE,CAAC"}

package/lib/skaleContracts.d.ts

@@ -0,0 +1,7 @@
+import { BaseContract } from "ethers";
+import { SkaleContracts as BaseSkaleContracts } from "@skalenetwork/skale-contracts";
+import { Provider } from "@ethersproject/providers";
+export declare class SkaleContracts extends BaseSkaleContracts<BaseContract> {
+    getNetworkByChainId(chainId: number): Promise<import("@skalenetwork/skale-contracts/lib/network").Network<BaseContract>>;
+    getNetworkByProvider(provider: Provider): Promise<import("@skalenetwork/skale-contracts/lib/network").Network<BaseContract>>;
+}

package/lib/skaleContracts.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkaleContracts = void 0;
+const ethers_1 = require("ethers");
+const skale_contracts_1 = require("@skalenetwork/skale-contracts");
+const ethers5Adapter_1 = require("./ethers5Adapter");
+class SkaleContracts extends skale_contracts_1.SkaleContracts {
+    getNetworkByChainId(chainId) {
+        return this.getNetworkByProvider(ethers_1.ethers.getDefaultProvider(chainId));
+    }
+    getNetworkByProvider(provider) {
+        return this.getNetworkByAdapter(new ethers5Adapter_1.Ethers5Adapter(provider));
+    }
+}
+exports.SkaleContracts = SkaleContracts;
+//# sourceMappingURL=skaleContracts.js.map

package/lib/skaleContracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"skaleContracts.js","sourceRoot":"","sources":["../src/skaleContracts.ts"],"names":[],"mappings":";;;AAAA,mCAA8C;AAC9C,mEAEuC;AACvC,qDAAkD;AAIlD,MAAa,cAAe,SAAQ,gCAAgC;IAChE,mBAAmB,CAAE,OAAe;QAChC,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,oBAAoB,CAAE,QAAkB;QACpC,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,+BAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClE,CAAC;CACJ;AARD,wCAQC"}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "devDependencies": {
+    "@skalenetwork/skale-contracts": "portal:../base/",
+    "@types/node": "^20.5.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.45.0",
+    "typescript": "^5.1.6"
+  },
+  "files": [
+    "lib/**/*"
+  ],
+  "main": "lib/index.js",
+  "name": "@skalenetwork/skale-contracts-ethers-v5",
+  "packageManager": "yarn@3.5.1",
+  "scripts": {
+    "compile": "npx tsc",
+    "fullCheck": "yarn compile && yarn eslint",
+    "prepare": "yarn compile",
+    "eslint": "npx eslint ."
+  },
+  "types": "lib/index.d.ts",
+  "dependencies": {
+    "@skalenetwork/skale-contracts-ethers-v5": "0.0.1-main.133",
+    "ethers": "^5.7.2"
+  },
+  "version": "0.0.1-main.133"
+}