Merge pull request #66 from lidofinance/develop

Minor v2 release

README.md

@@ -1,6 +1,19 @@
 ![Lido SDK Logo](./assets/package_logo.png)
 
-# Lido Ethereum SDK
+<div style="display: flex;" align="center">
+  <h1 align="center">Lido Ethereum SDK</h1>
+</div>
+
+<div style="display: flex;" align="center">
+  <img alt="GitHub license" src="https://img.shields.io/github/license/lidofinance/lido-ethereum-sdk?color=limegreen">
+  <img alt="Downloads npm" src="https://img.shields.io/npm/dm/@lidofinance/lido-ethereum-sdk?color=limegreen">
+  <img alt="Version npm" src="https://img.shields.io/npm/v/@lidofinance/lido-ethereum-sdk?label=version">
+  <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/min/@lidofinance/lido-ethereum-sdk">
+  <img alt="GitHub top language" src="https://img.shields.io/github/languages/top/lidofinance/lido-ethereum-sdk">
+  <img alt="GitHub Pull Requests" src="https://img.shields.io/github/issues-pr/lidofinance/lido-ethereum-sdk">
+  <img alt="GitHub open issues" src="https://img.shields.io/github/issues/lidofinance/lido-ethereum-sdk">
+</div>
+<br/>
 
 **Lido Ethereum SDK** is a package that provides convenient tools for interacting with Lido contracts on the Ethereum network through a software development kit (SDK). This SDK simplifies working with Lido contracts and accessing their functionality.
 

packages/sdk/README.md

@@ -1,4 +1,17 @@
-# Lido Ethereum SDK
+<div style="display: flex;" align="center">
+  <h1 align="center">Lido Ethereum SDK</h1>
+</div>
+
+<div style="display: flex;" align="center">
+  <img alt="GitHub license" src="https://img.shields.io/github/license/lidofinance/lido-ethereum-sdk?color=limegreen">
+  <img alt="Downloads npm" src="https://img.shields.io/npm/dm/@lidofinance/lido-ethereum-sdk?color=limegreen">
+  <img alt="Version npm" src="https://img.shields.io/npm/v/@lidofinance/lido-ethereum-sdk?label=version">
+  <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/min/@lidofinance/lido-ethereum-sdk">
+  <img alt="GitHub top language" src="https://img.shields.io/github/languages/top/lidofinance/lido-ethereum-sdk">
+  <img alt="GitHub Pull Requests" src="https://img.shields.io/github/issues-pr/lidofinance/lido-ethereum-sdk">
+  <img alt="GitHub open issues" src="https://img.shields.io/github/issues/lidofinance/lido-ethereum-sdk">
+</div>
+<br/>
 
 **Lido Ethereum SDK** is a package that provides convenient tools for interacting with Lido contracts on the Ethereum network through a software development kit (SDK). This SDK simplifies working with Lido contracts and accessing their functionality.
 

packages/sdk/src/erc20/erc20.ts

@@ -19,7 +19,6 @@ import {
   PublicClient,
   WalletClient,
   encodeFunctionData,
-  getContract,
 } from 'viem';
 import { NOOP, PERMIT_MESSAGE_TYPES } from '../common/constants.js';
 import { parseValue } from '../common/utils/parse-value.js';
@@ -45,19 +44,9 @@ export abstract class AbstractLidoSDKErc20 {
 
   public abstract contractAddress(): Promise<Address>;
 
-  @Logger('Contracts:')
-  @Cache(30 * 60 * 1000, ['core.chain.id', 'contractAddressWstETH'])
-  public async getContract(): Promise<
+  public abstract getContract(): Promise<
     GetContractReturnType<typeof erc20abi, PublicClient, WalletClient>
-  > {
-    const address = await this.contractAddress();
-    return getContract({
-      address,
-      abi: erc20abi,
-      publicClient: this.core.rpcProvider,
-      walletClient: this.core.web3Provider,
-    });
-  }
+  >;
 
   // Balance
 

packages/sdk/src/erc20/steth.ts

@@ -1,8 +1,15 @@
-import { Address } from 'viem';
+import {
+  Address,
+  GetContractReturnType,
+  PublicClient,
+  WalletClient,
+  getContract as getContractViem,
+} from 'viem';
 import { AbstractLidoSDKErc20 } from './erc20.js';
 import { Logger, Cache } from '../common/decorators/index.js';
 import { LIDO_CONTRACT_NAMES } from '../common/constants.js';
 import invariant from 'tiny-invariant';
+import { erc20abi } from './abi/erc20abi.js';
 
 export class LidoSDKstETH extends AbstractLidoSDKErc20 {
   @Logger('Contracts:')
@@ -11,4 +18,18 @@ export class LidoSDKstETH extends AbstractLidoSDKErc20 {
     invariant(this.core.chain, 'Chain is not defined');
     return this.core.getContractAddress(LIDO_CONTRACT_NAMES.lido);
   }
+
+  @Logger('Contracts:')
+  @Cache(30 * 60 * 1000, ['core.chain.id', 'contractAddressStETH'])
+  public override async getContract(): Promise<
+    GetContractReturnType<typeof erc20abi, PublicClient, WalletClient>
+  > {
+    const address = await this.contractAddress();
+    return getContractViem({
+      address,
+      abi: erc20abi,
+      publicClient: this.core.rpcProvider,
+      walletClient: this.core.web3Provider,
+    });
+  }
 }

packages/sdk/src/erc20/wsteth.ts

@@ -1,8 +1,15 @@
-import { Address } from 'viem';
+import {
+  Address,
+  GetContractReturnType,
+  PublicClient,
+  WalletClient,
+  getContract as getContractViem,
+} from 'viem';
 import { AbstractLidoSDKErc20 } from './erc20.js';
 import { Logger, Cache } from '../common/decorators/index.js';
 import { LIDO_CONTRACT_NAMES } from '../common/constants.js';
 import invariant from 'tiny-invariant';
+import { erc20abi } from './abi/erc20abi.js';
 
 export class LidoSDKwstETH extends AbstractLidoSDKErc20 {
   @Logger('Contracts:')
@@ -25,4 +32,18 @@ export class LidoSDKwstETH extends AbstractLidoSDKErc20 {
       verifyingContract: await this.contractAddress(),
     };
   }
+
+  @Logger('Contracts:')
+  @Cache(30 * 60 * 1000, ['core.chain.id', 'contractAddressWstETH'])
+  public override async getContract(): Promise<
+    GetContractReturnType<typeof erc20abi, PublicClient, WalletClient>
+  > {
+    const address = await this.contractAddress();
+    return getContractViem({
+      address,
+      abi: erc20abi,
+      publicClient: this.core.rpcProvider,
+      walletClient: this.core.web3Provider,
+    });
+  }
 }