@ssv-labs/ssv-sdk 0.0.1

package/dist/mock/api.d.ts

@@ -0,0 +1,3 @@
+import { ConfigReturnType } from '../config';
+import { PublicClient } from 'viem';
+export declare const createMockApi: (publicClient: PublicClient) => ConfigReturnType['api'];

package/dist/mock/config.d.ts

@@ -0,0 +1,6 @@
+import { ConfigReturnType, ContractAddresses } from '../config';
+type MockConfigArgs = Pick<ConfigReturnType, 'publicClient' | 'walletClient' | 'chain'> & {
+    addresses: ContractAddresses;
+};
+export declare const createMockConfig: (args: MockConfigArgs) => ConfigReturnType;
+export {};

package/dist/mock/index.d.ts

@@ -0,0 +1,8 @@
+export declare const mockFetchedOperators: {
+    id: string;
+    publicKey: string;
+}[];
+export declare const operators: {
+    keys: string[];
+    ids: string[];
+};

package/dist/sdk.d.ts

@@ -0,0 +1,14 @@
+import { createClusterManager } from './libs/cluster';
+import { createOperatorManager } from './libs/operator';
+import { createUtils } from './libs/utils';
+import { ConfigReturnType } from './config/create';
+import { ConfigArgs } from './utils/zod/config';
+export declare class SSVSDK {
+    readonly config: ConfigReturnType;
+    readonly clusters: ReturnType<typeof createClusterManager>;
+    readonly operators: ReturnType<typeof createOperatorManager>;
+    readonly api: ConfigReturnType['api'];
+    readonly contract: ConfigReturnType['contract'];
+    readonly utils: ReturnType<typeof createUtils>;
+    constructor(props: ConfigArgs | ConfigReturnType);
+}

package/dist/types/contract-interactions.d.ts

@@ -0,0 +1,21 @@
+import { AbiType, AbiTypeToPrimitiveType, ExtractAbiFunction } from 'abitype';
+import { AbiFunction, AbiParameter, AbiParameterToPrimitiveType, DecodeEventLogReturnType } from 'viem';
+import { MainnetV4SetterABI } from '../abi/mainnet/v4/setter';
+import { TokenABI } from '../abi/token';
+export type MainnetEvent = DecodeEventLogReturnType<typeof MainnetV4SetterABI>;
+export type TokenEvent = DecodeEventLogReturnType<typeof TokenABI>;
+export type ValidatorAddedEvent = Extract<MainnetEvent, {
+    eventName: 'ValidatorAdded';
+}>;
+type DepositFN = ExtractAbiFunction<typeof MainnetV4SetterABI, 'deposit'>;
+export type ClusterSnapshot = AbiParameterToPrimitiveType<Extract<DepositFN['inputs'][number], {
+    internalType: 'struct ISSVNetworkCore.Cluster';
+}>>;
+export type AbiInputsToParams<T extends readonly AbiParameter[]> = {
+    [K in T[number] as K['name'] extends string ? K['name'] : never]: AbiParameterToPrimitiveType<K>;
+};
+export declare const paramsToArray: <Fn extends AbiFunction, Params extends Record<string, AbiTypeToPrimitiveType<AbiType>>>({ params, abiFunction, }: {
+    params: Params;
+    abiFunction: Fn;
+}) => (Fn["inputs"] extends infer T_2 extends readonly AbiParameter[] ? { [key_1 in keyof T_2]: AbiParameterToPrimitiveType<Fn["inputs"][key_1], import('abitype').AbiParameterKind>; } : never) extends infer T ? { [key in keyof T]: (Fn["inputs"] extends infer T_1 extends readonly AbiParameter[] ? { [key_1 in keyof T_1]: AbiParameterToPrimitiveType<Fn["inputs"][key_1], import('abitype').AbiParameterKind>; } : never)[key]; } : never;
+export {};

package/dist/types/methods.d.ts

@@ -0,0 +1,3 @@
+import { Prettify } from 'viem';
+export type RemoveConfigArg<T extends (...args: any[]) => any> = (props: Prettify<Omit<Parameters<T>[1], 'config'>>) => ReturnType<T>;
+export type RemoveClientArg<T extends (...args: any[]) => any> = (props: Prettify<Omit<Parameters<T>[1], 'client'>>) => ReturnType<T>;

package/dist/types/operator.d.ts

@@ -0,0 +1,9 @@
+import { Address } from 'abitype';
+export type Operator = {
+    publicKey: string;
+    whitelisted: Address[];
+    id: string;
+    validatorCount: string;
+    isPrivate: boolean;
+    whitelistedContract: Address;
+};

package/dist/types/utils.d.ts

@@ -0,0 +1,3 @@
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/utils/bigint.d.ts

@@ -0,0 +1,29 @@
+export declare const bigintMax: (...args: bigint[]) => bigint;
+export declare const bigintMin: (...args: bigint[]) => bigint;
+export declare const bigintRound: (value: bigint, precision: bigint) => bigint;
+export declare const bigintFloor: (value: bigint, precision?: bigint) => bigint;
+export declare const bigintAbs: (n: bigint) => bigint;
+/**
+ * Checks if the difference between two bigints exceeds a specified tolerance.
+ *
+ * @param {bigint} a - The first bigint value.
+ * @param {bigint} b - The second bigint value.
+ * @param {bigint} [tolerance] - default is `parseUnits("0.0001", 18)`.
+ */
+export declare const isBigIntChanged: (a: bigint, b: bigint, tolerance?: bigint) => boolean;
+export declare const roundOperatorFee: (fee: bigint, precision?: bigint) => bigint;
+type NoBigints<T> = {
+    [K in keyof T]: T[K] extends bigint ? string : T[K] extends bigint ? NoBigints<T[K]> : T[K];
+};
+/**
+ * Converts bigints to strings in an object or array.
+ * @param anything - The object or array to convert.
+ * @returns A new object or array with bigints converted to strings.
+ * @example
+ * stringifyBigints(1n) → "1"
+ * stringifyBigints([1n]) → ["1"]
+ * stringifyBigints({a: 1n, b: { c: 1n }}) → {a: "1", b: {c: "1"}}
+ */
+export declare const stringifyBigints: <T>(anything: T) => NoBigints<T>;
+export declare const bigintifyNumbers: (numbers: readonly number[] | number[]) => bigint[];
+export {};

package/dist/utils/cluster.d.ts

@@ -0,0 +1,8 @@
+import { GetClusterQuery } from '../graphql/graphql';
+import { ClusterSnapshot } from '../types/contract-interactions';
+import { Hex } from 'viem';
+export declare const createClusterId: (ownerAddress: string, operatorIds: number[]) => string;
+export declare const isClusterId: (clusterId: string) => boolean;
+export declare const getClusterSnapshot: (cluster: NonNullable<GetClusterQuery['cluster']>) => ClusterSnapshot;
+export declare const createEmptyCluster: (cluster?: Partial<ClusterSnapshot>) => ClusterSnapshot;
+export declare const add0x: (value: string | Hex) => Hex;

package/dist/utils/contract.d.ts

@@ -0,0 +1,3 @@
+import { ConfigReturnType } from '../config/create';
+import { TransactionReceipt } from 'viem';
+export declare const waitForTransaction: <T extends Promise<`0x${string}`>>(config: ConfigReturnType, fn: T) => Promise<TransactionReceipt>;

package/dist/utils/index.d.ts

@@ -0,0 +1,9 @@
+export * from './bigint';
+export * from './cluster';
+export * from './contract';
+export * from './keyshares';
+export * from './number';
+export * from './operator';
+export * from './try-catch';
+export * from './url-join';
+export * from './zod/config';

package/dist/utils/keyshares.d.ts

@@ -0,0 +1,21 @@
+import { Operator } from '../types/operator';
+import { KeySharesItem } from 'ssv-keys';
+export declare const isKeySharesItem: (item: unknown) => item is KeySharesItem;
+export declare enum KeysharesValidationErrors {
+    OperatorDoesNotExist = 0,
+    OperatorMismatch = 1,
+    ValidatorAlreadyExists = 2,
+    ClusterMismatch = 3,
+    DuplicateValidatorKeys = 4,
+    InconsistentOperatorPublicKeys = 5,
+    InconsistentOperators = 6
+}
+export declare const KeysharesValidationErrorsMessages: Record<KeysharesValidationErrors, string>;
+export declare class KeysharesValidationError extends Error {
+    code: KeysharesValidationErrors;
+    constructor(code: KeysharesValidationErrors);
+}
+export declare const validateConsistentOperatorIds: (keyshares: KeySharesItem[]) => number[];
+export declare const ensureValidatorsUniqueness: (keyshares: KeySharesItem[]) => boolean;
+export declare const validateConsistentOperatorPublicKeys: (keyshares: KeySharesItem[], operators: Pick<Operator, 'id' | 'publicKey'>[]) => true;
+export declare const ensureNoKeysharesErrors: (keyshares: KeySharesItem[]) => boolean;

package/dist/utils/number.d.ts

@@ -0,0 +1,21 @@
+export declare const numberFormatter: Intl.NumberFormat;
+export declare const _percentageFormatter: Intl.NumberFormat;
+export declare const percentageFormatter: {
+    format: (value?: number) => string;
+};
+export declare const bigintFormatter: Intl.NumberFormat;
+export declare const ethFormatter: Intl.NumberFormat;
+export declare const formatSSV: (num: bigint, decimals?: number) => string;
+export declare const formatBigintInput: (num: bigint, decimals?: number) => string;
+declare const units: {
+    readonly seconds: 1000;
+    readonly minutes: 60000;
+    readonly hours: 3600000;
+    readonly days: 86400000;
+    readonly weeks: 604800000;
+    readonly months: 2629746000;
+    readonly years: 31556952000;
+};
+export declare const ms: (value: number, unit: keyof typeof units) => number;
+export declare const sortNumbers: <T extends number | bigint>(numbers: T[]) => T[];
+export {};

package/dist/utils/operator.d.ts

@@ -0,0 +1,5 @@
+import { Address } from 'viem';
+export declare const getOperatorIds: <T extends {
+    id: number;
+}[]>(operators: T) => number[];
+export declare const decodeOperatorPublicKey: (publicKey: Address) => string;

package/dist/utils/try-catch.d.ts

@@ -0,0 +1 @@
+export declare const tryCatch: <T>(fn: () => T) => [T | null, Error | null];

package/dist/utils/url-join.d.ts

@@ -0,0 +1 @@
+export default function urlJoin(...args: string[]): string;

package/dist/utils/zod/config.d.ts

@@ -0,0 +1,9 @@
+import { PublicClient, WalletClient } from 'viem';
+import { z } from 'zod';
+type ZodConfigArgs = {
+    walletClient: z.ZodType<WalletClient>;
+    publicClient: z.ZodType<PublicClient>;
+};
+export declare const configArgsSchema: z.ZodObject<ZodConfigArgs>;
+export type ConfigArgs = z.infer<z.ZodObject<ZodConfigArgs>>;
+export {};

package/dist/utils.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const config = require("./config-DPI30L0i.js");
+const waitForTransaction = async (config2, fn) => {
+  const hash = await fn;
+  return config2.publicClient.waitForTransactionReceipt({ hash });
+};
+exports.KeysharesValidationError = config.KeysharesValidationError;
+exports.KeysharesValidationErrors = config.KeysharesValidationErrors;
+exports.KeysharesValidationErrorsMessages = config.KeysharesValidationErrorsMessages;
+exports._percentageFormatter = config._percentageFormatter;
+exports.add0x = config.add0x;
+exports.bigintAbs = config.bigintAbs;
+exports.bigintFloor = config.bigintFloor;
+exports.bigintFormatter = config.bigintFormatter;
+exports.bigintMax = config.bigintMax;
+exports.bigintMin = config.bigintMin;
+exports.bigintRound = config.bigintRound;
+exports.bigintifyNumbers = config.bigintifyNumbers;
+exports.configArgsSchema = config.configArgsSchema;
+exports.createClusterId = config.createClusterId;
+exports.createEmptyCluster = config.createEmptyCluster;
+exports.decodeOperatorPublicKey = config.decodeOperatorPublicKey;
+exports.ensureNoKeysharesErrors = config.ensureNoKeysharesErrors;
+exports.ensureValidatorsUniqueness = config.ensureValidatorsUniqueness;
+exports.ethFormatter = config.ethFormatter;
+exports.formatBigintInput = config.formatBigintInput;
+exports.formatSSV = config.formatSSV;
+exports.getClusterSnapshot = config.getClusterSnapshot;
+exports.getOperatorIds = config.getOperatorIds;
+exports.isBigIntChanged = config.isBigIntChanged;
+exports.isClusterId = config.isClusterId;
+exports.isKeySharesItem = config.isKeySharesItem;
+exports.ms = config.ms;
+exports.numberFormatter = config.numberFormatter;
+exports.percentageFormatter = config.percentageFormatter;
+exports.roundOperatorFee = config.roundOperatorFee;
+exports.sortNumbers = config.sortNumbers;
+exports.stringifyBigints = config.stringifyBigints;
+exports.tryCatch = config.tryCatch;
+exports.validateConsistentOperatorIds = config.validateConsistentOperatorIds;
+exports.validateConsistentOperatorPublicKeys = config.validateConsistentOperatorPublicKeys;
+exports.waitForTransaction = waitForTransaction;

package/dist/utils.mjs

@@ -0,0 +1,43 @@
+import { K, y, H, _, G, C, B, L, p, z, A, E, k, n, o, d, q, u, N, P, O, l, R, D, F, m, Q, I, J, r, x, s, t, w, v } from "./config-DlwfpwZd.mjs";
+const waitForTransaction = async (config, fn) => {
+  const hash = await fn;
+  return config.publicClient.waitForTransactionReceipt({ hash });
+};
+export {
+  K as KeysharesValidationError,
+  y as KeysharesValidationErrors,
+  H as KeysharesValidationErrorsMessages,
+  _ as _percentageFormatter,
+  G as add0x,
+  C as bigintAbs,
+  B as bigintFloor,
+  L as bigintFormatter,
+  p as bigintMax,
+  z as bigintMin,
+  A as bigintRound,
+  E as bigintifyNumbers,
+  k as configArgsSchema,
+  n as createClusterId,
+  o as createEmptyCluster,
+  d as decodeOperatorPublicKey,
+  q as ensureNoKeysharesErrors,
+  u as ensureValidatorsUniqueness,
+  N as ethFormatter,
+  P as formatBigintInput,
+  O as formatSSV,
+  l as getClusterSnapshot,
+  R as getOperatorIds,
+  D as isBigIntChanged,
+  F as isClusterId,
+  m as isKeySharesItem,
+  Q as ms,
+  I as numberFormatter,
+  J as percentageFormatter,
+  r as roundOperatorFee,
+  x as sortNumbers,
+  s as stringifyBigints,
+  t as tryCatch,
+  w as validateConsistentOperatorIds,
+  v as validateConsistentOperatorPublicKeys,
+  waitForTransaction
+};

package/package.json

@@ -0,0 +1,136 @@
+{
+  "name": "@ssv-labs/ssv-sdk",
+  "version": "0.0.1",
+  "author": "SSV.Labs",
+  "description": "ssv labs sdk",
+  "keywords": [
+    "ssv",
+    "sdk"
+  ],
+  "repository": "https://github.com/ssvlabs/ssv-sdk",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/main.js",
+  "module": "./dist/main.js",
+  "types": "./dist/main.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/main.js",
+      "require": "./dist/main.cjs",
+      "types": "./dist/main.d.ts"
+    },
+    "./utils": {
+      "import": "./dist/utils.js",
+      "require": "./dist/utils.cjs",
+      "types": "./dist/utils/index.d.ts"
+    }
+  },
+  "scripts": {
+    "lint": "eslint . --ext .ts --fix",
+    "watch": "rollup -w -c rollup.config.ts --configPlugin typescript --environment BUILD:development",
+    "build": "vite build",
+    "codegen": "graphql-codegen",
+    "test": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "v-pub-tarball": "npm publish --dry-run",
+    "type-check": "tsc -b",
+    "type:perf": "tsc --extendedDiagnostics",
+    "release": "release-it",
+    "commit": "git-cz",
+    "lint-staged": "pnpm run type-check && pnpm vitest run && lint-staged",
+    "prepare": "husky && pnpm run build"
+  },
+  "lint-staged": {
+    "src/**/*.{ts,tsx,js,json}": [
+      "prettier --write --log-level silent",
+      "eslint --fix",
+      "git add"
+    ]
+  },
+  "devDependencies": {
+    "@0no-co/graphqlsp": "^1.12.16",
+    "@commitlint/cli": "^19.2.2",
+    "@commitlint/config-conventional": "^19.2.2",
+    "@graphql-codegen/cli": "^5.0.3",
+    "@graphql-codegen/schema-ast": "^4.1.0",
+    "@graphql-codegen/typed-document-node": "^5.0.10",
+    "@graphql-codegen/typescript": "^4.1.0",
+    "@graphql-codegen/typescript-graphql-request": "^6.2.0",
+    "@graphql-codegen/typescript-operations": "^4.3.0",
+    "@nomicfoundation/hardhat-toolbox": "^5.0.0",
+    "@nomicfoundation/hardhat-viem": "^2.0.6",
+    "@openzeppelin/contracts": "^4.9.6",
+    "@openzeppelin/contracts-upgradeable": "^4.9.6",
+    "@openzeppelin/hardhat-upgrades": "^3.0.5",
+    "@parcel/watcher": "^2.4.1",
+    "@release-it/conventional-changelog": "^8.0.1",
+    "@rollup/plugin-alias": "^5.1.1",
+    "@rollup/plugin-commonjs": "^28.0.1",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@rollup/rollup-darwin-x64": "^4.30.1",
+    "@types/eslint-plugin-prettier": "^3.1.3",
+    "@types/lodash-es": "^4.17.12",
+    "@types/node": "^20.12.7",
+    "@typescript-eslint/eslint-plugin": "^7.7.0",
+    "@typescript-eslint/parser": "^7.7.0",
+    "@vitest/coverage-v8": "^1.5.0",
+    "@vitest/ui": "^1.5.0",
+    "commitizen": "^4.3.0",
+    "concurrently": "^9.0.1",
+    "cz-git": "^1.9.1",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "hardhat": "^2.22.17",
+    "husky": "^9.0.11",
+    "lint-staged": "^15.2.2",
+    "prettier": "^3.2.5",
+    "release-it": "^17.2.0",
+    "rollup": "^4.14.3",
+    "rollup-plugin-delete": "^2.0.0",
+    "rollup-plugin-dts": "^6.1.1",
+    "rollup-plugin-tsconfig-paths": "^1.5.2",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "semantic-release": "^23.0.8",
+    "typescript": "^5.4.5",
+    "vite": "^5.4.10",
+    "vite-plugin-dts": "^4.3.0",
+    "vite-plugin-glob": "^0.3.2",
+    "vite-plugin-node-polyfills": "^0.22.0",
+    "vitest": "^1.5.0"
+  },
+  "config": {
+    "commitizen": {
+      "path": "node_modules/cz-git"
+    }
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@chainsafe/bls": "^8.1.0",
+    "@chainsafe/bls-keygen": "^0.4.0",
+    "@chainsafe/bls-keystore": "^3.1.0",
+    "@chainsafe/blst": "^2.2.0",
+    "@chainsafe/ssz": "^0.18.0",
+    "@graphql-typed-document-node/core": "^3.2.0",
+    "@lodestar/config": "^1.22.0",
+    "@lodestar/params": "^1.22.0",
+    "@lodestar/state-transition": "^1.22.0",
+    "@lodestar/types": "^1.22.0",
+    "@safe-global/protocol-kit": "^5.0.3",
+    "abitype": "^1.0.6",
+    "dotenv": "^16.4.5",
+    "graphql-request": "^7.1.0",
+    "lodash-es": "^4.17.21",
+    "ssv-keys": "^1.2.1",
+    "viem": "^2.21.30",
+    "zod": "^3.23.8"
+  },
+  "license": "SEE LICENSE IN LICENCE FILE"
+}