-
Notifications
You must be signed in to change notification settings - Fork 4
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
Add SDK client library #49
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a basic sketch of the SDK client library. I mostly mirrored the Python SDK method structure, but would like to diverge from that to make things more ergonomic. Most of the complexity here isn't really in the SDK itself, but rather in the testing framework around it. Making circuit creation requests mockable with Nock required a MITM proxy and some fairly sophisticated request parsing to handle multipart form payloads and the non-determinism of the gzipped tarballs. The circuit creation implementation was also a little tricky in terms of supporting both browsers and node. With these more difficult parts figured out, it shouldn't be too bad to refactor things and clean them up.
Note that the docstrings right now are pure fluff, I barely cleaned up what chatgpt output. I wanted to get something there so that I can test/develop the documentation build and then I'll clean these up and write real docs as I refactor the SDK's API.