Feat/clarinet sdk browser #1448
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
Codecov ReportAttention: Patch coverage is 📢 Thoughts on this report? Let us know! |
hugocaillard
commented
May 6, 2024
MicaiahReid
suggested changes
May 6, 2024
hugocaillard
force-pushed
the
feat/clarinet-sdk-browser
branch
from
a9ef52c
to
122c55d
Compare
hugocaillard
force-pushed
the
feat/clarinet-sdk-browser
branch
from
122c55d
to
086e0b9
Compare
hugocaillard
force-pushed
the
feat/clarinet-sdk-browser
branch
2 times, most recently
from
8ed2484
to
859957a
Compare
hugocaillard
force-pushed
the
feat/clarinet-sdk-browser
branch
3 times, most recently
from
dbe51ff
to
d6e3272
Compare
hugocaillard
force-pushed
the
feat/clarinet-sdk-browser
branch
3 times, most recently
from
10fd20c
to
46105b9
Compare
hugocaillard
force-pushed
the
feat/clarinet-sdk-browser
branch
from
46105b9
to
a3b8830
Compare
hugocaillard
force-pushed
the
feat/clarinet-sdk-browser
branch
from
f8c06a7
to
d4771fd
Compare
hugocaillard
force-pushed
the
feat/clarinet-sdk-browser
branch
from
f3cd2be
to
fc687ed
Compare
CharlieC3
previously approved these changes
Jul 9, 2024
CharlieC3
previously approved these changes
Jul 9, 2024
|
Thanks @CharlieC3 |
janniks
previously approved these changes
Jul 9, 2024
tippenein
reviewed
Jul 11, 2024
tippenein
previously approved these changes
Jul 11, 2024
janniks
approved these changes
Jul 11, 2024
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.
Description
Closes: #1432
This is a pretty important PR that brings the Clarinet SDK for the browser.
Two new packages
@hirosystems/clarinet-sdk-wasm-browser@hirosystems/clarinet-sdk-browserThey are the equivalent of these existing packages (but for the browser)
@hirosystems/clarinet-sdk-wasm@hirosystems/clarinet-sdkEnhancement
This PR also brings some enhancement to the SDK and some new methods useful for the browser use case (such as
initEmptySession()andclearCache()).Improved typing
Some Rust structs are encoded in JS objects, and the TS types for those were in
clarinet-sdk.They have been moved to
components/clarinet-sdk-wasm/src/ts_types.rsReview
A good first step to review this PR is to look at these 4 READMEs:
Some docs should be moved to the root Readme (how to build the sdk), but this readme require a lot of work, let's do this in a future PR
Caveats
It brings complexity to an already complicated architecture.
The
clarinet-sdk-wasmcomponent remain almost the same, except that it now requires a build script that runswasm-packtwice targetingnodejsandweb. It will also rename the web package to@hirosystems/clarinet-sdk-wasm-browser.The src directory of the
clarinet-sdkcomponent has been split into 3 directoriescommon/src,node/src,browser/src. With a bit of code duplication betweennode/src/sdkProxy.tsandbrowser/src/sdkProxy.ts.But thanks to NPM workspace, it still easy to build and publish the two components.