@obolnetwork/obol-sdk 1.0.7 → 1.0.9

package/README.md

@@ -6,4 +6,4 @@ This repo contains the Obol Software Development Kit, for creating Distributed V
 
 ## Getting Started
 
-Checkout our [docs](https://docs.obol.tech/docs/int/quickstart). Further guides and walkthroughs coming soon. 
+Checkout our [docs](https://docs.obol.tech/docs/int/quickstart/advanced/quickstart-sdk), [examples](https://github.com/ObolNetwork/obol-sdk-examples/), and SDK [reference](https://obolnetwork.github.io/obol-packages). Further guides and walkthroughs coming soon. 

package/dist/ajv.d.ts

@@ -1,4 +1,3 @@
 import { ErrorObject } from 'ajv';
-import { ClusterPayload } from './types';
-export declare function validateDefinition(data: ClusterPayload): ErrorObject[] | undefined | null;
+export declare function validatePayload(data: any, schema: any): ErrorObject[] | undefined | null | boolean;
 //# sourceMappingURL=ajv.d.ts.map

package/dist/ajv.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ajv.d.ts","sourceRoot":"","sources":["../src/ajv.ts"],"names":[],"mappings":"AAAA,OAAY,EAAE,WAAW,EAAE,MAAM,KAAK,CAAC;AAEvC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,cAAc,GAAG,WAAW,EAAE,GAAG,SAAS,GAAG,IAAI,CAQzF"}
+{"version":3,"file":"ajv.d.ts","sourceRoot":"","sources":["../src/ajv.ts"],"names":[],"mappings":"AAAA,OAAY,EAAE,WAAW,EAAE,MAAM,KAAK,CAAC;AAEvC,wBAAgB,eAAe,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,GAAG,WAAW,EAAE,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,CAQlG"}

package/dist/base.d.ts

@@ -1,6 +1,7 @@
+import { FORK_MAPPING } from './types';
 declare type Config = {
     baseUrl?: string;
-    chainId?: number;
+    chainId?: FORK_MAPPING;
 };
 export declare abstract class Base {
     baseUrl: string;

package/dist/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAGA,aAAK,MAAM,GAAG;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,8BAAsB,IAAI;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;gBAIT,EAAE,OAA0B,EAAE,OAA0B,EAAE,EAAE,MAAM;cAS9D,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC;CAqBhF"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,aAAK,MAAM,GAAG;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF,8BAAsB,IAAI;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;gBAIT,EAAE,OAA0B,EAAE,OAA0B,EAAE,EAAE,MAAM;cAM9D,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC;CAqBhF"}

package/dist/constants.d.ts

@@ -5,21 +5,26 @@ export declare const CreatorConfigHashSigningTypes: {
         type: string;
     }[];
 };
-export declare const Domain: {
+export declare const EnrSigningTypes: {
+    ENR: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const OperatorConfigHashSigningTypes: {
+    OperatorConfigHash: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const Domain: (chainId: number) => {
     name: string;
     version: string;
     chainId: number;
 };
-export declare enum FORK_MAPPING {
-    "0x00000000" = 1,
-    "0x00001020" = 5,
-    "0x00000064" = 100,
-    "0x70000069" = 1337802,
-    "0x80000069" = 3
-}
 export declare const dkg_algorithm = "default";
 export declare const config_version = "v1.7.0";
-export declare const SDK_VERSION = "1.0.3";
+export declare const SDK_VERSION = "1.0.8";
 export declare const DEFAULT_BASE_URL = "https://api.obol.tech";
-export declare const DEFAULT_CHAIN_ID = 5;
+export declare const DEFAULT_CHAIN_ID = 1;
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,kBAAkB,aAAa,CAAA;AAK5C,eAAO,MAAM,6BAA6B;;;;;CAEzC,CAAC;AACF,eAAO,MAAM,MAAM;;;;CAIlB,CAAA;AAED,oBAAY,YAAY;IACpB,YAAY,IAAI;IAChB,YAAY,IAAI;IAChB,YAAY,MAAM;IAClB,YAAY,UAAU;IACtB,YAAY,IAAI;CACnB;AAED,eAAO,MAAM,aAAa,YAAY,CAAC;AAEvC,eAAO,MAAM,cAAc,WAAW,CAAC;AAEvC,eAAO,MAAM,WAAW,UAAU,CAAC;AAEnC,eAAO,MAAM,gBAAgB,0BAA0B,CAAC;AACxD,eAAO,MAAM,gBAAgB,IAAI,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,kBAAkB,aAAa,CAAA;AAG5C,eAAO,MAAM,6BAA6B;;;;;CAEzC,CAAC;AACF,eAAO,MAAM,eAAe;;;;;CAE3B,CAAC;AACF,eAAO,MAAM,8BAA8B;;;;;CAE1C,CAAC;AACF,eAAO,MAAM,MAAM,YAAa,MAAM;;;;CAMrC,CAAA;AACD,eAAO,MAAM,aAAa,YAAY,CAAC;AACvC,eAAO,MAAM,cAAc,WAAW,CAAC;AACvC,eAAO,MAAM,WAAW,UAAU,CAAC;AACnC,eAAO,MAAM,gBAAgB,0BAA0B,CAAC;AACxD,eAAO,MAAM,gBAAgB,IAAI,CAAC"}

package/dist/fixtures.d.ts

@@ -33,6 +33,7 @@ export declare const clusterLockV1X7: {
             withdrawal_credentials: string;
             amount: string;
             signature: string;
+            deposit_data_root: string;
         };
         builder_registration: {
             message: {

package/dist/fixtures.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fixtures.d.ts","sourceRoot":"","sources":["../src/fixtures.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmF1B,CAAA;AAGF,eAAO,MAAM,aAAa;;;;;;;;;CAazB,CAAA"}
+{"version":3,"file":"fixtures.d.ts","sourceRoot":"","sources":["../src/fixtures.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoF3B,CAAA;AAED,eAAO,MAAM,aAAa;;;;;;;;;CAazB,CAAA"}

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Signer } from 'ethers';
 import { Base } from './base';
-import { ClusterDefintion, ClusterLock, ClusterPayload } from './types';
+import { ClusterDefintion, ClusterLock, ClusterPayload, OperatorPayload } from './types';
 export * from "./types";
 /**
  * Obol sdk Client can be used for creating, managing and activating distributed validators.
@@ -18,7 +18,7 @@ export declare class Client extends Base {
     constructor(config: {
         baseUrl?: string | undefined;
         chainId?: number | undefined;
-    }, signer: Signer);
+    }, signer?: Signer);
     /**
      * Creates a cluster definition which contains cluster configuration.
      * @param {ClusterPayload} newCluster - The new unique cluster.
@@ -29,6 +29,17 @@ export declare class Client extends Base {
      * [createObolCluster](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
      */
     createClusterDefinition(newCluster: ClusterPayload): Promise<string>;
+    /**
+    * Approves joining a cluster with specific configuration.
+    * @param {OperatorPayload} operatorPayload - The operator data including signatures.
+    * @param {string} configHash - The config hash of the cluster which the operator confirms joining to.
+    * @returns {Promise<ClusterDefintion>} The cluster definition.
+    * @throws On unauthorized, duplicate entries, missing keys, not found cluster or invalid data.
+    *
+    * An example of how to use updateClusterDefinition:
+    * [updateClusterDefinition](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
+    */
+    updateClusterDefinition(operatorPayload: OperatorPayload, configHash: string): Promise<ClusterDefintion>;
     /**
      * @returns {Promise<ClusterDefintion>} The  cluster definition for config hash
      * @throws On not found config hash.

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,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"}
+{"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,eAAe,EAAE,MAAM,SAAS,CAAC;AAIzF,cAAc,SAAS,CAAC;AAExB;;GAEG;AACH,qBAAa,MAAO,SAAQ,IAAI;IAC9B,OAAO,CAAC,MAAM,CAAqB;IAEnC;;;;;;;OAOG;gBACS,MAAM,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,EAAE,MAAM,CAAC,EAAE,MAAM;IAMnG;;;;;;;;OAQG;IACG,uBAAuB,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAyC1E;;;;;;;;;MASE;IACI,uBAAuB,CAAC,eAAe,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAgC9G;;;;;;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"}