@obolnetwork/obol-sdk 1.0.1

package/README.md

@@ -0,0 +1,10 @@
+![Obol Logo](https://obol.tech/obolnetwork.png)
+
+<h1 align="center">Obol SDK</h1>
+
+This repo contains the Obol Software Development Kit, for creating Distributed Validators with the help of the[Obol API](https://docs.obol.tech/api). 
+
+## Getting Started
+
+Checkout our [docs](https://docs.obol.tech/docs/int/quickstart/alone).
+

package/dist/ajv.d.ts

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

package/dist/ajv.d.ts.map

@@ -0,0 +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"}

package/dist/base.d.ts

@@ -0,0 +1,13 @@
+declare type Config = {
+    baseUrl?: string;
+    chainId?: number;
+};
+export declare abstract class Base {
+    baseUrl: string;
+    chainId: number;
+    fork_version: string;
+    constructor({ baseUrl, chainId }: Config);
+    protected request<T>(endpoint: string, options?: RequestInit): Promise<T>;
+}
+export {};
+//# sourceMappingURL=base.d.ts.map

package/dist/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAKA,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,OAA8C,EAAE,OAAW,EAAE,EAAE,MAAM;cASnE,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC;CAqBhF"}

package/dist/cluster.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=cluster.test.d.ts.map

package/dist/cluster.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cluster.test.d.ts","sourceRoot":"","sources":["../src/cluster.test.ts"],"names":[],"mappings":""}

package/dist/constants.d.ts

@@ -0,0 +1,23 @@
+export declare const CONFLICT_ERROR_MSG = "Conflict";
+export declare const CreatorConfigHashSigningTypes: {
+    CreatorConfigHash: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const Domain: {
+    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.5.0";
+export declare const SDK_VERSION = "1.0.0";
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +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"}

package/dist/errors.d.ts

@@ -0,0 +1,5 @@
+export declare class ConflictError extends Error {
+    name: string;
+    constructor();
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,aAAc,SAAQ,KAAK;IACpC,IAAI,SAAkB;;CAQvB"}

package/dist/fixtures.d.ts

@@ -0,0 +1,45 @@
+export declare const clusterLockV1X5: {
+    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[];
+    }[];
+    signature_aggregate: string;
+    lock_hash: string;
+};
+export declare const clusterConfig: {
+    name: string;
+    operators: {
+        address: string;
+    }[];
+    validators: {
+        fee_recipient_address: string;
+        withdrawal_address: string;
+    }[];
+};
+//# sourceMappingURL=fixtures.d.ts.map

package/dist/fixtures.d.ts.map

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

package/dist/hash.d.ts

@@ -0,0 +1,64 @@
+import { ContainerType, ByteVectorType, UintNumberType, ListCompositeType, ByteListType } from '@chainsafe/ssz';
+import { ValueOfFields } from '@chainsafe/ssz/lib/view/container';
+import { ClusterDefintion } from './types';
+/**
+ * Returns the SSZ cluster config hash or the definition hash of the given cluster definition object
+ * @param cluster The cluster whose config hash or definition hash needs to be calculated
+ * @param configOnly A flag that indicates which hash to evaluate
+ * @returns The config hash or he definition hash in of the corresponding cluster definition
+ */
+export declare const clusterConfigOrDefinitionHash: (cluster: ClusterDefintion, configOnly: boolean) => string;
+export declare const hashClusterDefinitionV1X5: (cluster: any, configOnly: boolean) => ValueOfFields<DefinitionFieldsV1X5>;
+/**
+ * Converts a string to a Uint8Array
+ * @param str The string to convert
+ * @returns The converted Uint8Array
+ */
+export declare const strToUint8Array: (str: string) => Uint8Array;
+/**
+ * operatorContainerType is an SSZ Composite Container type for Operator.
+ * Note that the type has fixed size for address as it is an ETH1 address (20 bytes).
+ */
+declare const operatorAddressWrapperType: ContainerType<{
+    address: ByteVectorType;
+}>;
+declare const creatorAddressWrapperType: ContainerType<{
+    address: ByteVectorType;
+}>;
+export declare const operatorContainerType: ContainerType<{
+    address: ByteVectorType;
+    enr: ByteListType;
+    config_signature: ByteVectorType;
+    enr_signature: ByteVectorType;
+}>;
+export declare const creatorContainerType: ContainerType<{
+    address: ByteVectorType;
+    config_signature: ByteVectorType;
+}>;
+export declare const validatorsContainerType: ContainerType<{
+    fee_recipient_address: ByteVectorType;
+    withdrawal_address: ByteVectorType;
+}>;
+declare type DefinitionFieldsV1X5 = {
+    uuid: ByteListType;
+    name: ByteListType;
+    version: ByteListType;
+    timestamp: ByteListType;
+    num_validators: UintNumberType;
+    threshold: UintNumberType;
+    dkg_algorithm: ByteListType;
+    fork_version: ByteVectorType;
+    operators: ListCompositeType<typeof operatorContainerType | typeof operatorAddressWrapperType>;
+    creator: typeof creatorContainerType | typeof creatorAddressWrapperType;
+    validators: ListCompositeType<typeof validatorsContainerType>;
+    config_hash?: ByteVectorType;
+};
+export declare type DefinitionContainerTypeV1X5 = ContainerType<DefinitionFieldsV1X5>;
+/**
+ * Returns the containerized cluster definition
+ * @param cluster ClusterDefinition to calculate the type from
+ * @returns SSZ Containerized type of cluster input
+ */
+export declare const clusterDefinitionContainerTypeV1X5: (configOnly: boolean) => DefinitionContainerTypeV1X5;
+export {};
+//# sourceMappingURL=hash.d.ts.map

package/dist/hash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash.d.ts","sourceRoot":"","sources":["../src/hash.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,cAAc,EACd,cAAc,EACd,iBAAiB,EACjB,YAAY,EAEb,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,YAC/B,gBAAgB,cACb,OAAO,KAClB,MAOF,CAAC;AAEF,eAAO,MAAM,yBAAyB,YAC3B,GAAG,cACA,OAAO,KAClB,cAAc,oBAAoB,CAyCpC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAS,MAAM,KAAG,UAE7C,CAAC;AAEF;;;GAGG;AACH,QAAA,MAAM,0BAA0B;;EAE9B,CAAC;AAEH,QAAA,MAAM,yBAAyB;;EAE7B,CAAC;AAEH,eAAO,MAAM,qBAAqB;;;;;EAKhC,CAAC;AAEH,eAAO,MAAM,oBAAoB;;;EAG/B,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;EAGlC,CAAC;AAUH,aAAK,oBAAoB,GAAG;IAC1B,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,YAAY,CAAC;IACtB,SAAS,EAAE,YAAY,CAAC;IACxB,cAAc,EAAE,cAAc,CAAC;IAC/B,SAAS,EAAE,cAAc,CAAC;IAC1B,aAAa,EAAE,YAAY,CAAC;IAC5B,YAAY,EAAE,cAAc,CAAC;IAC7B,SAAS,EAAE,iBAAiB,CAC1B,OAAO,qBAAqB,GAAG,OAAO,0BAA0B,CACjE,CAAC;IACF,OAAO,EAAE,OAAO,oBAAoB,GAAG,OAAO,yBAAyB,CAAC;IACxE,UAAU,EAAE,iBAAiB,CAAC,OAAO,uBAAuB,CAAC,CAAC;IAC9D,WAAW,CAAC,EAAE,cAAc,CAAC;CAC9B,CAAC;AAEF,oBAAY,2BAA2B,GACrC,aAAa,CAAC,oBAAoB,CAAC,CAAC;AAEtC;;;;GAIG;AACH,eAAO,MAAM,kCAAkC,eACjC,OAAO,gCAwBpB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import { ethers } from 'ethers';
+import { Base } from './base';
+import { ClusterPayload } from './types';
+export declare class Client extends Base {
+    private signer;
+    constructor(config: {
+        baseUrl?: string | undefined;
+        chainId?: number | undefined;
+    }, signer: ethers.Wallet);
+    /**
+     * @param cluster The new unique cluster
+     * @returns Invite Link with config_hash
+    */
+    createClusterDefinition(newCluster: ClusterPayload): Promise<string>;
+    /**
+     * @param configHash The config hash of the requested cluster
+     * @returns The matched cluster details (lock) from DB
+    */
+    getClusterLock(configHash: string): Promise<any>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +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,EAAiC,cAAc,EAAE,MAAM,SAAS,CAAC;AAKxE,qBAAa,MAAO,SAAQ,IAAI;IAC9B,OAAO,CAAC,MAAM,CAAgB;gBAElB,MAAM,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM;IAMzG;;;MAGE;IACI,uBAAuB,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAyC1E;;;MAGE;IACI,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAQvD"}