@obolnetwork/obol-sdk 2.12.1 → 2.12.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -4
- package/dist/browser/src/index.js +77 -52
- package/dist/browser/src/index.js.map +1 -1
- package/dist/cjs/src/index.js +79 -52
- package/dist/cjs/src/index.js.map +1 -1
- package/dist/cjs/src/verification/clusterLockValidationWorker.js +2 -4
- package/dist/cjs/src/verification/clusterLockValidationWorker.js.map +1 -1
- package/dist/cjs/src/verification/parallelPool.js +8 -9
- package/dist/cjs/src/verification/parallelPool.js.map +1 -1
- package/dist/esm/src/{chunk-5ASVONSJ.js → chunk-T74RX3N2.js} +4 -6
- package/dist/esm/src/chunk-T74RX3N2.js.map +1 -0
- package/dist/esm/src/{chunk-RYTIXFRX.js → chunk-YSXFCSVK.js} +17 -10
- package/dist/esm/src/{chunk-RYTIXFRX.js.map → chunk-YSXFCSVK.js.map} +1 -1
- package/dist/esm/src/index.js +25 -3
- package/dist/esm/src/index.js.map +1 -1
- package/dist/esm/src/verification/clusterLockValidationWorker.js +2 -2
- package/dist/esm/src/verification/parallelPool.js +1 -1
- package/dist/types/src/base.d.ts +5 -3
- package/dist/types/src/errors.d.ts +8 -0
- package/dist/types/src/index.d.ts +5 -6
- package/dist/types/test/client/baseUrl.spec.d.ts +1 -0
- package/dist/types/tsconfig.types.tsbuildinfo +1 -1
- package/package.json +2 -2
- package/dist/esm/src/chunk-5ASVONSJ.js.map +0 -1
package/dist/types/src/base.d.ts
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import { FORK_MAPPING } from './types.js';
|
|
2
|
-
|
|
2
|
+
/** Official Obol API base URLs (no path suffix — `/v1` is added per request). */
|
|
3
|
+
export declare const ALLOWED_OBOL_API_BASE_URLS: readonly ["https://api.obol.tech", "https://obol-api-nonprod-dev.dev.obol.tech", "https://obol-api-nonprod-qa.dev.obol.tech"];
|
|
4
|
+
export type AllowedObolApiBaseUrl = (typeof ALLOWED_OBOL_API_BASE_URLS)[number];
|
|
5
|
+
export interface BaseConfig {
|
|
3
6
|
baseUrl?: string;
|
|
4
7
|
chainId?: FORK_MAPPING;
|
|
5
8
|
}
|
|
@@ -7,7 +10,6 @@ export declare abstract class Base {
|
|
|
7
10
|
baseUrl: string;
|
|
8
11
|
chainId: number;
|
|
9
12
|
fork_version: string;
|
|
10
|
-
constructor({ baseUrl, chainId, }:
|
|
13
|
+
constructor({ baseUrl, chainId, }: BaseConfig);
|
|
11
14
|
protected request<T>(endpoint: string, options?: RequestInit): Promise<T>;
|
|
12
15
|
}
|
|
13
|
-
export {};
|
|
@@ -30,6 +30,14 @@ export declare class UnsupportedChainError extends Error {
|
|
|
30
30
|
* the worker time limit (large clusters). HTTP gateways should respond with
|
|
31
31
|
* **504**; this is distinct from cryptographic failure (**false** → **400**).
|
|
32
32
|
*/
|
|
33
|
+
/**
|
|
34
|
+
* Thrown when {@link Client} is constructed with a baseUrl that is not an
|
|
35
|
+
* an allowed Obol API base URL (see {@link ALLOWED_OBOL_API_BASE_URLS}).
|
|
36
|
+
*/
|
|
37
|
+
export declare class InvalidBaseUrlError extends Error {
|
|
38
|
+
name: string;
|
|
39
|
+
constructor(message: string);
|
|
40
|
+
}
|
|
33
41
|
export declare class ClusterLockValidationTimeoutError extends Error {
|
|
34
42
|
readonly timeoutMs: number;
|
|
35
43
|
name: string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Base } from './base.js';
|
|
1
|
+
import { Base, type BaseConfig } from './base.js';
|
|
2
2
|
import { type RewardsSplitPayload, type ClusterDefinition, type ClusterLock, type ClusterPayload, type OperatorPayload, type TotalSplitPayload, type ClusterValidator, type ETH_ADDRESS, type OWRTranches, type ProviderType, type SignerType } from './types.js';
|
|
3
3
|
import { Incentives } from './incentives/incentives.js';
|
|
4
4
|
import { Exit } from './exits/exit.js';
|
|
@@ -9,7 +9,8 @@ export * from './services.js';
|
|
|
9
9
|
export * from './verification/signature-validator.js';
|
|
10
10
|
export * from './verification/common.js';
|
|
11
11
|
export * from './constants.js';
|
|
12
|
-
export { ConflictError, ClusterLockValidationTimeoutError, SignerRequiredError, UnsupportedChainError, } from './errors.js';
|
|
12
|
+
export { ConflictError, ClusterLockValidationTimeoutError, InvalidBaseUrlError, SignerRequiredError, UnsupportedChainError, } from './errors.js';
|
|
13
|
+
export { ALLOWED_OBOL_API_BASE_URLS } from './base.js';
|
|
13
14
|
export { Incentives } from './incentives/incentives.js';
|
|
14
15
|
export { Exit } from './exits/exit.js';
|
|
15
16
|
export { ObolSplits } from './splits/splits.js';
|
|
@@ -104,6 +105,7 @@ export declare class Client extends Base {
|
|
|
104
105
|
*
|
|
105
106
|
* @param config - Client configuration object.
|
|
106
107
|
* @param config.baseUrl - Obol API base URL. Defaults to `https://api.obol.tech`.
|
|
108
|
+
* Must match one of {@link ALLOWED_OBOL_API_BASE_URLS} (API paths use `/v1/...` separately).
|
|
107
109
|
* @param config.chainId - Target chain ID. Defaults to `560048` (Hoodi).
|
|
108
110
|
* Supported: 1 (Mainnet), 560048 (Hoodi), 100 (Gnosis), 11155111 (Sepolia).
|
|
109
111
|
* @param signer - An ethers `Wallet` or `JsonRpcSigner`. Required for any
|
|
@@ -121,10 +123,7 @@ export declare class Client extends Base {
|
|
|
121
123
|
* const client = new Client({ chainId: 560048 }, signer);
|
|
122
124
|
* ```
|
|
123
125
|
*/
|
|
124
|
-
constructor(config:
|
|
125
|
-
baseUrl?: string;
|
|
126
|
-
chainId?: number;
|
|
127
|
-
}, signer?: SignerType, provider?: ProviderType);
|
|
126
|
+
constructor(config: BaseConfig, signer?: SignerType, provider?: ProviderType);
|
|
128
127
|
/**
|
|
129
128
|
* Accepts the latest Obol terms and conditions.
|
|
130
129
|
*
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"root":["../../tsup.config.ts","../../src/ajv.ts","../../src/base.ts","../../src/blsUtils.ts","../../src/bytecodes.ts","../../src/constants.ts","../../src/errors.ts","../../src/index.ts","../../src/schema.ts","../../src/services.ts","../../src/types.ts","../../src/utils.ts","../../src/abi/BatchDeposit.ts","../../src/abi/MerkleDistributorWithDeadline.ts","../../src/abi/Multicall3.ts","../../src/abi/OVM.ts","../../src/abi/OWR.ts","../../src/abi/SplitMain.ts","../../src/abi/splitV2FactoryAbi.ts","../../src/eoa/eoa.ts","../../src/eoa/eoaHelpers.ts","../../src/exits/ethUtils.ts","../../src/exits/exit.ts","../../src/exits/verificationHelpers.ts","../../src/incentives/incentiveHelpers.ts","../../src/incentives/incentives.ts","../../src/splits/splitHelpers.ts","../../src/splits/splits.ts","../../src/verification/clusterLockValidationWorker.ts","../../src/verification/common.ts","../../src/verification/lockWorker.ts","../../src/verification/parallelPool.ts","../../src/verification/signature-validator.ts","../../src/verification/sszTypes.ts","../../src/verification/v1.10.0.ts","../../src/verification/v1.6.0.ts","../../src/verification/v1.7.0.ts","../../src/verification/v1.8.0.ts","../../test/fixtures.ts","../../test/client/ajv.spec.ts","../../test/client/methods.spec.ts","../../test/eoa/eoa.spec.ts","../../test/exit/ethUtils.spec.ts","../../test/exit/exit.spec.ts","../../test/exit/verificationHelpers.spec.ts","../../test/incentives/incentives.spec.ts","../../test/splits/splits.spec.ts","../../test/verification/parallelPool.spec.ts"],"version":"5.9.3"}
|
|
1
|
+
{"root":["../../tsup.config.ts","../../src/ajv.ts","../../src/base.ts","../../src/blsUtils.ts","../../src/bytecodes.ts","../../src/constants.ts","../../src/errors.ts","../../src/index.ts","../../src/schema.ts","../../src/services.ts","../../src/types.ts","../../src/utils.ts","../../src/abi/BatchDeposit.ts","../../src/abi/MerkleDistributorWithDeadline.ts","../../src/abi/Multicall3.ts","../../src/abi/OVM.ts","../../src/abi/OWR.ts","../../src/abi/SplitMain.ts","../../src/abi/splitV2FactoryAbi.ts","../../src/eoa/eoa.ts","../../src/eoa/eoaHelpers.ts","../../src/exits/ethUtils.ts","../../src/exits/exit.ts","../../src/exits/verificationHelpers.ts","../../src/incentives/incentiveHelpers.ts","../../src/incentives/incentives.ts","../../src/splits/splitHelpers.ts","../../src/splits/splits.ts","../../src/verification/clusterLockValidationWorker.ts","../../src/verification/common.ts","../../src/verification/lockWorker.ts","../../src/verification/parallelPool.ts","../../src/verification/signature-validator.ts","../../src/verification/sszTypes.ts","../../src/verification/v1.10.0.ts","../../src/verification/v1.6.0.ts","../../src/verification/v1.7.0.ts","../../src/verification/v1.8.0.ts","../../test/fixtures.ts","../../test/client/ajv.spec.ts","../../test/client/baseUrl.spec.ts","../../test/client/methods.spec.ts","../../test/eoa/eoa.spec.ts","../../test/exit/ethUtils.spec.ts","../../test/exit/exit.spec.ts","../../test/exit/verificationHelpers.spec.ts","../../test/incentives/incentives.spec.ts","../../test/splits/splits.spec.ts","../../test/verification/parallelPool.spec.ts"],"version":"5.9.3"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@obolnetwork/obol-sdk",
|
|
3
|
-
"version": "2.12.
|
|
3
|
+
"version": "2.12.2",
|
|
4
4
|
"description": "A package for creating Distributed Validators using the Obol API.",
|
|
5
5
|
"bugs": {
|
|
6
6
|
"url": "https://github.com/obolnetwork/obol-sdk/issues"
|
|
@@ -78,7 +78,6 @@
|
|
|
78
78
|
"ajv-formats": "3.0.1",
|
|
79
79
|
"ajv-keywords": "5.1.0",
|
|
80
80
|
"cross-fetch": "4.1.0",
|
|
81
|
-
"dotenv": "17.4.2",
|
|
82
81
|
"elliptic": "6.6.1",
|
|
83
82
|
"ethers": "6.16.0",
|
|
84
83
|
"semver": "7.7.4",
|
|
@@ -91,6 +90,7 @@
|
|
|
91
90
|
"@types/node": "24.12.2",
|
|
92
91
|
"@types/semver": "7.7.1",
|
|
93
92
|
"@types/uuid": "9.0.8",
|
|
93
|
+
"dotenv": "17.4.2",
|
|
94
94
|
"@typescript-eslint/eslint-plugin": "6.21.0",
|
|
95
95
|
"@typescript-eslint/parser": "6.21.0",
|
|
96
96
|
"eslint": "8.57.1",
|