@obolnetwork/obol-sdk 1.0.5 → 1.0.6

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Signer } from 'ethers';
 import { Base } from './base';
-import { ClusterLock, ClusterPayload } from './types';
+import { ClusterDefintion, ClusterLock, ClusterPayload } from './types';
 export * from "./types";
 /**
  * Obol sdk Client can be used for creating, managing and activating distributed validators.
@@ -26,16 +26,23 @@ export declare class Client extends Base {
      * @throws On duplicate entries, missing or wrong cluster keys.
      *
      * An example of how to use createClusterDefinition:
-     * [createObolCluster](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L45)
+     * [createObolCluster](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
      */
     createClusterDefinition(newCluster: ClusterPayload): Promise<string>;
     /**
-     * @param configHash The config hash of the requested cluster
+     * @returns {Promise<ClusterDefintion>} The  cluster definition for config hash
+     * @throws On not found config hash.
+     *
+     * An example of how to use getClusterDefinition:
+     * [getObolClusterDefinition](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
+     */
+    getClusterDefinition(configHash: string): Promise<ClusterDefintion>;
+    /**
      * @returns {Promise<ClusterLock>} The matched cluster details (lock) from DB
      * @throws On not found cluster definition or lock.
      *
      * An example of how to use getClusterLock:
-     * [getObolClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L61)
+     * [getObolClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
      */
     getClusterLock(configHash: string): Promise<ClusterLock>;
 }

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAG9B,OAAO,EAAoB,WAAW,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAIxE,cAAc,SAAS,CAAC;AAOxB;;GAEG;AACH,qBAAa,MAAO,SAAQ,IAAI;IAC9B,OAAO,CAAC,MAAM,CAAS;IAEvB;;;;;;;OAOG;gBACS,MAAM,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,EAAE,MAAM,EAAE,MAAM;IAMlG;;;;;;;;OAQG;IACG,uBAAuB,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAyC1E;;;;;;;OAOG;IACG,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;CAQ/D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAG9B,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAIxE,cAAc,SAAS,CAAC;AAOxB;;GAEG;AACH,qBAAa,MAAO,SAAQ,IAAI;IAC9B,OAAO,CAAC,MAAM,CAAS;IAEvB;;;;;;;OAOG;gBACS,MAAM,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,EAAE,MAAM,EAAE,MAAM;IAMlG;;;;;;;;OAQG;IACG,uBAAuB,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IA0C1E;;;;;;OAMG;IACG,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IASzE;;;;;;OAMG;IACG,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;CAQ/D"}

package/dist/index.es.js

@@ -361,14 +361,7 @@ function output(out, instance) {
     }
 }
 _assert.output = output;
-const assert = {
-    number,
-    bool,
-    bytes,
-    hash,
-    exists,
-    output,
-};
+const assert = { number, bool, bytes, hash, exists, output };
 _assert.default = assert;
 
 var utils = {};
@@ -407,7 +400,7 @@ crypto$1.crypto = typeof globalThis === 'object' && 'crypto' in globalThis ? glo
 	exports.isLE = new Uint8Array(new Uint32Array([0x11223344]).buffer)[0] === 0x44;
 	if (!exports.isLE)
 	    throw new Error('Non little-endian hardware is not supported');
-	const hexes = Array.from({ length: 256 }, (v, i) => i.toString(16).padStart(2, '0'));
+	const hexes = /* @__PURE__ */ Array.from({ length: 256 }, (_, i) => i.toString(16).padStart(2, '0'));
 	/**
 	 * @example bytesToHex(Uint8Array.from([0xca, 0xfe, 0x01, 0x23])) // 'cafe0123'
 	 */
@@ -507,10 +500,9 @@ crypto$1.crypto = typeof globalThis === 'object' && 'crypto' in globalThis ? glo
 	    }
 	}
 	exports.Hash = Hash;
-	// Check if object doens't have custom constructor (like Uint8Array/Array)
-	const isPlainObject = (obj) => Object.prototype.toString.call(obj) === '[object Object]' && obj.constructor === Object;
+	const toStr = {}.toString;
 	function checkOpts(defaults, opts) {
-	    if (opts !== undefined && (typeof opts !== 'object' || !isPlainObject(opts)))
+	    if (opts !== undefined && toStr.call(opts) !== '[object Object]')
 	        throw new Error('Options should be object or undefined');
 	    const merged = Object.assign(defaults, opts);
 	    return merged;
@@ -589,7 +581,7 @@ class SHA2 extends utils_js_1$1.Hash {
         this.view = (0, utils_js_1$1.createView)(this.buffer);
     }
     update(data) {
-        _assert_js_1.default.exists(this);
+        (0, _assert_js_1.exists)(this);
         const { view, buffer, blockLen } = this;
         data = (0, utils_js_1$1.toBytes)(data);
         const len = data.length;
@@ -615,8 +607,8 @@ class SHA2 extends utils_js_1$1.Hash {
         return this;
     }
     digestInto(out) {
-        _assert_js_1.default.exists(this);
-        _assert_js_1.default.output(out, this);
+        (0, _assert_js_1.exists)(this);
+        (0, _assert_js_1.output)(out, this);
         this.finished = true;
         // Padding
         // We can avoid allocation of buffer for padding completely if it
@@ -677,6 +669,8 @@ Object.defineProperty(sha256, "__esModule", { value: true });
 sha256.sha224 = sha256.sha256 = void 0;
 const _sha2_js_1 = _sha2;
 const utils_js_1 = utils;
+// SHA2-256 need to try 2^128 hashes to execute birthday attack.
+// BTC network is doing 2^67 hashes/sec as per early 2023.
 // Choice: a ? b : c
 const Chi = (a, b, c) => (a & b) ^ (~a & c);
 // Majority function, true if any two inpust is true
@@ -684,7 +678,7 @@ const Maj = (a, b, c) => (a & b) ^ (a & c) ^ (b & c);
 // Round constants:
 // first 32 bits of the fractional parts of the cube roots of the first 64 primes 2..311)
 // prettier-ignore
-const SHA256_K = new Uint32Array([
+const SHA256_K = /* @__PURE__ */ new Uint32Array([
     0x428a2f98, 0x71374491, 0xb5c0fbcf, 0xe9b5dba5, 0x3956c25b, 0x59f111f1, 0x923f82a4, 0xab1c5ed5,
     0xd807aa98, 0x12835b01, 0x243185be, 0x550c7dc3, 0x72be5d74, 0x80deb1fe, 0x9bdc06a7, 0xc19bf174,
     0xe49b69c1, 0xefbe4786, 0x0fc19dc6, 0x240ca1cc, 0x2de92c6f, 0x4a7484aa, 0x5cb0a9dc, 0x76f988da,
@@ -696,12 +690,12 @@ const SHA256_K = new Uint32Array([
 ]);
 // Initial state (first 32 bits of the fractional parts of the square roots of the first 8 primes 2..19):
 // prettier-ignore
-const IV = new Uint32Array([
+const IV = /* @__PURE__ */ new Uint32Array([
     0x6a09e667, 0xbb67ae85, 0x3c6ef372, 0xa54ff53a, 0x510e527f, 0x9b05688c, 0x1f83d9ab, 0x5be0cd19
 ]);
 // Temporary buffer, not used to store anything between runs
 // Named this way because it matches specification.
-const SHA256_W = new Uint32Array(64);
+const SHA256_W = /* @__PURE__ */ new Uint32Array(64);
 class SHA256 extends _sha2_js_1.SHA2 {
     constructor() {
         super(64, 32, 8, false);
@@ -24064,7 +24058,7 @@ class Client extends Base {
      * @throws On duplicate entries, missing or wrong cluster keys.
      *
      * An example of how to use createClusterDefinition:
-     * [createObolCluster](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L45)
+     * [createObolCluster](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
      */
     async createClusterDefinition(newCluster) {
         const isValid = validateDefinition(newCluster);
@@ -24093,12 +24087,24 @@ class Client extends Base {
         }
     }
     /**
-     * @param configHash The config hash of the requested cluster
+     * @returns {Promise<ClusterDefintion>} The  cluster definition for config hash
+     * @throws On not found config hash.
+     *
+     * An example of how to use getClusterDefinition:
+     * [getObolClusterDefinition](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
+     */
+    async getClusterDefinition(configHash) {
+        const clusterDefinition = await this.request(`/dv/${configHash}`, {
+            method: 'GET',
+        });
+        return clusterDefinition;
+    }
+    /**
      * @returns {Promise<ClusterLock>} The matched cluster details (lock) from DB
      * @throws On not found cluster definition or lock.
      *
      * An example of how to use getClusterLock:
-     * [getObolClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L61)
+     * [getObolClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
      */
     async getClusterLock(configHash) {
         const lock = await this.request(`/lock/configHash/${configHash}`, {

package/dist/index.js

@@ -388,14 +388,7 @@ function output(out, instance) {
     }
 }
 _assert.output = output;
-const assert = {
-    number,
-    bool,
-    bytes,
-    hash,
-    exists,
-    output,
-};
+const assert = { number, bool, bytes, hash, exists, output };
 _assert.default = assert;
 
 var utils = {};
@@ -434,7 +427,7 @@ crypto$1.crypto = typeof globalThis === 'object' && 'crypto' in globalThis ? glo
 	exports.isLE = new Uint8Array(new Uint32Array([0x11223344]).buffer)[0] === 0x44;
 	if (!exports.isLE)
 	    throw new Error('Non little-endian hardware is not supported');
-	const hexes = Array.from({ length: 256 }, (v, i) => i.toString(16).padStart(2, '0'));
+	const hexes = /* @__PURE__ */ Array.from({ length: 256 }, (_, i) => i.toString(16).padStart(2, '0'));
 	/**
 	 * @example bytesToHex(Uint8Array.from([0xca, 0xfe, 0x01, 0x23])) // 'cafe0123'
 	 */
@@ -534,10 +527,9 @@ crypto$1.crypto = typeof globalThis === 'object' && 'crypto' in globalThis ? glo
 	    }
 	}
 	exports.Hash = Hash;
-	// Check if object doens't have custom constructor (like Uint8Array/Array)
-	const isPlainObject = (obj) => Object.prototype.toString.call(obj) === '[object Object]' && obj.constructor === Object;
+	const toStr = {}.toString;
 	function checkOpts(defaults, opts) {
-	    if (opts !== undefined && (typeof opts !== 'object' || !isPlainObject(opts)))
+	    if (opts !== undefined && toStr.call(opts) !== '[object Object]')
 	        throw new Error('Options should be object or undefined');
 	    const merged = Object.assign(defaults, opts);
 	    return merged;
@@ -616,7 +608,7 @@ class SHA2 extends utils_js_1$1.Hash {
         this.view = (0, utils_js_1$1.createView)(this.buffer);
     }
     update(data) {
-        _assert_js_1.default.exists(this);
+        (0, _assert_js_1.exists)(this);
         const { view, buffer, blockLen } = this;
         data = (0, utils_js_1$1.toBytes)(data);
         const len = data.length;
@@ -642,8 +634,8 @@ class SHA2 extends utils_js_1$1.Hash {
         return this;
     }
     digestInto(out) {
-        _assert_js_1.default.exists(this);
-        _assert_js_1.default.output(out, this);
+        (0, _assert_js_1.exists)(this);
+        (0, _assert_js_1.output)(out, this);
         this.finished = true;
         // Padding
         // We can avoid allocation of buffer for padding completely if it
@@ -704,6 +696,8 @@ Object.defineProperty(sha256, "__esModule", { value: true });
 sha256.sha224 = sha256.sha256 = void 0;
 const _sha2_js_1 = _sha2;
 const utils_js_1 = utils;
+// SHA2-256 need to try 2^128 hashes to execute birthday attack.
+// BTC network is doing 2^67 hashes/sec as per early 2023.
 // Choice: a ? b : c
 const Chi = (a, b, c) => (a & b) ^ (~a & c);
 // Majority function, true if any two inpust is true
@@ -711,7 +705,7 @@ const Maj = (a, b, c) => (a & b) ^ (a & c) ^ (b & c);
 // Round constants:
 // first 32 bits of the fractional parts of the cube roots of the first 64 primes 2..311)
 // prettier-ignore
-const SHA256_K = new Uint32Array([
+const SHA256_K = /* @__PURE__ */ new Uint32Array([
     0x428a2f98, 0x71374491, 0xb5c0fbcf, 0xe9b5dba5, 0x3956c25b, 0x59f111f1, 0x923f82a4, 0xab1c5ed5,
     0xd807aa98, 0x12835b01, 0x243185be, 0x550c7dc3, 0x72be5d74, 0x80deb1fe, 0x9bdc06a7, 0xc19bf174,
     0xe49b69c1, 0xefbe4786, 0x0fc19dc6, 0x240ca1cc, 0x2de92c6f, 0x4a7484aa, 0x5cb0a9dc, 0x76f988da,
@@ -723,12 +717,12 @@ const SHA256_K = new Uint32Array([
 ]);
 // Initial state (first 32 bits of the fractional parts of the square roots of the first 8 primes 2..19):
 // prettier-ignore
-const IV = new Uint32Array([
+const IV = /* @__PURE__ */ new Uint32Array([
     0x6a09e667, 0xbb67ae85, 0x3c6ef372, 0xa54ff53a, 0x510e527f, 0x9b05688c, 0x1f83d9ab, 0x5be0cd19
 ]);
 // Temporary buffer, not used to store anything between runs
 // Named this way because it matches specification.
-const SHA256_W = new Uint32Array(64);
+const SHA256_W = /* @__PURE__ */ new Uint32Array(64);
 class SHA256 extends _sha2_js_1.SHA2 {
     constructor() {
         super(64, 32, 8, false);
@@ -24091,7 +24085,7 @@ class Client extends Base {
      * @throws On duplicate entries, missing or wrong cluster keys.
      *
      * An example of how to use createClusterDefinition:
-     * [createObolCluster](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L45)
+     * [createObolCluster](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
      */
     async createClusterDefinition(newCluster) {
         const isValid = validateDefinition(newCluster);
@@ -24120,12 +24114,24 @@ class Client extends Base {
         }
     }
     /**
-     * @param configHash The config hash of the requested cluster
+     * @returns {Promise<ClusterDefintion>} The  cluster definition for config hash
+     * @throws On not found config hash.
+     *
+     * An example of how to use getClusterDefinition:
+     * [getObolClusterDefinition](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
+     */
+    async getClusterDefinition(configHash) {
+        const clusterDefinition = await this.request(`/dv/${configHash}`, {
+            method: 'GET',
+        });
+        return clusterDefinition;
+    }
+    /**
      * @returns {Promise<ClusterLock>} The matched cluster details (lock) from DB
      * @throws On not found cluster definition or lock.
      *
      * An example of how to use getClusterLock:
-     * [getObolClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L61)
+     * [getObolClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
      */
     async getClusterLock(configHash) {
         const lock = await this.request(`/lock/configHash/${configHash}`, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@obolnetwork/obol-sdk",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "A package for creating Distributed Validators using the Obol API.",
   "main": "dist/index.js",
   "module": "dist/index.es.js",
@@ -42,13 +42,13 @@
     "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",