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.

Sign up for GitHub

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

Jump to bottom

GridClient types and docstrings #3024

Merged
merged 45 commits into from
Aug 7, 2024
Merged

GridClient types and docstrings #3024

merged 45 commits into from
Aug 7, 2024

Conversation

Mahmoud-Emad
Copy link
Contributor

@Mahmoud-Emad Mahmoud-Emad commented Jun 25, 2024 •
edited
Loading

Description

Since we have open-sourced clients, all of them must be well-documented and well-typed.

Changes

Related Issues

Screenshots

image
image
image
image

Checklist

  • Tests included
  • Build pass
  • Documentation
  • Code format and docstrings
  • Screenshots/Video attached (needed for UI changes)

@Mahmoud-Emad Mahmoud-Emad marked this pull request as draft June 25, 2024 09:48
@Mahmoud-Emad Mahmoud-Emad force-pushed the development_2.6_gridclient_types branch from 8b34478 to 3e98ca0 Compare June 26, 2024 09:58
@Mahmoud-Emad Mahmoud-Emad force-pushed the development_2.6_gridclient_types branch from eb969a4 to c714dd3 Compare June 26, 2024 14:05
@Mahmoud-Emad
Copy link
Contributor Author

Mahmoud-Emad commented Jun 26, 2024 •
edited
Loading

PS: We should use Squash Merge when merging this PR to compare all of the PR commits.

@Mahmoud-Emad Mahmoud-Emad changed the title GridClient types GridClient types and docstrings Jun 27, 2024
@Mahmoud-Emad Mahmoud-Emad force-pushed the development_2.6_gridclient_types branch from 897b294 to 4425500 Compare June 27, 2024 09:14
@amiraabouhadid
Copy link
Contributor

please resolve merge conficts

@Mahmoud-Emad
Copy link
Contributor Author

please resolve merge conficts

Fixed

@Mahmoud-Emad
Copy link
Contributor Author

@ALL
Please don't merge this PR since @AhmedHanafy725 still reviewing it

zaelgohary
zaelgohary reviewed Jul 29, 2024
View reviewed changes
Copy link
Contributor

@zaelgohary zaelgohary left a comment

Choose a reason for hiding this comment

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

Not all scripts are edited with the types. Maybe we can open an issue to edit them in another PR as this PR is big enough?

AhmedHanafy725
AhmedHanafy725 requested changes Jul 29, 2024
View reviewed changes
packages/grid_client/scripts/client_loader.ts Outdated Show resolved Hide resolved
packages/grid_client/src/client.ts Outdated Show resolved Hide resolved
packages/grid_client/src/clients/tf-grid/balances.ts Outdated Show resolved Hide resolved
packages/grid_client/src/clients/tf-grid/balances.ts Outdated Show resolved Hide resolved
packages/grid_client/src/clients/tf-grid/balances.ts Outdated Show resolved Hide resolved
packages/grid_client/src/modules/stellar.ts Outdated Show resolved Hide resolved
packages/grid_client/src/modules/tfchain.ts Outdated Show resolved Hide resolved
packages/grid_client/src/modules/tfchain.ts Outdated Show resolved Hide resolved
packages/grid_client/src/modules/tfchain.ts Outdated Show resolved Hide resolved
packages/grid_client/src/modules/tfchain.ts Outdated Show resolved Hide resolved
@Mahmoud-Emad Mahmoud-Emad marked this pull request as draft July 30, 2024 06:21
@Mahmoud-Emad Mahmoud-Emad marked this pull request as ready for review August 5, 2024 07:41
AhmedHanafy725
AhmedHanafy725 reviewed Aug 6, 2024
View reviewed changes
packages/grid_client/scripts/config.json Outdated Show resolved Hide resolved
packages/grid_client/scripts/test.ts Outdated Show resolved Hide resolved
packages/tfchain_client/src/kvstore.ts Outdated Show resolved Hide resolved
packages/grid_client/src/modules/base.ts Outdated Show resolved Hide resolved
packages/grid_client/src/modules/stellar.ts Outdated Show resolved Hide resolved
@Mahmoud-Emad Mahmoud-Emad force-pushed the development_2.6_gridclient_types branch 2 times, most recently from 51aeca9 to bd898c1 Compare August 7, 2024 10:43
@Mahmoud-Emad Mahmoud-Emad force-pushed the development_2.6_gridclient_types branch from bd898c1 to d092db0 Compare August 7, 2024 11:08
@Mahmoud-Emad
chore: Apply comments:
f9383b3 
- Update the type of the 'extrinsics' in the 'saveIfKVStoreBackend' method to 'ExtrinsicResult' instead of 'any' type.
- Update the description of the 'BaseModule._add' method.
- Update the return type of the 'KVStore.set' method to be 'string' instead of 'KVStoreSetOptions' type.
- Update the return type of any function in the grid client that return the tf-chain changed methods
- Update the return type of the 'addStellarAddress' method to 'number' as the farm ID insteaf of 'Farm'
@Mahmoud-Emad Mahmoud-Emad force-pushed the development_2.6_gridclient_types branch from d092db0 to f9383b3 Compare August 7, 2024 12:16
@Mahmoud-Emad Mahmoud-Emad merged commit 7273cd3 into development Aug 7, 2024
9 checks passed
@Mahmoud-Emad Mahmoud-Emad deleted the development_2.6_gridclient_types branch August 7, 2024 12:25
@xmonader xmonader added this to the 2.6.0 milestone Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zaelgohary zaelgohary zaelgohary left review comments

@amiraabouhadid amiraabouhadid amiraabouhadid approved these changes

@AhmedHanafy725 AhmedHanafy725 AhmedHanafy725 approved these changes

@MohamedElmdary MohamedElmdary MohamedElmdary approved these changes

@maayarosama maayarosama Awaiting requested review from maayarosama maayarosama is a code owner

@AlaaElattar AlaaElattar Awaiting requested review from AlaaElattar AlaaElattar is a code owner

@0oM4R 0oM4R Awaiting requested review from 0oM4R 0oM4R is a code owner

@mohamedamer453 mohamedamer453 Awaiting requested review from mohamedamer453

@samaradel samaradel Awaiting requested review from samaradel samaradel is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
2.6.0
Development

Successfully merging this pull request may close these issues.
6 participants
@Mahmoud-Emad @amiraabouhadid @MohamedElmdary @zaelgohary @AhmedHanafy725 @xmonader