diff --git a/README.md b/README.md index 1a1c07d..37ef38f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,40 @@ ![Obol Logo](https://obol.tech/obolnetwork.png) -

Obol SDK

-This repo contains the Obol Software Development Kit, for creating Distributed Validators with the help of the [Obol API](https://docs.obol.tech/api). +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/advanced/quickstart-sdk), [examples](https://github.com/ObolNetwork/obol-sdk-examples/), and SDK [reference](https://obolnetwork.github.io/obol-sdk). Further guides and walkthroughs coming soon. +Checkout our [docs](https://docs.obol.tech/docs/advanced/quickstart-sdk), [examples](https://github.com/ObolNetwork/obol-sdk-examples/), and SDK [reference](https://obolnetwork.github.io/obol-sdk). Further guides and walkthroughs coming soon. + +## Contributing + +Please review the following guidelines: + +- [How to Report Bugs](#how-to-report-bugs) +- [How to Propose Changes](#how-to-propose-changes) +- [Code Review Process](#code-review-process) + +### How to Report Bugs + +If you encounter a bug or unexpected behavior, please follow these steps to report it: + +1. Go to the "Issues" tab of this repository. +2. Click on the "Get started" button in the Bug report section. +3. Provide a clear title and description of the issue following the format provided. + +### How to Propose Changes + +If you'd like to propose improvements or new features, please follow these steps: + +1. Fork this repository. +2. Create a new branch for your changes. +3. Make your changes and commit them with clear messages. +4. Open a pull request with a detailed description of the changes. + +### Code Review Process + +All contributions are reviewed before they are merged into the main branch. Please address any feedback provided during the review process. + +Thank you for contributing to Obol-SDK! diff --git a/package.json b/package.json index 60e6243..ff39aa7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@obolnetwork/obol-sdk", - "version": "1.0.13", + "version": "1.0.12", "description": "A package for creating Distributed Validators using the Obol API.", "bugs": { "url": "https://github.com/obolnetwork/obol-sdk/issues" diff --git a/src/constants.ts b/src/constants.ts index 0a8d0f8..3834b0a 100644 --- a/src/constants.ts +++ b/src/constants.ts @@ -115,6 +115,6 @@ export enum DefinitionFlow { } export const DEFAULT_BASE_URL = 'https://api.obol.tech' -export const DEFAULT_CHAIN_ID = 1 +export const DEFAULT_CHAIN_ID = 17000 export const ETHER_TO_GWEI = 10 ** 9 diff --git a/test/methods.test.ts b/test/methods.test.ts index 91b4a65..f901a25 100644 --- a/test/methods.test.ts +++ b/test/methods.test.ts @@ -21,13 +21,13 @@ describe('Cluster Client', () => { mockSigner, ) - test('throws invalid ChainId when it is equal to 1', async () => { - try { - new Client({ chainId: 1 }, mockSigner) - } catch (error: any) { - expect(error.message).toBe('Invalid ChainId') - } - }) + // test('throws invalid ChainId when it is equal to 1', async () => { + // try { + // new Client({ chainId: 1 }, mockSigner) + // } catch (error: any) { + // expect(error.message).toBe('Obol-SDK is in Beta phase, mainnet is not yet supported') + // } + // }) test('createClusterDefinition should return config_hash', async () => { clientInstance['request'] = jest diff --git a/test/sdk-package-test/yarn.lock b/test/sdk-package-test/yarn.lock index 5975631..35415a4 100644 --- a/test/sdk-package-test/yarn.lock +++ b/test/sdk-package-test/yarn.lock @@ -783,7 +783,7 @@ rimraf "^3.0.2" "@obolnetwork/obol-sdk@file:../..": - version "1.0.13" + version "1.0.12" dependencies: "@chainsafe/bls" "6.0.3" "@chainsafe/blst" "^0.2.9"