@obolnetwork/obol-sdk 1.0.14 → 1.0.15

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@obolnetwork/obol-sdk",
-    "version": "1.0.14",
+    "version": "1.0.15",
     "description": "A package for creating Distributed Validators using the Obol API.",
     "bugs": {
         "url": "https://github.com/obolnetwork/obol-sdk/issues"
@@ -42,6 +42,7 @@
         "@chainsafe/discv5": "^0.5.1",
         "@chainsafe/ssz": "^0.14.0",
         "@metamask/eth-sig-util": "^7.0.1",
+        "@types/pdf-parse": "^1.1.4",
         "ajv": "^8.12.0",
         "cross-fetch": "^3.1.5",
         "elliptic": "^6.5.4",
@@ -49,9 +50,9 @@
         "eslint-plugin-import": "^2.29.1",
         "eslint-plugin-n": "^16.6.2",
         "eslint-plugin-promise": "^6.1.1",
-        "ethers": "^6.4.0",
+        "ethers": "6.4.0",
         "nock": "^13.5.3",
-        "release-it": "^17.1.1",
+        "pdf-parse": "^1.1.1",
         "semver": "^7.6.0",
         "typescript-eslint": "^7.1.0",
         "uuid": "^9.0.0"
@@ -61,11 +62,13 @@
         "@types/elliptic": "^6.4.18",
         "@types/jest": "^28.1.8",
         "@types/node": "^20.2.5",
+        "@types/semver": "^7.5.8",
         "@types/uuid": "^9.0.1",
         "eslint": "^8.57.0",
         "jest": "^28.1.3",
         "msw": "^2.2.1",
         "npm-run-all": "^4.1.5",
+        "release-it": "^17.2.1",
         "ts-jest": "^28.0.8",
         "tsup": "^6.7.0",
         "typedoc": "^0.25.7",

package/dist/cjs/src/base.js

@@ -28,7 +28,10 @@ class Base {
                 if (response.ok) {
                     return yield response.json();
                 }
-                throw new Error(response.statusText);
+                else {
+                    const errorResponse = yield response.json();
+                    throw errorResponse;
+                }
             }
             catch (e) {
                 throw e;

package/dist/cjs/src/constants.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ETHER_TO_GWEI = exports.DEFAULT_CHAIN_ID = exports.DEFAULT_BASE_URL = exports.DefinitionFlow = exports.GENESIS_VALIDATOR_ROOT = exports.DOMAIN_DEPOSIT = exports.DOMAIN_APPLICATION_BUILDER = exports.SDK_VERSION = exports.CONFIG_VERSION = exports.DKG_ALGORITHM = exports.signEnrPayload = exports.signOperatorConfigHashPayload = exports.signCreatorConfigHashPayload = exports.ENRTypedMessage = exports.OperatorTypedMessage = exports.OperatorConfigHashSigningTypes = exports.EnrSigningTypes = exports.CreatorTypedMessage = exports.Domain = exports.CreatorConfigHashSigningTypes = exports.EIP712_DOMAIN_VERSION = exports.EIP712_DOMAIN_NAME = exports.CONFLICT_ERROR_MSG = void 0;
+exports.TERMS_AND_CONDITIONS_URL = exports.TERMS_AND_CONDITIONS_VERSION = exports.ETHER_TO_GWEI = exports.DEFAULT_CHAIN_ID = exports.DEFAULT_BASE_URL = exports.DefinitionFlow = exports.GENESIS_VALIDATOR_ROOT = exports.DOMAIN_DEPOSIT = exports.DOMAIN_APPLICATION_BUILDER = exports.SDK_VERSION = exports.CONFIG_VERSION = exports.DKG_ALGORITHM = exports.signEnrPayload = exports.signOperatorConfigHashPayload = exports.signCreatorConfigHashPayload = exports.ENRTypedMessage = exports.OperatorTypedMessage = exports.OperatorConfigHashSigningTypes = exports.EnrSigningTypes = exports.CreatorTypedMessage = exports.Domain = exports.TermsAndConditionsSigningTypes = exports.CreatorConfigHashSigningTypes = exports.EIP712_DOMAIN_VERSION = exports.EIP712_DOMAIN_NAME = exports.CONFLICT_ERROR_MSG = void 0;
 const pjson = __importStar(require("../package.json"));
 exports.CONFLICT_ERROR_MSG = 'Conflict';
 exports.EIP712_DOMAIN_NAME = 'Obol';
@@ -31,17 +31,26 @@ exports.EIP712_DOMAIN_VERSION = '1';
 exports.CreatorConfigHashSigningTypes = {
     CreatorConfigHash: [{ name: 'creator_config_hash', type: 'string' }],
 };
+exports.TermsAndConditionsSigningTypes = {
+    TermsAndConditions: [
+        { name: 'terms_and_conditions_hash', type: 'string' },
+        { name: 'version', type: 'uint256' },
+    ]
+};
 const EIP712Domain = [
     { name: 'name', type: 'string' },
     { name: 'version', type: 'string' },
     { name: 'chainId', type: 'uint256' },
 ];
 const Domain = (chainId) => {
-    return {
+    const typeDataDomain = {
         name: exports.EIP712_DOMAIN_NAME,
         version: exports.EIP712_DOMAIN_VERSION,
-        chainId,
     };
+    if (chainId) {
+        typeDataDomain.chainId = chainId;
+    }
+    return typeDataDomain;
 };
 exports.Domain = Domain;
 exports.CreatorTypedMessage = Object.assign({ EIP712Domain }, exports.CreatorConfigHashSigningTypes);
@@ -99,7 +108,7 @@ exports.SDK_VERSION = pjson.version;
 exports.DOMAIN_APPLICATION_BUILDER = '00000001';
 exports.DOMAIN_DEPOSIT = '03000000';
 exports.GENESIS_VALIDATOR_ROOT = '0000000000000000000000000000000000000000000000000000000000000000';
-// Flow used to create defintion
+// Flow used to create definition
 var DefinitionFlow;
 (function (DefinitionFlow) {
     DefinitionFlow["Group"] = "LP-Group";
@@ -109,3 +118,5 @@ var DefinitionFlow;
 exports.DEFAULT_BASE_URL = 'https://api.obol.tech';
 exports.DEFAULT_CHAIN_ID = 17000;
 exports.ETHER_TO_GWEI = 10 ** 9;
+exports.TERMS_AND_CONDITIONS_VERSION = 1;
+exports.TERMS_AND_CONDITIONS_URL = (exports.TERMS_AND_CONDITIONS_VERSION === 1) ? 'https://obol.tech/terms.pdf' : `https://obol.tech/${exports.TERMS_AND_CONDITIONS_VERSION}/terms.pdf`;

package/dist/cjs/src/index.js

@@ -31,6 +31,7 @@ const errors_js_1 = require("./errors.js");
 const common_js_1 = require("./verification/common.js");
 const ajv_js_1 = require("./ajv.js");
 const schema_js_1 = require("./schema.js");
+const termsAndConditions_js_1 = require("./verification/termsAndConditions.js");
 __exportStar(require("./types.js"), exports);
 __exportStar(require("./services.js"), exports);
 /**
@@ -51,6 +52,46 @@ class Client extends base_js_1.Base {
         super(config);
         this.signer = signer;
     }
+    /**
+   * Accepts Obol terms and conditions to be able to create or update data.
+   * @returns {Promise<string>} terms and conditions acceptance success message.
+   * @throws On unverified signature or wrong hash.
+   *
+   */
+    acceptObolLatestTermsAndConditions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.signer) {
+                throw new Error('Signer is required in acceptObolTermsAndConditions');
+            }
+            try {
+                const termsAndConditionsHash = yield (0, termsAndConditions_js_1.hashTermsAndConditions)();
+                const address = yield this.signer.getAddress();
+                const termsAndConditionsPayload = {
+                    address,
+                    version: constants_js_1.TERMS_AND_CONDITIONS_VERSION,
+                    terms_and_conditions_hash: termsAndConditionsHash
+                };
+                const termsAndConditionsSignature = yield this.signer.signTypedData((0, constants_js_1.Domain)(), constants_js_1.TermsAndConditionsSigningTypes, {
+                    terms_and_conditions_hash: termsAndConditionsHash,
+                    version: constants_js_1.TERMS_AND_CONDITIONS_VERSION,
+                });
+                const termsAndConditionsResponse = yield this.request('/termsAndConditions', {
+                    method: 'POST',
+                    body: JSON.stringify(termsAndConditionsPayload),
+                    headers: {
+                        Authorization: `Bearer ${termsAndConditionsSignature}`,
+                    },
+                });
+                return termsAndConditionsResponse === null || termsAndConditionsResponse === void 0 ? void 0 : termsAndConditionsResponse.message;
+            }
+            catch (err) {
+                if ((err === null || err === void 0 ? void 0 : err.message) === constants_js_1.CONFLICT_ERROR_MSG) {
+                    throw new errors_js_1.ConflictError();
+                }
+                throw err;
+            }
+        });
+    }
     /**
      * Creates a cluster definition which contains cluster configuration.
      * @param {ClusterPayload} newCluster - The new unique cluster.
@@ -72,7 +113,7 @@ class Client extends base_js_1.Base {
                 clusterConfig.creator = { address };
                 clusterConfig.config_hash = (0, common_js_1.clusterConfigOrDefinitionHash)(clusterConfig, true);
                 const creatorConfigSignature = yield this.signer.signTypedData((0, constants_js_1.Domain)(this.chainId), constants_js_1.CreatorConfigHashSigningTypes, { creator_config_hash: clusterConfig.config_hash });
-                const clusterDefinition = yield this.request('/dv', {
+                const clusterDefinition = yield this.request('/v1/definition', {
                     method: 'POST',
                     body: JSON.stringify(clusterConfig),
                     headers: {
@@ -94,7 +135,7 @@ class Client extends base_js_1.Base {
      * 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.
+     * @returns {Promise<ClusterDefinition>} The cluster definition.
      * @throws On unauthorized, duplicate entries, missing keys, not found cluster or invalid data.
      *
      * An example of how to use acceptClusterDefinition:
@@ -111,7 +152,7 @@ class Client extends base_js_1.Base {
                 const operatorConfigSignature = yield this.signer.signTypedData((0, constants_js_1.Domain)(this.chainId), constants_js_1.OperatorConfigHashSigningTypes, { operator_config_hash: configHash });
                 const operatorENRSignature = yield this.signer.signTypedData((0, constants_js_1.Domain)(this.chainId), constants_js_1.EnrSigningTypes, { enr: operatorPayload.enr });
                 const operatorData = Object.assign(Object.assign({}, operatorPayload), { address, enr_signature: operatorENRSignature, fork_version: this.fork_version });
-                const clusterDefinition = yield this.request(`/dv/${configHash}`, {
+                const clusterDefinition = yield this.request(`/v1/definition/${configHash}`, {
                     method: 'PUT',
                     body: JSON.stringify(operatorData),
                     headers: {
@@ -127,7 +168,7 @@ class Client extends base_js_1.Base {
     }
     /**
      * @param configHash - The configuration hash returned in createClusterDefinition
-     * @returns {Promise<ClusterDefintion>} The  cluster definition for config hash
+     * @returns {Promise<ClusterDefinition>} The  cluster definition for config hash
      * @throws On not found config hash.
      *
      * An example of how to use getClusterDefinition:

package/dist/cjs/src/verification/termsAndConditions.js

@@ -0,0 +1,40 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hashTermsAndConditions = void 0;
+const pdf_parse_1 = __importDefault(require("pdf-parse"));
+const ssz_1 = require("@chainsafe/ssz");
+const constants_1 = require("../constants");
+const utils_1 = require("../utils");
+const hashTermsAndConditions = () => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        // read the pdf
+        const response = yield fetch(constants_1.TERMS_AND_CONDITIONS_URL);
+        const pdfBuffarrayBuffer = yield response.arrayBuffer();
+        const pdfBuffer = Buffer.from(pdfBuffarrayBuffer);
+        const data = yield (0, pdf_parse_1.default)(pdfBuffer);
+        // ssz hash
+        const termsType = new ssz_1.ContainerType({
+            terms_and_conditions_hash: new ssz_1.ByteListType(Number.MAX_SAFE_INTEGER),
+        });
+        const termsHasVal = termsType.defaultValue();
+        termsHasVal.terms_and_conditions_hash = (0, utils_1.strToUint8Array)(data === null || data === void 0 ? void 0 : data.text);
+        return ('0x' +
+            Buffer.from(termsType.hashTreeRoot(termsHasVal).buffer).toString('hex'));
+    }
+    catch (err) {
+        return null;
+    }
+});
+exports.hashTermsAndConditions = hashTermsAndConditions;

package/dist/cjs/test/methods.test.js

@@ -17,6 +17,7 @@ const base_1 = require("../src/base");
 const ajv_1 = require("../src/ajv");
 const msw_1 = require("msw");
 const node_1 = require("msw/node");
+const termsAndConditions_1 = require("../src/verification/termsAndConditions");
 /* eslint no-new: 0 */
 describe('Cluster Client', () => {
     var _a, _b;
@@ -33,6 +34,13 @@ describe('Cluster Client', () => {
     //     expect(error.message).toBe('Obol-SDK is in Beta phase, mainnet is not yet supported')
     //   }
     // })
+    test('createTermsAndConditions should return "successful authorization"', () => __awaiter(void 0, void 0, void 0, function* () {
+        clientInstance['request'] = jest
+            .fn()
+            .mockReturnValue(Promise.resolve({ message: 'successful authorization' }));
+        const isAuthorized = yield clientInstance.acceptObolLatestTermsAndConditions();
+        expect(isAuthorized).toEqual('successful authorization');
+    }));
     test('createClusterDefinition should return config_hash', () => __awaiter(void 0, void 0, void 0, function* () {
         clientInstance['request'] = jest
             .fn()
@@ -148,4 +156,8 @@ describe('Cluster Client without a signer', () => {
         const isValidLock = yield (0, index_1.validateClusterLock)(clusterLock);
         expect(isValidLock).toEqual(true);
     }));
+    test('Finds the hash of the latest version of terms and conditions', () => __awaiter(void 0, void 0, void 0, function* () {
+        const termsAndConditionsHash = yield (0, termsAndConditions_1.hashTermsAndConditions)();
+        expect(termsAndConditionsHash).toEqual('0x0015d01710b4d864004320a4826f6846c2db12a7f056a126fa5ae16c0b5e2b65');
+    }));
 });

package/dist/esm/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@obolnetwork/obol-sdk",
-    "version": "1.0.14",
+    "version": "1.0.15",
     "description": "A package for creating Distributed Validators using the Obol API.",
     "bugs": {
         "url": "https://github.com/obolnetwork/obol-sdk/issues"
@@ -42,6 +42,7 @@
         "@chainsafe/discv5": "^0.5.1",
         "@chainsafe/ssz": "^0.14.0",
         "@metamask/eth-sig-util": "^7.0.1",
+        "@types/pdf-parse": "^1.1.4",
         "ajv": "^8.12.0",
         "cross-fetch": "^3.1.5",
         "elliptic": "^6.5.4",
@@ -49,9 +50,9 @@
         "eslint-plugin-import": "^2.29.1",
         "eslint-plugin-n": "^16.6.2",
         "eslint-plugin-promise": "^6.1.1",
-        "ethers": "^6.4.0",
+        "ethers": "6.4.0",
         "nock": "^13.5.3",
-        "release-it": "^17.1.1",
+        "pdf-parse": "^1.1.1",
         "semver": "^7.6.0",
         "typescript-eslint": "^7.1.0",
         "uuid": "^9.0.0"
@@ -61,11 +62,13 @@
         "@types/elliptic": "^6.4.18",
         "@types/jest": "^28.1.8",
         "@types/node": "^20.2.5",
+        "@types/semver": "^7.5.8",
         "@types/uuid": "^9.0.1",
         "eslint": "^8.57.0",
         "jest": "^28.1.3",
         "msw": "^2.2.1",
         "npm-run-all": "^4.1.5",
+        "release-it": "^17.2.1",
         "ts-jest": "^28.0.8",
         "tsup": "^6.7.0",
         "typedoc": "^0.25.7",

package/dist/esm/src/base.js

@@ -25,7 +25,10 @@ export class Base {
                 if (response.ok) {
                     return yield response.json();
                 }
-                throw new Error(response.statusText);
+                else {
+                    const errorResponse = yield response.json();
+                    throw errorResponse;
+                }
             }
             catch (e) {
                 throw e;

package/dist/esm/src/constants.js

@@ -5,17 +5,26 @@ export const EIP712_DOMAIN_VERSION = '1';
 export const CreatorConfigHashSigningTypes = {
     CreatorConfigHash: [{ name: 'creator_config_hash', type: 'string' }],
 };
+export const TermsAndConditionsSigningTypes = {
+    TermsAndConditions: [
+        { name: 'terms_and_conditions_hash', type: 'string' },
+        { name: 'version', type: 'uint256' },
+    ]
+};
 const EIP712Domain = [
     { name: 'name', type: 'string' },
     { name: 'version', type: 'string' },
     { name: 'chainId', type: 'uint256' },
 ];
 export const Domain = (chainId) => {
-    return {
+    const typeDataDomain = {
         name: EIP712_DOMAIN_NAME,
         version: EIP712_DOMAIN_VERSION,
-        chainId,
     };
+    if (chainId) {
+        typeDataDomain.chainId = chainId;
+    }
+    return typeDataDomain;
 };
 export const CreatorTypedMessage = Object.assign({ EIP712Domain }, CreatorConfigHashSigningTypes);
 // A conflict once updateDefinition is merged
@@ -69,7 +78,7 @@ export const SDK_VERSION = pjson.version;
 export const DOMAIN_APPLICATION_BUILDER = '00000001';
 export const DOMAIN_DEPOSIT = '03000000';
 export const GENESIS_VALIDATOR_ROOT = '0000000000000000000000000000000000000000000000000000000000000000';
-// Flow used to create defintion
+// Flow used to create definition
 export var DefinitionFlow;
 (function (DefinitionFlow) {
     DefinitionFlow["Group"] = "LP-Group";
@@ -79,3 +88,5 @@ export var DefinitionFlow;
 export const DEFAULT_BASE_URL = 'https://api.obol.tech';
 export const DEFAULT_CHAIN_ID = 17000;
 export const ETHER_TO_GWEI = 10 ** 9;
+export const TERMS_AND_CONDITIONS_VERSION = 1;
+export const TERMS_AND_CONDITIONS_URL = (TERMS_AND_CONDITIONS_VERSION === 1) ? 'https://obol.tech/terms.pdf' : `https://obol.tech/${TERMS_AND_CONDITIONS_VERSION}/terms.pdf`;

package/dist/esm/src/index.js

@@ -9,11 +9,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { v4 as uuidv4 } from 'uuid';
 import { Base } from './base.js';
-import { CONFLICT_ERROR_MSG, CreatorConfigHashSigningTypes, Domain, DKG_ALGORITHM, CONFIG_VERSION, OperatorConfigHashSigningTypes, EnrSigningTypes, } from './constants.js';
+import { CONFLICT_ERROR_MSG, CreatorConfigHashSigningTypes, Domain, DKG_ALGORITHM, CONFIG_VERSION, OperatorConfigHashSigningTypes, EnrSigningTypes, TERMS_AND_CONDITIONS_VERSION, TermsAndConditionsSigningTypes, } from './constants.js';
 import { ConflictError } from './errors.js';
 import { clusterConfigOrDefinitionHash } from './verification/common.js';
 import { validatePayload } from './ajv.js';
 import { definitionSchema, operatorPayloadSchema } from './schema.js';
+import { hashTermsAndConditions } from './verification/termsAndConditions.js';
 export * from './types.js';
 export * from './services.js';
 /**
@@ -34,6 +35,46 @@ export class Client extends Base {
         super(config);
         this.signer = signer;
     }
+    /**
+   * Accepts Obol terms and conditions to be able to create or update data.
+   * @returns {Promise<string>} terms and conditions acceptance success message.
+   * @throws On unverified signature or wrong hash.
+   *
+   */
+    acceptObolLatestTermsAndConditions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.signer) {
+                throw new Error('Signer is required in acceptObolTermsAndConditions');
+            }
+            try {
+                const termsAndConditionsHash = yield hashTermsAndConditions();
+                const address = yield this.signer.getAddress();
+                const termsAndConditionsPayload = {
+                    address,
+                    version: TERMS_AND_CONDITIONS_VERSION,
+                    terms_and_conditions_hash: termsAndConditionsHash
+                };
+                const termsAndConditionsSignature = yield this.signer.signTypedData(Domain(), TermsAndConditionsSigningTypes, {
+                    terms_and_conditions_hash: termsAndConditionsHash,
+                    version: TERMS_AND_CONDITIONS_VERSION,
+                });
+                const termsAndConditionsResponse = yield this.request('/termsAndConditions', {
+                    method: 'POST',
+                    body: JSON.stringify(termsAndConditionsPayload),
+                    headers: {
+                        Authorization: `Bearer ${termsAndConditionsSignature}`,
+                    },
+                });
+                return termsAndConditionsResponse === null || termsAndConditionsResponse === void 0 ? void 0 : termsAndConditionsResponse.message;
+            }
+            catch (err) {
+                if ((err === null || err === void 0 ? void 0 : err.message) === CONFLICT_ERROR_MSG) {
+                    throw new ConflictError();
+                }
+                throw err;
+            }
+        });
+    }
     /**
      * Creates a cluster definition which contains cluster configuration.
      * @param {ClusterPayload} newCluster - The new unique cluster.
@@ -55,7 +96,7 @@ export class Client extends Base {
                 clusterConfig.creator = { address };
                 clusterConfig.config_hash = clusterConfigOrDefinitionHash(clusterConfig, true);
                 const creatorConfigSignature = yield this.signer.signTypedData(Domain(this.chainId), CreatorConfigHashSigningTypes, { creator_config_hash: clusterConfig.config_hash });
-                const clusterDefinition = yield this.request('/dv', {
+                const clusterDefinition = yield this.request('/v1/definition', {
                     method: 'POST',
                     body: JSON.stringify(clusterConfig),
                     headers: {
@@ -77,7 +118,7 @@ export class Client extends Base {
      * 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.
+     * @returns {Promise<ClusterDefinition>} The cluster definition.
      * @throws On unauthorized, duplicate entries, missing keys, not found cluster or invalid data.
      *
      * An example of how to use acceptClusterDefinition:
@@ -94,7 +135,7 @@ export class Client extends Base {
                 const operatorConfigSignature = yield this.signer.signTypedData(Domain(this.chainId), OperatorConfigHashSigningTypes, { operator_config_hash: configHash });
                 const operatorENRSignature = yield this.signer.signTypedData(Domain(this.chainId), EnrSigningTypes, { enr: operatorPayload.enr });
                 const operatorData = Object.assign(Object.assign({}, operatorPayload), { address, enr_signature: operatorENRSignature, fork_version: this.fork_version });
-                const clusterDefinition = yield this.request(`/dv/${configHash}`, {
+                const clusterDefinition = yield this.request(`/v1/definition/${configHash}`, {
                     method: 'PUT',
                     body: JSON.stringify(operatorData),
                     headers: {
@@ -110,7 +151,7 @@ export class Client extends Base {
     }
     /**
      * @param configHash - The configuration hash returned in createClusterDefinition
-     * @returns {Promise<ClusterDefintion>} The  cluster definition for config hash
+     * @returns {Promise<ClusterDefinition>} The  cluster definition for config hash
      * @throws On not found config hash.
      *
      * An example of how to use getClusterDefinition:

package/dist/esm/src/verification/termsAndConditions.js

@@ -0,0 +1,33 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import pdf from 'pdf-parse';
+import { ByteListType, ContainerType } from '@chainsafe/ssz';
+import { TERMS_AND_CONDITIONS_URL } from '../constants';
+import { strToUint8Array } from '../utils';
+export const hashTermsAndConditions = () => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        // read the pdf
+        const response = yield fetch(TERMS_AND_CONDITIONS_URL);
+        const pdfBuffarrayBuffer = yield response.arrayBuffer();
+        const pdfBuffer = Buffer.from(pdfBuffarrayBuffer);
+        const data = yield pdf(pdfBuffer);
+        // ssz hash
+        const termsType = new ContainerType({
+            terms_and_conditions_hash: new ByteListType(Number.MAX_SAFE_INTEGER),
+        });
+        const termsHasVal = termsType.defaultValue();
+        termsHasVal.terms_and_conditions_hash = strToUint8Array(data === null || data === void 0 ? void 0 : data.text);
+        return ('0x' +
+            Buffer.from(termsType.hashTreeRoot(termsHasVal).buffer).toString('hex'));
+    }
+    catch (err) {
+        return null;
+    }
+});

package/dist/esm/test/methods.test.js

@@ -15,6 +15,7 @@ import { Base } from '../src/base';
 import { validatePayload } from '../src/ajv';
 import { HttpResponse, http } from 'msw';
 import { setupServer } from 'msw/node';
+import { hashTermsAndConditions } from '../src/verification/termsAndConditions';
 /* eslint no-new: 0 */
 describe('Cluster Client', () => {
     var _a, _b;
@@ -31,6 +32,13 @@ describe('Cluster Client', () => {
     //     expect(error.message).toBe('Obol-SDK is in Beta phase, mainnet is not yet supported')
     //   }
     // })
+    test('createTermsAndConditions should return "successful authorization"', () => __awaiter(void 0, void 0, void 0, function* () {
+        clientInstance['request'] = jest
+            .fn()
+            .mockReturnValue(Promise.resolve({ message: 'successful authorization' }));
+        const isAuthorized = yield clientInstance.acceptObolLatestTermsAndConditions();
+        expect(isAuthorized).toEqual('successful authorization');
+    }));
     test('createClusterDefinition should return config_hash', () => __awaiter(void 0, void 0, void 0, function* () {
         clientInstance['request'] = jest
             .fn()
@@ -146,4 +154,8 @@ describe('Cluster Client without a signer', () => {
         const isValidLock = yield validateClusterLock(clusterLock);
         expect(isValidLock).toEqual(true);
     }));
+    test('Finds the hash of the latest version of terms and conditions', () => __awaiter(void 0, void 0, void 0, function* () {
+        const termsAndConditionsHash = yield hashTermsAndConditions();
+        expect(termsAndConditionsHash).toEqual('0x0015d01710b4d864004320a4826f6846c2db12a7f056a126fa5ae16c0b5e2b65');
+    }));
 });

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

@@ -9,7 +9,13 @@ export declare const CreatorConfigHashSigningTypes: {
         type: string;
     }[];
 };
-export declare const Domain: (chainId: number) => TypedDataDomain;
+export declare const TermsAndConditionsSigningTypes: {
+    TermsAndConditions: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const Domain: (chainId?: number) => TypedDataDomain;
 export declare const CreatorTypedMessage: {
     CreatorConfigHash: {
         name: string;
@@ -75,3 +81,5 @@ export declare enum DefinitionFlow {
 export declare const DEFAULT_BASE_URL = "https://api.obol.tech";
 export declare const DEFAULT_CHAIN_ID = 17000;
 export declare const ETHER_TO_GWEI: number;
+export declare const TERMS_AND_CONDITIONS_VERSION = 1;
+export declare const TERMS_AND_CONDITIONS_URL: string;

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

@@ -1,6 +1,6 @@
 import { type Signer } from 'ethers';
 import { Base } from './base.js';
-import { type ClusterDefintion, type ClusterLock, type ClusterPayload, type OperatorPayload } from './types.js';
+import { type ClusterDefinition, type ClusterLock, type ClusterPayload, type OperatorPayload } from './types.js';
 export * from './types.js';
 export * from './services.js';
 /**
@@ -22,6 +22,13 @@ export declare class Client extends Base {
         baseUrl?: string;
         chainId?: number;
     }, signer?: Signer);
+    /**
+   * Accepts Obol terms and conditions to be able to create or update data.
+   * @returns {Promise<string>} terms and conditions acceptance success message.
+   * @throws On unverified signature or wrong hash.
+   *
+   */
+    acceptObolLatestTermsAndConditions(): Promise<string>;
     /**
      * Creates a cluster definition which contains cluster configuration.
      * @param {ClusterPayload} newCluster - The new unique cluster.
@@ -36,22 +43,22 @@ export declare class Client extends Base {
      * 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.
+     * @returns {Promise<ClusterDefinition>} The cluster definition.
      * @throws On unauthorized, duplicate entries, missing keys, not found cluster or invalid data.
      *
      * An example of how to use acceptClusterDefinition:
      * [acceptClusterDefinition](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
      */
-    acceptClusterDefinition(operatorPayload: OperatorPayload, configHash: string): Promise<ClusterDefintion>;
+    acceptClusterDefinition(operatorPayload: OperatorPayload, configHash: string): Promise<ClusterDefinition>;
     /**
      * @param configHash - The configuration hash returned in createClusterDefinition
-     * @returns {Promise<ClusterDefintion>} The  cluster definition for config hash
+     * @returns {Promise<ClusterDefinition>} 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>;
+    getClusterDefinition(configHash: string): Promise<ClusterDefinition>;
     /**
      * @param configHash - The configuration hash in cluster-definition
      * @returns {Promise<ClusterLock>} The matched cluster details (lock) from DB

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

@@ -66,7 +66,7 @@ export interface ClusterPayload {
 /**
  * Cluster definition data needed for dkg
  */
-export interface ClusterDefintion extends ClusterPayload {
+export interface ClusterDefinition extends ClusterPayload {
     /** The creator of the cluster. */
     creator: ClusterCreator;
     /** The cluster configuration version. */
@@ -147,7 +147,7 @@ export interface DistributedValidator {
  */
 export interface ClusterLock {
     /** The cluster definition. */
-    cluster_definition: ClusterDefintion;
+    cluster_definition: ClusterDefinition;
     /** The cluster distributed validators. */
     distributed_validators: DistributedValidator[];
     /** The cluster bls signature aggregate. */

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

@@ -1,5 +1,5 @@
 import { DefinitionFlow } from './constants';
-import { type ClusterDefintion } from './types';
+import { type ClusterDefinition } from './types';
 export declare const hexWithout0x: (hex: string) => string;
 export declare const strToUint8Array: (str: string) => Uint8Array;
-export declare const definitionFlow: (clusterDefinition: ClusterDefintion) => DefinitionFlow | null;
+export declare const definitionFlow: (clusterDefinition: ClusterDefinition) => DefinitionFlow | null;

package/dist/types/src/verification/common.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="node" />
-import { type ClusterDefintion, type ClusterLock, type DepositData, type DistributedValidator } from '../types.js';
+import { type ClusterDefinition, type ClusterLock, type DepositData, type DistributedValidator } from '../types.js';
 /**
  * @param cluster The cluster configuration or the cluster definition
  * @param configOnly a boolean to indicate config hash or definition hash
  * @returns The config hash or the definition hash in of the corresponding cluster
  */
-export declare const clusterConfigOrDefinitionHash: (cluster: ClusterDefintion, configOnly: boolean) => string;
+export declare const clusterConfigOrDefinitionHash: (cluster: ClusterDefinition, configOnly: boolean) => string;
 /**
  * Returns the SSZ cluster lock hash of the given cluster lock object
  * @param cluster The cluster lock whose lock hash needs to be calculated

package/dist/types/src/verification/termsAndConditions.d.ts

@@ -0,0 +1 @@
+export declare const hashTermsAndConditions: () => Promise<string | null>;

package/dist/types/src/verification/v1.6.0.d.ts

@@ -2,7 +2,7 @@ import { UintNumberType } from '@chainsafe/ssz/lib/type/uint';
 import { type creatorAddressWrapperType, type creatorContainerType, type operatorAddressWrapperType, type operatorContainerType, validatorsContainerType } from './sszTypes';
 import { ByteListType, ByteVectorType, ContainerType, ListCompositeType } from '@chainsafe/ssz';
 import { type ValueOfFields } from '@chainsafe/ssz/lib/view/container';
-import { type ClusterDefintion, type ClusterLock } from '../types';
+import { type ClusterDefinition, type ClusterLock } from '../types';
 type DefinitionFieldsV1X6 = {
     uuid: ByteListType;
     name: ByteListType;
@@ -24,7 +24,7 @@ type DefinitionContainerTypeV1X6 = ContainerType<DefinitionFieldsV1X6>;
  * @returns SSZ Containerized type of cluster input
  */
 export declare const clusterDefinitionContainerTypeV1X6: (configOnly: boolean) => DefinitionContainerTypeV1X6;
-export declare const hashClusterDefinitionV1X6: (cluster: ClusterDefintion, configOnly: boolean) => ValueOfFields<DefinitionFieldsV1X6>;
+export declare const hashClusterDefinitionV1X6: (cluster: ClusterDefinition, configOnly: boolean) => ValueOfFields<DefinitionFieldsV1X6>;
 /**
  * @param cluster The published cluster lock
  * @returns The lock hash in of the corresponding cluster

package/dist/types/src/verification/v1.7.0.d.ts

@@ -2,7 +2,7 @@ import { UintNumberType } from '@chainsafe/ssz/lib/type/uint';
 import { type creatorAddressWrapperType, type creatorContainerType, type operatorAddressWrapperType, type operatorContainerType, validatorsContainerType } from './sszTypes';
 import { ByteListType, ByteVectorType, ContainerType, ListCompositeType } from '@chainsafe/ssz';
 import { type ValueOfFields } from '@chainsafe/ssz/lib/view/container';
-import { type ClusterDefintion, type ClusterLock } from '../types';
+import { type ClusterDefinition, type ClusterLock } from '../types';
 type DefinitionFieldsV1X7 = {
     uuid: ByteListType;
     name: ByteListType;
@@ -24,7 +24,7 @@ type DefinitionContainerTypeV1X7 = ContainerType<DefinitionFieldsV1X7>;
  * @returns SSZ Containerized type of cluster input
  */
 export declare const clusterDefinitionContainerTypeV1X7: (configOnly: boolean) => DefinitionContainerTypeV1X7;
-export declare const hashClusterDefinitionV1X7: (cluster: ClusterDefintion, configOnly: boolean) => ValueOfFields<DefinitionFieldsV1X7>;
+export declare const hashClusterDefinitionV1X7: (cluster: ClusterDefinition, configOnly: boolean) => ValueOfFields<DefinitionFieldsV1X7>;
 /**
  * @param cluster The published cluster lock
  * @returns The lock hash in of the corresponding cluster

package/dist/types/src/verification/v1.8.0.d.ts

@@ -2,7 +2,7 @@ import { UintNumberType } from '@chainsafe/ssz/lib/type/uint';
 import { type creatorAddressWrapperType, type creatorContainerType, type operatorAddressWrapperType, type operatorContainerType, validatorsContainerType } from './sszTypes';
 import { ByteListType, ByteVectorType, ContainerType, ListBasicType, ListCompositeType } from '@chainsafe/ssz';
 import { type ValueOfFields } from '@chainsafe/ssz/lib/view/container';
-import { type ClusterDefintion, type ClusterLock } from '../types';
+import { type ClusterDefinition, type ClusterLock } from '../types';
 type DefinitionFieldsV1X8 = {
     uuid: ByteListType;
     name: ByteListType;
@@ -25,7 +25,7 @@ type DefinitionContainerTypeV1X8 = ContainerType<DefinitionFieldsV1X8>;
  * @returns SSZ Containerized type of cluster input
  */
 export declare const clusterDefinitionContainerTypeV1X8: (configOnly: boolean) => DefinitionContainerTypeV1X8;
-export declare const hashClusterDefinitionV1X8: (cluster: ClusterDefintion, configOnly: boolean) => ValueOfFields<DefinitionFieldsV1X8>;
+export declare const hashClusterDefinitionV1X8: (cluster: ClusterDefinition, configOnly: boolean) => ValueOfFields<DefinitionFieldsV1X8>;
 /**
  * @param cluster The published cluster lock
  * @returns The lock hash in of the corresponding cluster

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@obolnetwork/obol-sdk",
-  "version": "1.0.14",
+  "version": "1.0.15",
   "description": "A package for creating Distributed Validators using the Obol API.",
   "bugs": {
     "url": "https://github.com/obolnetwork/obol-sdk/issues"
@@ -42,6 +42,7 @@
     "@chainsafe/discv5": "^0.5.1",
     "@chainsafe/ssz": "^0.14.0",
     "@metamask/eth-sig-util": "^7.0.1",
+    "@types/pdf-parse": "^1.1.4",
     "ajv": "^8.12.0",
     "cross-fetch": "^3.1.5",
     "elliptic": "^6.5.4",
@@ -49,9 +50,9 @@
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-promise": "^6.1.1",
-    "ethers": "^6.4.0",
+    "ethers": "6.4.0",
     "nock": "^13.5.3",
-    "release-it": "^17.1.1",
+    "pdf-parse": "^1.1.1",
     "semver": "^7.6.0",
     "typescript-eslint": "^7.1.0",
     "uuid": "^9.0.0"
@@ -61,11 +62,13 @@
     "@types/elliptic": "^6.4.18",
     "@types/jest": "^28.1.8",
     "@types/node": "^20.2.5",
+    "@types/semver": "^7.5.8",
     "@types/uuid": "^9.0.1",
     "eslint": "^8.57.0",
     "jest": "^28.1.3",
     "msw": "^2.2.1",
     "npm-run-all": "^4.1.5",
+    "release-it": "^17.2.1",
     "ts-jest": "^28.0.8",
     "tsup": "^6.7.0",
     "typedoc": "^0.25.7",

package/src/base.ts

@@ -39,9 +39,11 @@ export abstract class Base {
       const response = await fetch(url, config)
       if (response.ok) {
         return await response.json()
+      } else {
+        const errorResponse = await response.json()
+        throw errorResponse
       }
-      throw new Error(response.statusText)
-    } catch (e) {
+    } catch (e: any) {
       throw e
     }
   }

package/src/constants.ts

@@ -9,6 +9,12 @@ export const EIP712_DOMAIN_VERSION = '1'
 export const CreatorConfigHashSigningTypes = {
   CreatorConfigHash: [{ name: 'creator_config_hash', type: 'string' }],
 }
+export const TermsAndConditionsSigningTypes = {
+  TermsAndConditions: [
+    { name: 'terms_and_conditions_hash', type: 'string' },
+    { name: 'version', type: 'uint256' },
+  ]
+}
 
 const EIP712Domain = [
   { name: 'name', type: 'string' },
@@ -16,12 +22,15 @@ const EIP712Domain = [
   { name: 'chainId', type: 'uint256' },
 ]
 
-export const Domain = (chainId: number): TypedDataDomain => {
-  return {
+export const Domain = (chainId?: number): TypedDataDomain => {
+  const typeDataDomain: any = {
     name: EIP712_DOMAIN_NAME,
     version: EIP712_DOMAIN_VERSION,
-    chainId,
   }
+  if (chainId) {
+    typeDataDomain.chainId = chainId
+  }
+  return typeDataDomain
 }
 
 export const CreatorTypedMessage = {
@@ -107,7 +116,7 @@ export const DOMAIN_DEPOSIT = '03000000'
 export const GENESIS_VALIDATOR_ROOT =
   '0000000000000000000000000000000000000000000000000000000000000000'
 
-// Flow used to create defintion
+// Flow used to create definition
 export enum DefinitionFlow {
   Group = 'LP-Group',
   Solo = 'LP-Solo',
@@ -118,3 +127,6 @@ export const DEFAULT_BASE_URL = 'https://api.obol.tech'
 export const DEFAULT_CHAIN_ID = 17000
 
 export const ETHER_TO_GWEI = 10 ** 9
+
+export const TERMS_AND_CONDITIONS_VERSION = 1
+export const TERMS_AND_CONDITIONS_URL = (TERMS_AND_CONDITIONS_VERSION === 1) ? 'https://obol.tech/terms.pdf' : `https://obol.tech/${TERMS_AND_CONDITIONS_VERSION as number}/terms.pdf`

package/src/index.ts

@@ -9,10 +9,12 @@ import {
   CONFIG_VERSION,
   OperatorConfigHashSigningTypes,
   EnrSigningTypes,
+  TERMS_AND_CONDITIONS_VERSION,
+  TermsAndConditionsSigningTypes,
 } from './constants.js'
 import { ConflictError } from './errors.js'
 import {
-  type ClusterDefintion,
+  type ClusterDefinition,
   type ClusterLock,
   type ClusterPayload,
   type OperatorPayload,
@@ -20,6 +22,7 @@ import {
 import { clusterConfigOrDefinitionHash } from './verification/common.js'
 import { validatePayload } from './ajv.js'
 import { definitionSchema, operatorPayloadSchema } from './schema.js'
+import { hashTermsAndConditions } from './verification/termsAndConditions.js'
 export * from './types.js'
 export * from './services.js'
 
@@ -47,6 +50,49 @@ export class Client extends Base {
     this.signer = signer
   }
 
+  /**
+ * Accepts Obol terms and conditions to be able to create or update data.
+ * @returns {Promise<string>} terms and conditions acceptance success message.
+ * @throws On unverified signature or wrong hash.
+ *
+ */
+  async acceptObolLatestTermsAndConditions (): Promise<string> {
+    if (!this.signer) { throw new Error('Signer is required in acceptObolTermsAndConditions') }
+
+    try {
+      const termsAndConditionsHash = await hashTermsAndConditions()
+      const address = await this.signer.getAddress()
+      const termsAndConditionsPayload = {
+        address,
+        version: TERMS_AND_CONDITIONS_VERSION,
+        terms_and_conditions_hash: termsAndConditionsHash
+      }
+
+      const termsAndConditionsSignature = await this.signer.signTypedData(
+        Domain(),
+        TermsAndConditionsSigningTypes,
+        {
+          terms_and_conditions_hash: termsAndConditionsHash,
+          version: TERMS_AND_CONDITIONS_VERSION,
+        },
+      )
+
+      const termsAndConditionsResponse: { message: string, success: boolean } = await this.request('/termsAndConditions', {
+        method: 'POST',
+        body: JSON.stringify(termsAndConditionsPayload),
+        headers: {
+          Authorization: `Bearer ${termsAndConditionsSignature}`,
+        },
+      })
+      return termsAndConditionsResponse?.message
+    } catch (err: any) {
+      if (err?.message === CONFLICT_ERROR_MSG) {
+        throw new ConflictError()
+      }
+      throw err
+    }
+  }
+
   /**
    * Creates a cluster definition which contains cluster configuration.
    * @param {ClusterPayload} newCluster - The new unique cluster.
@@ -61,7 +107,7 @@ export class Client extends Base {
 
     validatePayload(newCluster, definitionSchema)
 
-    const clusterConfig: Partial<ClusterDefintion> = {
+    const clusterConfig: Partial<ClusterDefinition> = {
       ...newCluster,
       fork_version: this.fork_version,
       dkg_algorithm: DKG_ALGORITHM,
@@ -77,7 +123,7 @@ export class Client extends Base {
 
       clusterConfig.creator = { address }
       clusterConfig.config_hash = clusterConfigOrDefinitionHash(
-        clusterConfig as ClusterDefintion,
+        clusterConfig as ClusterDefinition,
         true,
       )
 
@@ -87,7 +133,7 @@ export class Client extends Base {
         { creator_config_hash: clusterConfig.config_hash },
       )
 
-      const clusterDefinition: ClusterDefintion = await this.request('/dv', {
+      const clusterDefinition: ClusterDefinition = await this.request('/v1/definition', {
         method: 'POST',
         body: JSON.stringify(clusterConfig),
         headers: {
@@ -108,7 +154,7 @@ export class Client extends Base {
    * 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.
+   * @returns {Promise<ClusterDefinition>} The cluster definition.
    * @throws On unauthorized, duplicate entries, missing keys, not found cluster or invalid data.
    *
    * An example of how to use acceptClusterDefinition:
@@ -117,7 +163,7 @@ export class Client extends Base {
   async acceptClusterDefinition (
     operatorPayload: OperatorPayload,
     configHash: string,
-  ): Promise<ClusterDefintion> {
+  ): Promise<ClusterDefinition> {
     if (!this.signer) { throw new Error('Signer is required in acceptClusterDefinition') }
 
     validatePayload(operatorPayload, operatorPayloadSchema)
@@ -142,8 +188,8 @@ export class Client extends Base {
         enr_signature: operatorENRSignature,
         fork_version: this.fork_version,
       }
-      const clusterDefinition: ClusterDefintion = await this.request(
-        `/dv/${configHash}`,
+      const clusterDefinition: ClusterDefinition = await this.request(
+        `/v1/definition/${configHash}`,
         {
           method: 'PUT',
           body: JSON.stringify(operatorData),
@@ -160,14 +206,14 @@ export class Client extends Base {
 
   /**
    * @param configHash - The configuration hash returned in createClusterDefinition
-   * @returns {Promise<ClusterDefintion>} The  cluster definition for config hash
+   * @returns {Promise<ClusterDefinition>} 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: string): Promise<ClusterDefintion> {
-    const clusterDefinition: ClusterDefintion = await this.request(
+  async getClusterDefinition (configHash: string): Promise<ClusterDefinition> {
+    const clusterDefinition: ClusterDefinition = await this.request(
       `/dv/${configHash}`,
       {
         method: 'GET',

package/src/types.ts

@@ -85,7 +85,7 @@ export interface ClusterPayload {
 /**
  * Cluster definition data needed for dkg
  */
-export interface ClusterDefintion extends ClusterPayload {
+export interface ClusterDefinition extends ClusterPayload {
   /** The creator of the cluster. */
   creator: ClusterCreator
 
@@ -193,7 +193,7 @@ export interface DistributedValidator {
  */
 export interface ClusterLock {
   /** The cluster definition. */
-  cluster_definition: ClusterDefintion
+  cluster_definition: ClusterDefinition
 
   /** The cluster distributed validators. */
   distributed_validators: DistributedValidator[]

package/src/utils.ts

@@ -1,5 +1,5 @@
 import { DefinitionFlow } from './constants'
-import { type ClusterDefintion } from './types'
+import { type ClusterDefinition } from './types'
 
 export const hexWithout0x = (hex: string): string => {
   return hex.slice(2, hex.length)
@@ -10,7 +10,7 @@ export const strToUint8Array = (str: string): Uint8Array => {
 }
 
 export const definitionFlow = (
-  clusterDefinition: ClusterDefintion,
+  clusterDefinition: ClusterDefinition,
 ): DefinitionFlow | null => {
   if (
     clusterDefinition.creator.address &&

package/src/verification/common.ts

@@ -6,7 +6,7 @@ import {
     init,
 } from '@chainsafe/bls'
 
-import { FORK_MAPPING, type ClusterDefintion, type ClusterLock, type DepositData, type BuilderRegistrationMessage, type DistributedValidator } from '../types.js'
+import { FORK_MAPPING, type ClusterDefinition, type ClusterLock, type DepositData, type BuilderRegistrationMessage, type DistributedValidator } from '../types.js'
 import * as semver from 'semver'
 import { clusterDefinitionContainerTypeV1X6, hashClusterDefinitionV1X6, hashClusterLockV1X6, verifyDVV1X6 } from './v1.6.0.js'
 import { clusterDefinitionContainerTypeV1X7, hashClusterDefinitionV1X7, hashClusterLockV1X7, verifyDVV1X7 } from './v1.7.0.js'
@@ -26,7 +26,7 @@ import { clusterDefinitionContainerTypeV1X8, hashClusterDefinitionV1X8, hashClus
  * @returns The config hash or the definition hash in of the corresponding cluster
  */
 export const clusterConfigOrDefinitionHash = (
-    cluster: ClusterDefintion,
+    cluster: ClusterDefinition,
     configOnly: boolean,
 ): string => {
     let definitionType, val
@@ -142,7 +142,7 @@ const getEnrSigner = (
 }
 
 const verifyDefinitionSignatures = (
-    clusterDefinition: ClusterDefintion,
+    clusterDefinition: ClusterDefinition,
     definitionType: DefinitionFlow,
 ): boolean => {
     if (definitionType === DefinitionFlow.Charon) {

package/src/verification/termsAndConditions.ts

@@ -0,0 +1,30 @@
+import pdf from 'pdf-parse'
+import { ByteListType, ContainerType } from '@chainsafe/ssz'
+import { TERMS_AND_CONDITIONS_URL } from '../constants'
+import { strToUint8Array } from '../utils'
+
+export const hashTermsAndConditions = async (): Promise<string | null> => {
+  try {
+    // read the pdf
+    const response = await fetch(TERMS_AND_CONDITIONS_URL)
+    const pdfBuffarrayBuffer = await response.arrayBuffer()
+    const pdfBuffer = Buffer.from(pdfBuffarrayBuffer)
+    const data = await pdf(pdfBuffer)
+
+    // ssz hash
+    const termsType = new ContainerType({
+      terms_and_conditions_hash: new ByteListType(Number.MAX_SAFE_INTEGER),
+    })
+
+    const termsHasVal = termsType.defaultValue()
+
+    termsHasVal.terms_and_conditions_hash = strToUint8Array(data?.text)
+
+    return (
+      '0x' +
+      Buffer.from(termsType.hashTreeRoot(termsHasVal).buffer).toString('hex')
+    )
+  } catch (err) {
+    return null
+  }
+}

package/src/verification/v1.6.0.ts

@@ -3,7 +3,7 @@ import { strToUint8Array } from '../utils'
 import { type creatorAddressWrapperType, type creatorContainerType, newCreatorContainerType, newOperatorContainerType, type operatorAddressWrapperType, type operatorContainerType, validatorsContainerType } from './sszTypes'
 import { ByteListType, ByteVectorType, ContainerType, ListCompositeType, fromHexString } from '@chainsafe/ssz'
 import { type ValueOfFields } from '@chainsafe/ssz/lib/view/container'
-import { type ClusterDefintion, type ClusterLock, type DepositData } from '../types'
+import { type ClusterDefinition, type ClusterLock, type DepositData } from '../types'
 import { verifyDepositData } from './common'
 import { aggregateSignatures, verifyAggregate, verifyMultiple } from '@chainsafe/bls'
 
@@ -61,7 +61,7 @@ export const clusterDefinitionContainerTypeV1X6 = (
 }
 
 export const hashClusterDefinitionV1X6 = (
-    cluster: ClusterDefintion,
+    cluster: ClusterDefinition,
     configOnly: boolean,
 ): ValueOfFields<DefinitionFieldsV1X6> => {
     const definitionType = clusterDefinitionContainerTypeV1X6(configOnly)

package/src/verification/v1.7.0.ts

@@ -3,7 +3,7 @@ import { strToUint8Array } from '../utils'
 import { builderRegistrationContainer, type creatorAddressWrapperType, type creatorContainerType, depositDataContainer, newCreatorContainerType, newOperatorContainerType, type operatorAddressWrapperType, type operatorContainerType, validatorsContainerType } from './sszTypes'
 import { ByteListType, ByteVectorType, ContainerType, ListCompositeType, fromHexString } from '@chainsafe/ssz'
 import { type ValueOfFields } from '@chainsafe/ssz/lib/view/container'
-import { type ClusterDefintion, type ClusterLock, type DepositData } from '../types'
+import { type ClusterDefinition, type ClusterLock, type DepositData } from '../types'
 import { verifyBuilderRegistration, verifyDepositData, verifyNodeSignatures } from './common'
 import { aggregateSignatures, verifyAggregate, verifyMultiple } from '@chainsafe/bls'
 
@@ -61,7 +61,7 @@ export const clusterDefinitionContainerTypeV1X7 = (
 }
 
 export const hashClusterDefinitionV1X7 = (
-    cluster: ClusterDefintion,
+    cluster: ClusterDefinition,
     configOnly: boolean,
 ): ValueOfFields<DefinitionFieldsV1X7> => {
     const definitionType = clusterDefinitionContainerTypeV1X7(configOnly)

package/src/verification/v1.8.0.ts

@@ -3,7 +3,7 @@ import { strToUint8Array } from '../utils'
 import { builderRegistrationContainer, type creatorAddressWrapperType, type creatorContainerType, depositDataContainer, newCreatorContainerType, newOperatorContainerType, type operatorAddressWrapperType, type operatorContainerType, validatorsContainerType } from './sszTypes'
 import { ByteListType, ByteVectorType, ContainerType, ListBasicType, ListCompositeType, fromHexString } from '@chainsafe/ssz'
 import { type ValueOfFields } from '@chainsafe/ssz/lib/view/container'
-import { type ClusterDefintion, type ClusterLock, type DepositData } from '../types'
+import { type ClusterDefinition, type ClusterLock, type DepositData } from '../types'
 import { verifyBuilderRegistration, verifyDepositData, verifyNodeSignatures } from './common'
 import { aggregateSignatures, verifyAggregate, verifyMultiple } from '@chainsafe/bls'
 
@@ -65,7 +65,7 @@ export const clusterDefinitionContainerTypeV1X8 = (
 }
 
 export const hashClusterDefinitionV1X8 = (
-    cluster: ClusterDefintion,
+    cluster: ClusterDefinition,
     configOnly: boolean,
 ): ValueOfFields<DefinitionFieldsV1X8> => {
     const definitionType = clusterDefinitionContainerTypeV1X8(configOnly)