Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Staking sdk #216

Merged
merged 14 commits into from
Nov 1, 2023
Merged

Staking sdk #216

merged 14 commits into from
Nov 1, 2023

Conversation

chenshoo
Copy link
Collaborator

Pull Request Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes (link to the issue here)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Chore / Documentation
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Locally tested against Fireblocks API

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • Any dependent changes have been merged and published in downstream modules
  • I have added corresponding labels to the PR

@chenshoo chenshoo requested a review from orgranit October 26, 2023 08:26
YoavBZ
YoavBZ previously requested changes Oct 29, 2023
Copy link
Collaborator

@YoavBZ YoavBZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After discussing this internally - new methods should be added to the FireblocksSDK class and not in a new one. We should keep the current approach of not introducing new namespaces (NCW is exceptional).
Please align this accordingly

@orgranit
Copy link

After discussing this internally - new methods should be added to the FireblocksSDK class and not in a new one. We should keep the current approach of not introducing new namespaces (NCW is exceptional). Please align this accordingly

@YoavBZ
Can you share the reasoning behind it?
fireblocks-sdk.ts is already 2000 lines long, and nameSpaces help us prevent name collisions.
For example I prefer to keep our methods name simple as sdk.staking.getChains or sdk.staking.approveProviderTermsOfService if we would be force to flatten all under the general sdk, it would have to be called sdk.getStakingChains or sdk.approveStakingProviderTermsOfService.

@aviba
Copy link
Contributor

aviba commented Oct 30, 2023

@YoavBZ We are trying to be similar as possible to they way the auto generated SDK will create our API (from we understand it will be under a separate namespace). As this is a new API and we want to make sure the migration from this SDK to new one will be streamlined as much as possible for clients.

src/fireblocks-sdk.ts Outdated Show resolved Hide resolved
src/fireblocks-sdk.ts Outdated Show resolved Hide resolved
@aviba aviba dismissed YoavBZ’s stale review November 1, 2023 13:01

issue was addressed

@aviba aviba merged commit 6d494d9 into master Nov 1, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants