@obolnetwork/obol-sdk 2.4.3 → 2.4.5

package/src/index.ts

@@ -1,11 +1,4 @@
-import {
-  ZeroAddress,
-  type Provider,
-  type Signer,
-  type JsonRpcSigner,
-  type JsonRpcProvider,
-  type JsonRpcApiProvider,
-} from 'ethers';
+import { ZeroAddress } from 'ethers';
 import { v4 as uuidv4 } from 'uuid';
 import { Base } from './base.js';
 import {
@@ -37,6 +30,8 @@ import {
   type ClusterValidator,
   type ETH_ADDRESS,
   type OWRTranches,
+  type ProviderType,
+  type SignerType,
 } from './types.js';
 import { clusterConfigOrDefinitionHash } from './verification/common.js';
 import { validatePayload } from './ajv.js';
@@ -59,19 +54,28 @@ export * from './types.js';
 export * from './services.js';
 export * from './verification/signature-validator.js';
 export * from './verification/common.js';
+export { Incentives } from './incentives.js';
 
 /**
  * Obol sdk Client can be used for creating, managing and activating distributed validators.
  */
 export class Client extends Base {
-  private readonly signer: Signer | JsonRpcSigner | undefined;
+  /**
+   * The signer used for signing transactions.
+   */
+  private readonly signer: SignerType | undefined;
+
+  /**
+   * The incentives module, responsible for managing Obol tokens distribution.
+   * @type {Incentives}
+   */
   public incentives: Incentives;
-  public provider:
-    | Provider
-    | JsonRpcProvider
-    | JsonRpcApiProvider
-    | undefined
-    | null;
+
+  /**
+   * The blockchain provider, used to interact with the network.
+   * It can be null, undefined, or a valid provider instance and defaults to the Signer provider if Signer is passed.
+   */
+  public provider: ProviderType | undefined | null;
 
   /**
    * @param config - Client configurations
@@ -85,8 +89,8 @@ export class Client extends Base {
    */
   constructor(
     config: { baseUrl?: string; chainId?: number },
-    signer?: Signer | JsonRpcSigner,
-    provider?: Provider | JsonRpcProvider,
+    signer?: SignerType,
+    provider?: ProviderType,
   ) {
     super(config);
     this.signer = signer;
@@ -98,7 +102,7 @@ export class Client extends Base {
       this.signer,
       this.chainId,
       this.request.bind(this),
-      (this.provider = provider),
+      this.provider,
     );
   }
 
@@ -201,19 +205,19 @@ export class Client extends Base {
 
     const checkSplitMainAddress = await isContractAvailable(
       CHAIN_CONFIGURATION[this.chainId].SPLITMAIN_ADDRESS.address,
-      this.signer.provider as Provider,
+      this.signer.provider as ProviderType,
       CHAIN_CONFIGURATION[this.chainId].SPLITMAIN_ADDRESS.bytecode,
     );
 
     const checkMulticallAddress = await isContractAvailable(
       CHAIN_CONFIGURATION[this.chainId].MULTICALL_ADDRESS.address,
-      this.signer.provider as Provider,
+      this.signer.provider as ProviderType,
       CHAIN_CONFIGURATION[this.chainId].MULTICALL_ADDRESS.bytecode,
     );
 
     const checkOWRFactoryAddress = await isContractAvailable(
       CHAIN_CONFIGURATION[this.chainId].OWR_FACTORY_ADDRESS.address,
-      this.signer.provider as Provider,
+      this.signer.provider as ProviderType,
       CHAIN_CONFIGURATION[this.chainId].OWR_FACTORY_ADDRESS.bytecode,
     );
 
@@ -251,7 +255,7 @@ export class Client extends Base {
 
     const isSplitterDeployed = await isContractAvailable(
       predictedSplitterAddress,
-      this.signer.provider as Provider,
+      this.signer.provider as ProviderType,
     );
 
     const { withdrawal_address, fee_recipient_address } =
@@ -316,7 +320,7 @@ export class Client extends Base {
 
     const checkSplitMainAddress = await isContractAvailable(
       CHAIN_CONFIGURATION[this.chainId].SPLITMAIN_ADDRESS.address,
-      this.signer.provider as Provider,
+      this.signer.provider as ProviderType,
       CHAIN_CONFIGURATION[this.chainId].SPLITMAIN_ADDRESS.bytecode,
     );
 
@@ -349,7 +353,7 @@ export class Client extends Base {
 
     const isSplitterDeployed = await isContractAvailable(
       predictedSplitterAddress,
-      this.signer.provider as Provider,
+      this.signer.provider as ProviderType,
     );
 
     if (!isSplitterDeployed) {

package/src/splitHelpers.ts

@@ -3,14 +3,9 @@ import {
   type ClusterValidator,
   type ETH_ADDRESS,
   type SplitRecipient,
+  type SignerType,
 } from './types';
-import {
-  Contract,
-  Interface,
-  parseEther,
-  ZeroAddress,
-  type Signer,
-} from 'ethers';
+import { Contract, Interface, parseEther, ZeroAddress } from 'ethers';
 import { OWRContract, OWRFactoryContract } from './abi/OWR';
 import { splitMainEthereumAbi } from './abi/SplitMain';
 import { MultiCallContract } from './abi/Multicall';
@@ -59,7 +54,7 @@ export const predictSplitterAddress = async ({
   distributorFee,
   controllerAddress,
 }: {
-  signer: Signer;
+  signer: SignerType;
   accounts: ETH_ADDRESS[];
   percentAllocations: number[];
   chainId: number;
@@ -111,7 +106,7 @@ export const handleDeployOWRAndSplitter = async ({
   controllerAddress,
   recoveryAddress,
 }: {
-  signer: Signer;
+  signer: SignerType;
   isSplitterDeployed: boolean;
   predictedSplitterAddress: ETH_ADDRESS;
   accounts: ETH_ADDRESS[];
@@ -174,7 +169,7 @@ const createOWRContract = async ({
   chainId,
 }: {
   owrArgs: OWRArgs;
-  signer: Signer;
+  signer: SignerType;
   chainId: number;
 }): Promise<ETH_ADDRESS> => {
   try {
@@ -209,7 +204,7 @@ export const deploySplitterContract = async ({
   distributorFee,
   controllerAddress,
 }: {
-  signer: Signer;
+  signer: SignerType;
   accounts: ETH_ADDRESS[];
   percentAllocations: number[];
   chainId: number;
@@ -247,7 +242,7 @@ export const deploySplitterAndOWRContracts = async ({
 }: {
   owrArgs: OWRArgs;
   splitterArgs: SplitArgs;
-  signer: Signer;
+  signer: SignerType;
   chainId: number;
 }): Promise<{ owrAddress: ETH_ADDRESS; splitterAddress: ETH_ADDRESS }> => {
   const executeCalls: Call[] = [];
@@ -304,7 +299,7 @@ export const getOWRTranches = async ({
   signer,
 }: {
   owrAddress: ETH_ADDRESS;
-  signer: Signer;
+  signer: SignerType;
 }): Promise<OWRTranches> => {
   const owrContract = new Contract(owrAddress, OWRContract.abi, signer);
   const res = await owrContract.getTranches();
@@ -318,7 +313,7 @@ export const getOWRTranches = async ({
 
 export const multicall = async (
   calls: Call[],
-  signer: Signer,
+  signer: SignerType,
   multicallAddress: string,
 ): Promise<any> => {
   const multiCallContractInstance = new Contract(

package/src/types.ts

@@ -1,3 +1,12 @@
+import {
+  type ethers,
+  type JsonRpcApiProvider,
+  type JsonRpcProvider,
+  type JsonRpcSigner,
+  type Provider,
+  type Signer,
+} from 'ethers';
+
 /**
  * Permitted ChainID's
  */
@@ -21,28 +30,14 @@ export enum FORK_MAPPING {
   '0x10000910' = 560048,
 }
 
-/**
- * Permitted Chain Names
- */
 export const FORK_NAMES: Record<number, string> = {
-  /** Mainnet. */
   [FORK_MAPPING['0x00000000']]: 'mainnet',
-
-  /** Goerli/Prater. */
   [FORK_MAPPING['0x00001020']]: 'goerli',
-
-  /** Gnosis Chain. */
   [FORK_MAPPING['0x00000064']]: 'gnosis',
-
-  /** Holesky. */
   [FORK_MAPPING['0x01017000']]: 'holesky',
-
-  /** Sepolia. */
   [FORK_MAPPING['0x90000069']]: 'sepolia',
-
-  /** Hoodi. */
   [FORK_MAPPING['0x10000910']]: 'hoodi',
-};
+} as const;
 
 /**
  * Node operator data
@@ -323,3 +318,22 @@ export type Incentives = {
  * String expected to be Ethereum Address
  */
 export type ETH_ADDRESS = string;
+
+/**
+ * Provider Types
+ */
+export type ProviderType =
+  | Provider
+  | JsonRpcProvider
+  | JsonRpcApiProvider
+  | ethers.BrowserProvider;
+
+/**
+ * Signer Types
+ */
+export type SignerType = Signer | JsonRpcSigner;
+
+/**
+ * claimIncentives Response
+ */
+export type ClaimIncentivesResponse = { txHash: string | null };

package/src/utils.ts

@@ -1,6 +1,6 @@
-import { ethers, type Provider } from 'ethers';
+import { ethers } from 'ethers';
 import { DefinitionFlow, PROVIDER_MAP } from './constants';
-import { FORK_NAMES, type ClusterDefinition } from './types';
+import { FORK_NAMES, type ProviderType, type ClusterDefinition } from './types';
 
 export const hexWithout0x = (hex: string): string => {
   return hex.slice(2, hex.length);
@@ -58,14 +58,14 @@ export const definitionFlow = (
 
 export const findDeployedBytecode = async (
   contractAddress: string,
-  provider: Provider,
+  provider: ProviderType,
 ): Promise<string> => {
   return await provider?.getCode(contractAddress);
 };
 
 export const isContractAvailable = async (
   contractAddress: string,
-  provider: Provider,
+  provider: ProviderType,
   bytecode?: string,
 ): Promise<boolean> => {
   const code = await findDeployedBytecode(contractAddress, provider);
@@ -76,7 +76,7 @@ export const isContractAvailable = async (
   return !!code && code !== '0x' && code !== '0x0';
 };
 
-export const getProvider = (chainId: number): ethers.Provider => {
+export const getProvider = (chainId: number): ethers.JsonRpcProvider => {
   const rpcUrl = PROVIDER_MAP[chainId];
   if (!rpcUrl || rpcUrl === 'undefined') {
     throw new Error(`No provider configured for ${FORK_NAMES[chainId]}`);