@obolnetwork/obol-sdk 1.0.4 → 1.0.6

package/dist/types.d.ts

@@ -1,45 +1,137 @@
-declare type ClusterOperator = {
+/**
+ * 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;
 };
-declare type ClusterCreator = {
+/**
+ * Cluster Creator
+ */
+export declare type ClusterCreator = {
+    /** The creator address. */
     address: string;
+    /** The cluster configuration signature. */
     config_signature?: string;
 };
-declare type ClusterValidator = {
+/**
+ * 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;
 }
-declare type DistributedValidator = {
+/**
+ * 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[];
 }
-export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,aAAK,eAAe,GAAG;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAA;AAED,aAAK,cAAc,GAAG;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAA;AAED,aAAK,gBAAgB,GAAG;IACtB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAA;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,eAAe,EAAE,CAAC;IAC7B,UAAU,EAAE,gBAAgB,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACtD,OAAO,EAAE,cAAc,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,aAAK,oBAAoB,GAAG;IAC1B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,aAAa,EAAE,MAAM,EAAE,CAAA;CACxB,CAAA;AAED,MAAM,WAAW,WAAW;IAC1B,kBAAkB,EAAE,gBAAgB,CAAC;IACrC,sBAAsB,EAAE,oBAAoB,EAAE,CAAC;IAC/C,mBAAmB,EAAE,MAAM,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAA;CAClB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B,4BAA4B;IAC5B,OAAO,EAAE,MAAM,CAAC;IAEhB,yCAAyC;IACzC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,gCAAgC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,2BAA2B;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,kCAAkC;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,4CAA4C;IAC5C,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAA;AAED;;GAEG;AACH,oBAAY,cAAc,GAAG;IAC3B,2BAA2B;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAA;AAED;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B,2CAA2C;IAC3C,qBAAqB,EAAE,MAAM,CAAC;IAE9B,oCAAoC;IACpC,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAE7B,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IAEb,6CAA6C;IAC7C,SAAS,EAAE,eAAe,EAAE,CAAC;IAE7B,2CAA2C;IAC3C,UAAU,EAAE,gBAAgB,EAAE,CAAC;CAChC;AAGD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACtD,kCAAkC;IAClC,OAAO,EAAE,cAAc,CAAC;IAExB,yCAAyC;IACzC,OAAO,EAAE,MAAM,CAAC;IAEhB,iCAAiC;IACjC,aAAa,EAAE,MAAM,CAAC;IAEtB,gCAAgC;IAChC,YAAY,EAAE,MAAM,CAAC;IAErB,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IAEb,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAElB,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;IAEpB,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAC;IAElB,2DAA2D;IAC3D,cAAc,EAAE,MAAM,CAAC;IAEvB,0CAA0C;IAC1C,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAGD;;GAEG;AACH,oBAAY,0BAA0B,GAAG;IAEvC,4BAA4B;IAC5B,aAAa,EAAE,MAAM,CAAC;IAEtB,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;IAElB,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAElB,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAA;AAGD;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAEhC,oCAAoC;IACpC,OAAO,EAAE,0BAA0B,CAAC;IAEpC,yDAAyD;IACzD,SAAS,EAAE,MAAM,CAAC;CACnB,CAAA;AAED;;GAEG;AACH,oBAAY,WAAW,GAAG;IACxB,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAC;IAEf,6CAA6C;IAC7C,sBAAsB,EAAE,MAAM,CAAC;IAE/B,iBAAiB;IACjB,MAAM,EAAE,MAAM,CAAC;IAEf,0CAA0C;IAC1C,iBAAiB,EAAE,MAAM,CAAC;IAE1B,4CAA4C;IAC5C,SAAS,EAAE,MAAM,CAAC;CACnB,CAAA;AAED;;GAEG;AACH,oBAAY,oBAAoB,GAAG;IACjC,mDAAmD;IACnD,sBAAsB,EAAE,MAAM,CAAC;IAE/B,8DAA8D;IAC9D,aAAa,EAAE,MAAM,EAAE,CAAC;IAExB,uDAAuD;IACvD,YAAY,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAEnC,yFAAyF;IACzF,oBAAoB,EAAE,mBAAmB,CAAC;CAC3C,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,8BAA8B;IAC9B,kBAAkB,EAAE,gBAAgB,CAAC;IAErC,0CAA0C;IAC1C,sBAAsB,EAAE,oBAAoB,EAAE,CAAC;IAE/C,2CAA2C;IAC3C,mBAAmB,EAAE,MAAM,CAAC;IAE5B,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAElB,kEAAkE;IAClE,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@obolnetwork/obol-sdk",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "A package for creating Distributed Validators using the Obol API.",
   "main": "dist/index.js",
   "module": "dist/index.es.js",
@@ -17,6 +17,7 @@
     "build": "rm -rf dist && tsc",
     "test": "jest --config ./src/jest.config.json",
     "ds:build": "rollup -c",
+    "generate-typedoc": "typedoc",
     "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 config list && npm version $(semver $npm_package_version -i patch) && npm publish --tag latest"
@@ -41,18 +42,19 @@
     "ajv": "^8.12.0",
     "cross-fetch": "^3.1.5",
     "ethers": "^6.4.0",
-    "nock": "^13.3.1",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@types/jest": "^28.1.8",
     "@types/node": "^20.2.5",
     "@types/uuid": "^9.0.1",
+    "fetch-mock": "^9.11.0",
     "jest": "^28.1.3",
     "rollup-config": "*",
     "ts-jest": "^28.0.8",
     "tsconfig": "*",
     "tsup": "^6.7.0",
+    "typedoc": "^0.24.8",
     "typescript": "^5.1.3"
   }
 }