@sei-js/cosmos #200
Merged
@sei-js/cosmos #200
Conversation
This file contains hidden or 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
- Removed the need for telescope and instead generate TS files with buf.build and cherry pick what we want. - Adds @sei-js/cosmos/types for easy typescript types imports - Adds @sei-js/cosmos/encoding for easy proto/direct message encoding - Adds @sei-js/cosmos/rest which allows for querying cosmos REST nodes - Removes leading zeros from @sei-js/ledger bytes and bumps the sei ledger package version - Remove tsconfig in favor of biome for this package.
- Added ts-configs back - Fixed a few typescript warnings inside the encoding library. - Update README.md
- Compiled outputs for cjs, esm, and ts types imports respectively - Added @ts-nocheck to index files
Replace the old Amino type structure (module.package.type) to the more standard amino way (module/type), which is required for Ledger signing.
🦋 Changeset detectedLatest commit: dbde1da The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
besated
reviewed
Nov 28, 2024
Contributor
There was a problem hiding this comment.
just wanted to confirm - is /generated supposed to be checked into git?
Collaborator
Author
There was a problem hiding this comment.
Yeah cuz otherwise people won't be able to view the files on github. They would have to install the module and build, which isn't ideal.
Collaborator
Author
There was a problem hiding this comment.
But I did add it to .npmignore, so that way it's only when viewing the repo it will get them.
Used the old `/gen` instead of newer `/generated`
besated
approved these changes
Dec 2, 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.
Add @sei-js/cosmos
Adds a new package called
@sei-js/cosmoswhich is meant to replace and expand upon@sei-js/proto. It usesbufto build the protos, and then node scripts to extract only relevant into simplified libraries.Libraries
@sei-js/cosmos/typesA library exporting Typescript types for all modules used on Sei. Additionally it contains query Request/Response types, and other base types like
Coin,Account, etc.@sei-js/cosmos/encodingA replacement to the old
@sei-js/protolibrary, which was generated by telescope. Contains protobuf encoding and decoding functions for all Sei data types including all Query and Execute Msg types and all Sei base types. Additionally it includes registries and aminoConverters for easy use with@cosmjsclients. Uses types from@sei-js/cosmos/types.@sei-js/cosmos/typesA replacement to the LCD client generated in the old
@sei-js/protolibrary. This uses simple fetch requests to query the chain state. Uses types from@sei-js/cosmos/types.Review Notes
Look into the
./generatedfolder to see the output from theyarn generatecommand. See the README.md file for usage or local generation instructionsTesting
This project has been tested by me extensively, has been used to test ledger signing on the Cosmos app, has been integrated for months into QA tests, and is now used on the Sei App via the NPM internal release.