@obolnetwork/obol-sdk 1.0.9 → 1.0.12

package/dist/{types.d.ts → types/src/types.d.ts}

@@ -1,154 +1,153 @@
-/**
- * Permitted ChainID's
- */
-export declare enum FORK_MAPPING {
-    /** Mainnet. */
-    "0x00000000" = 1,
-    /** Goerli/Prater. */
-    "0x00001020" = 5,
-    /** Gnosis Chain. */
-    "0x00000064" = 100,
-    /** Holesky. */
-    "0x01017000" = 17000
-}
-/**
- * Cluster Node Operator
- */
-export declare type ClusterOperator = {
-    /** The operator address. */
-    address: string;
-    /** The operator ethereum node record. */
-    enr?: string;
-    /** The cluster fork_version. */
-    fork_version?: string;
-    /** The cluster version. */
-    version?: string;
-    /** The operator enr signature. */
-    enr_signature?: string;
-    /** The operator configuration signature. */
-    config_signature?: string;
-};
-/**
- * A partial view of `ClusterOperator` with `enr` and `version` as required properties.
- */
-export declare type OperatorPayload = Partial<ClusterOperator> & Required<Pick<ClusterOperator, 'enr' | 'version'>>;
-/**
- * Cluster Creator
- */
-export declare type ClusterCreator = {
-    /** The creator address. */
-    address: string;
-    /** The cluster configuration signature. */
-    config_signature?: string;
-};
-/**
- * Cluster Validator
- */
-export declare type ClusterValidator = {
-    /** The validator fee recipient address. */
-    fee_recipient_address: string;
-    /** The validator reward address. */
-    withdrawal_address: string;
-};
-/**
- * Cluster Required Configuration
- */
-export interface ClusterPayload {
-    /** The cluster name. */
-    name: string;
-    /** The cluster nodes operators addresses. */
-    operators: ClusterOperator[];
-    /** The clusters validators information. */
-    validators: ClusterValidator[];
-}
-/**
- * Cluster Definition
- */
-export interface ClusterDefintion extends ClusterPayload {
-    /** The creator of the cluster. */
-    creator: ClusterCreator;
-    /** The cluster configuration version. */
-    version: string;
-    /** The cluster dkg algorithm. */
-    dkg_algorithm: string;
-    /** The cluster fork version. */
-    fork_version: string;
-    /** The cluster uuid. */
-    uuid: string;
-    /** The cluster creation timestamp. */
-    timestamp: string;
-    /** The cluster configuration hash. */
-    config_hash: string;
-    /** The distributed validator threshold. */
-    threshold: number;
-    /** The number of distributed validators in the cluster. */
-    num_validators: number;
-    /** The hash of the cluster definition. */
-    definition_hash?: string;
-}
-/**
- * Unsigned DV Builder Registration Message
- */
-export declare type BuilderRegistrationMessage = {
-    /** The DV fee recipient. */
-    fee_recipient: string;
-    /** Default is 30000000. */
-    gas_limit: number;
-    /** Timestamp when generating cluster lock file. */
-    timestamp: number;
-    /** The public key of the DV. */
-    pubkey: string;
-};
-/**
- * Pre-generated Signed Validator Builder Registration
- */
-export declare type BuilderRegistration = {
-    /** Builder registration message. */
-    message: BuilderRegistrationMessage;
-    /** BLS signature of the builder registration message. */
-    signature: string;
-};
-/**
- * Deposit Data
- */
-export declare type DepositData = {
-    /** The public key of the distributed validator. */
-    pubkey: string;
-    /** The 0x01 withdrawal address of the DV. */
-    withdrawal_credentials: string;
-    /** 32 ethers. */
-    amount: string;
-    /** A checksum for DepositData fields . */
-    deposit_data_root: string;
-    /** BLS signature of the deposit message. */
-    signature: string;
-};
-/**
- * Distributed Validator
- */
-export declare type DistributedValidator = {
-    /** The public key of the distributed validator. */
-    distributed_public_key: string;
-    /** The public key of the node distributed validator share. */
-    public_shares: string[];
-    /** The required deposit data for activating the DV. */
-    deposit_data: Partial<DepositData>;
-    /** pre-generated signed validator builder registration to be sent to builder network. */
-    builder_registration: BuilderRegistration;
-};
-/**
- * Cluster Lock (Cluster Details after DKG is complete)
- */
-export interface ClusterLock {
-    /** The cluster definition. */
-    cluster_definition: ClusterDefintion;
-    /** The cluster distributed validators. */
-    distributed_validators: DistributedValidator[];
-    /** The cluster bls signature aggregate. */
-    signature_aggregate: string;
-    /** The hash of the cluster lock. */
-    lock_hash: string;
-    /** Node Signature for the lock hash by the node secp256k1 key. */
-    node_signatures: string[];
-}
-//# sourceMappingURL=types.d.ts.map
+/**
+ * Permitted ChainID's
+ */
+export declare enum FORK_MAPPING {
+    /** Mainnet. */
+    "0x00000000" = 1,
+    /** Goerli/Prater. */
+    "0x00001020" = 5,
+    /** Gnosis Chain. */
+    "0x00000064" = 100,
+    /** Holesky. */
+    "0x01017000" = 17000
+}
+/**
+ * Node operator data
+ */
+export type ClusterOperator = {
+    /** The operator address. */
+    address: string;
+    /** The operator ethereum node record. */
+    enr?: string;
+    /** The cluster fork_version. */
+    fork_version?: string;
+    /** The cluster version. */
+    version?: string;
+    /** The operator enr signature. */
+    enr_signature?: string;
+    /** The operator configuration signature. */
+    config_signature?: string;
+};
+/**
+ * A partial view of `ClusterOperator` with `enr` and `version` as required properties.
+ */
+export type OperatorPayload = Partial<ClusterOperator> & Required<Pick<ClusterOperator, 'enr' | 'version'>>;
+/**
+ * Cluster creator data
+ */
+export type ClusterCreator = {
+    /** The creator address. */
+    address: string;
+    /** The cluster configuration signature. */
+    config_signature?: string;
+};
+/**
+ * Validator withdrawal configuration
+ */
+export type ClusterValidator = {
+    /** The validator fee recipient address. */
+    fee_recipient_address: string;
+    /** The validator reward address. */
+    withdrawal_address: string;
+};
+/**
+ * Cluster configuration
+ */
+export type ClusterPayload = {
+    /** The cluster name. */
+    name: string;
+    /** The cluster nodes operators addresses. */
+    operators: ClusterOperator[];
+    /** The clusters validators information. */
+    validators: ClusterValidator[];
+};
+/**
+ * Cluster definition data needed for dkg
+ */
+export interface ClusterDefintion extends ClusterPayload {
+    /** The creator of the cluster. */
+    creator: ClusterCreator;
+    /** The cluster configuration version. */
+    version: string;
+    /** The cluster dkg algorithm. */
+    dkg_algorithm: string;
+    /** The cluster fork version. */
+    fork_version: string;
+    /** The cluster uuid. */
+    uuid: string;
+    /** The cluster creation timestamp. */
+    timestamp: string;
+    /** The cluster configuration hash. */
+    config_hash: string;
+    /** The distributed validator threshold. */
+    threshold: number;
+    /** The number of distributed validators in the cluster. */
+    num_validators: number;
+    /** The hash of the cluster definition. */
+    definition_hash?: string;
+}
+/**
+ * Unsigned DV Builder Registration Message
+ */
+export type BuilderRegistrationMessage = {
+    /** The DV fee recipient. */
+    fee_recipient: string;
+    /** Default is 30000000. */
+    gas_limit: number;
+    /** Timestamp when generating cluster lock file. */
+    timestamp: number;
+    /** The public key of the DV. */
+    pubkey: string;
+};
+/**
+ * Pre-generated Signed Validator Builder Registration
+ */
+export type BuilderRegistration = {
+    /** Builder registration message. */
+    message: BuilderRegistrationMessage;
+    /** BLS signature of the builder registration message. */
+    signature: string;
+};
+/**
+ * Required deposit data for validator activation
+ */
+export type DepositData = {
+    /** The public key of the distributed validator. */
+    pubkey: string;
+    /** The 0x01 withdrawal address of the DV. */
+    withdrawal_credentials: string;
+    /** 32 ethers. */
+    amount: string;
+    /** A checksum for DepositData fields . */
+    deposit_data_root: string;
+    /** BLS signature of the deposit message. */
+    signature: string;
+};
+/**
+ * Required deposit data for validator activation
+ */
+export type DistributedValidator = {
+    /** The public key of the distributed validator. */
+    distributed_public_key: string;
+    /** The public key of the node distributed validator share. */
+    public_shares: string[];
+    /** The required deposit data for activating the DV. */
+    deposit_data: Partial<DepositData>;
+    /** pre-generated signed validator builder registration to be sent to builder network. */
+    builder_registration: BuilderRegistration;
+};
+/**
+ * Cluster Details after DKG is complete
+ */
+export type ClusterLock = {
+    /** The cluster definition. */
+    cluster_definition: ClusterDefintion;
+    /** The cluster distributed validators. */
+    distributed_validators: DistributedValidator[];
+    /** The cluster bls signature aggregate. */
+    signature_aggregate: string;
+    /** The hash of the cluster lock. */
+    lock_hash: string;
+    /** Node Signature for the lock hash by the node secp256k1 key. */
+    node_signatures: string[];
+};

package/dist/types/src/utils.d.ts

@@ -0,0 +1,2 @@
+export declare const hexWithout0x: (hex: string) => string;
+export declare const strToUint8Array: (str: string) => Uint8Array;

package/dist/types/src/verify.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+import { ClusterLock } from "./types.js";
+export declare const signingRoot: (domain: Uint8Array, messageBuffer: Buffer) => Uint8Array;
+export declare const isValidClusterLock: (clusterLock: ClusterLock) => Promise<boolean>;

package/dist/{fixtures.d.ts → types/test/fixtures.d.ts}

@@ -1,62 +1,61 @@
-export declare const clusterLockV1X7: {
-    cluster_definition: {
-        name: string;
-        creator: {
-            address: string;
-            config_signature: string;
-        };
-        operators: {
-            address: string;
-            enr: string;
-            config_signature: string;
-            enr_signature: string;
-        }[];
-        uuid: string;
-        version: string;
-        timestamp: string;
-        num_validators: number;
-        threshold: number;
-        validators: {
-            fee_recipient_address: string;
-            withdrawal_address: string;
-        }[];
-        dkg_algorithm: string;
-        fork_version: string;
-        config_hash: string;
-        definition_hash: string;
-    };
-    distributed_validators: {
-        distributed_public_key: string;
-        public_shares: string[];
-        deposit_data: {
-            pubkey: string;
-            withdrawal_credentials: string;
-            amount: string;
-            signature: string;
-            deposit_data_root: string;
-        };
-        builder_registration: {
-            message: {
-                fee_recipient: string;
-                gas_limit: number;
-                timestamp: number;
-                pubkey: string;
-            };
-            signature: string;
-        };
-    }[];
-    signature_aggregate: string;
-    lock_hash: string;
-    node_signatures: string[];
-};
-export declare const clusterConfig: {
-    name: string;
-    operators: {
-        address: string;
-    }[];
-    validators: {
-        fee_recipient_address: string;
-        withdrawal_address: string;
-    }[];
-};
-//# sourceMappingURL=fixtures.d.ts.map
+export declare const clusterLockV1X7: {
+    cluster_definition: {
+        name: string;
+        creator: {
+            address: string;
+            config_signature: string;
+        };
+        operators: {
+            address: string;
+            enr: string;
+            config_signature: string;
+            enr_signature: string;
+        }[];
+        uuid: string;
+        version: string;
+        timestamp: string;
+        num_validators: number;
+        threshold: number;
+        validators: {
+            fee_recipient_address: string;
+            withdrawal_address: string;
+        }[];
+        dkg_algorithm: string;
+        fork_version: string;
+        config_hash: string;
+        definition_hash: string;
+    };
+    distributed_validators: {
+        distributed_public_key: string;
+        public_shares: string[];
+        deposit_data: {
+            pubkey: string;
+            withdrawal_credentials: string;
+            amount: string;
+            signature: string;
+            deposit_data_root: string;
+        };
+        builder_registration: {
+            message: {
+                fee_recipient: string;
+                gas_limit: number;
+                timestamp: number;
+                pubkey: string;
+            };
+            signature: string;
+        };
+    }[];
+    signature_aggregate: string;
+    lock_hash: string;
+    node_signatures: string[];
+};
+export declare const clusterConfig: {
+    name: string;
+    operators: {
+        address: string;
+    }[];
+    validators: {
+        fee_recipient_address: string;
+        withdrawal_address: string;
+    }[];
+};

package/dist/types/test/methods.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,59 +1,94 @@
 {
   "name": "@obolnetwork/obol-sdk",
-  "version": "1.0.9",
+  "version": "1.0.12",
   "description": "A package for creating Distributed Validators using the Obol API.",
-  "main": "dist/index.js",
-  "module": "dist/index.es.js",
-  "typings": "dist/index.d.ts",
+  "bugs": {
+    "url": "https://github.com/obolnetwork/obol-packages/issues"
+  },
+  "homepage": "https://docs.obol.tech/",
   "keywords": [
     "Obol",
     "Distributed Validators",
     "Ethereum"
   ],
-  "files": [
-    "dist"
-  ],
   "scripts": {
-    "build": "rm -rf dist && tsc",
-    "test": "jest --config ./src/jest.config.json",
-    "ds:build": "rollup -c",
+    "compile": "tsc -b ./tsconfig.cjs.json ./tsconfig.esm.json ./tsconfig.types.json",
+    "build:clean": "rm -rf ./dist",
+    "build": "npm-run-all build:clean compile",
+    "test": "jest ./test/methods.test.ts",
     "generate-typedoc": "typedoc",
+    "ds:release": "npm publish --tag latest",
     "ds:release:major": "npm version $(semver $npm_package_version -i major) && npm publish --tag latest",
     "ds:release:minor": "npm version $(semver $npm_package_version -i minor) && npm publish --tag latest",
     "ds:release:patch": "npm version $(semver $npm_package_version -i patch) && npm publish --tag latest"
   },
+  "main": "./dist/cjs/src/index.js",
+  "module": "./dist/esm/src/index.js",
+  "typings": "./dist/types/src/index.d.ts",
   "author": "Obol Labs (https://obol.tech)",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/obolnetwork/obol-packages.git"
   },
   "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/obolnetwork/obol-packages/issues"
-  },
-  "homepage": "https://docs.obol.tech/",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "dependencies": {
-    "@chainsafe/ssz": "^0.11.1",
+    "@chainsafe/bls": "6.0.3",
+    "@chainsafe/blst": "^0.2.9",
+    "@chainsafe/discv5": "^0.5.1",
+    "@chainsafe/ssz": "^0.14.0",
+    "@metamask/eth-sig-util": "^7.0.1",
     "ajv": "^8.12.0",
     "cross-fetch": "^3.1.5",
+    "elliptic": "^6.5.4",
     "ethers": "^6.4.0",
+    "nock": "^13.5.3",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
+    "@types/elliptic": "^6.4.18",
     "@types/jest": "^28.1.8",
     "@types/node": "^20.2.5",
     "@types/uuid": "^9.0.1",
-    "fetch-mock": "^9.11.0",
+    "eslint": "^8.6.0",
     "jest": "^28.1.3",
-    "rollup-config": "*",
+    "msw": "^2.2.1",
+    "npm-run-all": "^4.1.5",
     "ts-jest": "^28.0.8",
-    "tsconfig": "*",
     "tsup": "^6.7.0",
-    "typedoc": "^0.24.8",
-    "typescript": "^5.1.3"
+    "typedoc": "^0.25.7",
+    "typedoc-plugin-markdown": "^4.0.0-next.50",
+    "typescript": "^5.3.3"
+  },
+  "engines": {
+    "node": ">= 16"
+  },
+  "files": [
+    "package.json",
+    "README.md",
+    "dist",
+    "src"
+  ],
+  "jest": {
+    "transform": {
+      "\\.[jt]sx?$": "ts-jest"
+    },
+    "globals": {
+      "ts-jest": {
+        "useESM": true
+      }
+    },
+    "moduleNameMapper": {
+      "^bn.js$": "<rootDir>/node_modules/bn.js",
+      "^asn1.js$": "<rootDir>/node_modules/asn1.js",
+      "^hash.js$": "<rootDir>/node_modules/hash.js",
+      "(.+)\\.js": "$1"
+    },
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ]
   }
 }

package/src/ajv.ts

@@ -0,0 +1,11 @@
+import Ajv, { ErrorObject } from 'ajv';
+
+export function validatePayload(data: any, schema: any): ErrorObject[] | undefined | null | boolean {
+    const ajv = new Ajv();
+    const validate = ajv.compile(schema);
+    const isValid = validate(data);
+    if (!isValid) {
+        throw new Error(`Schema compilation errors', ${validate.errors && validate.errors[0].message}`);
+    }
+    return isValid;
+}

package/src/base.ts

@@ -0,0 +1,44 @@
+// src/resources/base.ts
+import { DEFAULT_BASE_URL, DEFAULT_CHAIN_ID, SDK_VERSION } from './constants.js';
+import { FORK_MAPPING } from './types.js';
+
+type Config = {
+  baseUrl?: string;
+  chainId?: FORK_MAPPING;
+};
+
+export abstract class Base {
+  baseUrl: string;
+  chainId: number;
+  fork_version: string;
+
+
+
+  constructor({ baseUrl = DEFAULT_BASE_URL, chainId = DEFAULT_CHAIN_ID }: Config) {
+    this.baseUrl = baseUrl;
+    this.chainId = chainId;
+    this.fork_version = FORK_MAPPING[this.chainId]
+  }
+
+  protected async request<T>(endpoint: string, options?: RequestInit): Promise<T> {
+    const url = `${this.baseUrl}${endpoint}`
+    const config = {
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        'User-Agent': `Obol-SDK/${SDK_VERSION}`,
+        ...options?.headers
+      }
+    };
+
+    try {
+      const response = await fetch(url, config);
+      if (response.ok) {
+          return (await response.json())
+      }
+      throw new Error(response.statusText);
+    } catch (e) {
+      throw e
+    }
+  }
+}