sei-protocol / sei-js

SeiJS is a monorepo that contains multiple NPM libraries for writing applications that interact with the Sei network.
44 stars 38 forks source link

sei-js v2 release #131

Closed codebycarson closed 7 months ago

codebycarson commented 7 months ago

@sei-js v2 release

Overview

This PR creates two new packages for release on NPM and removes the old /core and /react packages. Those packages will be deprecated in a separate PR to be merged before this one. Additionally many packages have been updated, the telescope package and configuration has been updated for /proto, and the docs have been improved dramatically.

New Packages

/evm

This package contains many helper functions for working with precompiles for WASM interoperability as well as general chain information for easy use with Wagmi and 'ethers'.

/cosm

This package is the old /core library with various helper functions from /react moved in

Removed packages

/core

@sei-js/core has been deprecated in favor of using the new /cosmjs package. Most of the configuration and wrappers in the old package for use with cosmjs anyway.

/react

This packaged has moved to support with Cosmos Kit rather than managing the react hooks and components for wallet connection. Cosmos Kit is robust, maintained, and easy to use.

Docs

Every function exported has in depth typedoc comments for generating clear and clean docs. The docs have been themed with a custom Sei theme as well

Testing

The best way to test this is to pull the package, run the tests, generate and review the docs, and to test in a React application

changeset-bot[bot] commented 7 months ago

🦋 Changeset detected

Latest commit: ef0acb3c9643661650deaed69c6418e0092ad385

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages | Name | Type | | -------------- | ----- | | @sei-js/cosmjs | Patch | | @sei-js/proto | Patch | | @sei-js/evm | Patch |

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

codecov-commenter commented 7 months ago

Codecov Report

Attention: Patch coverage is 78.26087% with 25 lines in your changes are missing coverage. Please review.

Project coverage is 83.10%. Comparing base (9ce3c32) to head (ef0acb3).

Files Patch % Lines
packages/cosmjs/src/staking/apr.ts 68.51% 17 Missing :warning:
packages/cosmjs/src/utils/address.ts 80.64% 6 Missing :warning:
...es/cosmjs/src/core/signingClient/cosmWasmClient.ts 90.00% 1 Missing :warning:
...es/cosmjs/src/core/signingClient/stargateClient.ts 93.75% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #131 +/- ## ========================================== + Coverage 75.79% 83.10% +7.31% ========================================== Files 36 11 -25 Lines 566 148 -418 Branches 131 23 -108 ========================================== - Hits 429 123 -306 + Misses 137 25 -112 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

besated commented 7 months ago

left some comments, nice work on everything though! the docs are looking really good

besated commented 7 months ago

i think there’s a few things we can update in separate pr: