npmpackage.info

Gathering detailed insights and metrics for @cosmjs/encoding

@cosmjs/encoding

The Swiss Army knife to power JavaScript based client solutions ranging from Web apps/explorers over browser extensions to server-side clients like faucets/scrapers.

0.32.4

657

Apache-2.0

TypeScript

16,847,598 4.7

Installations

npm install @cosmjs/encoding

Pull Requests

Open

36

Total

931

Closed

82

Merged

813

Issues

Open

144

Total

674

Closed

530

Releases

Unable to fetch releases

Developer

cosmos

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

NPM Version

Statistics

657 Stars

4,386 Commits

344 Forks

15 Watching

35 Branches

76 Contributors

Updated on 28 Nov 2024

Languages

TypeScript (89.95%)

JavaScript (6.37%)

Shell (3.35%)

Python (0.16%)

HTML (0.1%)

Dockerfile (0.06%)

CSS (0.01%)

Total Downloads

Cumulative downloads

Total Downloads

16,847,598

Last day

4.4%

68,808

Compared to previous day

Last week

30%

430,218

Compared to previous week

Last month

28%

1,394,980

Compared to previous month

Last year

112.3%

9,869,118

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

CosmJS is the Swiss Army knife to power JavaScript based client solutions ranging from Web apps/explorers over browser extensions to server-side clients like faucets/scrapers in the Cosmos ecosystem.

"Cosm" is short for Cosmos and "JS" is short for runs everywhere – we actually develop in TypeScript.

Documentation

Here is a list of examples using the Stargate package for use with Cosmos SDK 0.41 applications (like gaia 4). Take a look at the wiki page, "What can CosmJS do for me?" and various tests (ex) for more example usage of the packages.

API documentation

The full API documentation is hosted at cosmos.github.io/cosmjs. This is a bit tricky to navigate and requires basic TypeScript understanding. It is helpful if you want to look up details for advanced use cases. This documentation is auto-generated based on the current main branch and can occasionally diverge from the latest release.

Using custom Stargate modules

Documentation on how to use your own custom modules with CosmJS for Stargate chains (Cosmos SDK v0.41) can be found here.

Packages

CosmJS is a library that consists of many smaller npm packages within the @cosmjs namespace, a so-called monorepo. Here are some of them to get an idea:

Package	Description	Latest
@cosmjs/stargate	A client library for the Cosmos SDK 0.40+ (Stargate)
@cosmjs/faucet	A faucet application for node.js
@cosmjs/cosmwasm-stargate	Client for Stargate chains with the CosmWasm module enabled
@cosmjs/crypto	Cryptography for blockchain projects, e.g. hashing (SHA-2, Keccak256, Ripemd160), signing (secp256k1, ed25519), HD key derivation (BIP-39, SLIP-0010), KDFs and symmetric encryption for key storage (PBKDF2, Argon2, XChaCha20Poly1305)
@cosmjs/encoding	Encoding helpers for blockchain projects
@cosmjs/math	Safe integers; decimals for handling financial amounts	$npm version$

Modularity

We're pretty proud of the modularity and a clean dependency tree in this monorepo. This ensures software quality on our side and lets users pick exactly what they need. Here you see how everything fits together (every item is a npm package; right depends on left):

CosmJS dependency tree

If this was not enough to scare you away, check out the version including app runtime dependencies: cosmjs-tree-full.png.

Supported JS environments

Currently the codebase supports the following runtime environments:

Node.js 14+
Modern browsers (Chromium/Firefox/Safari, no Internet Explorer or Edge Spartan)
Browser extensions (Chromium/Firefox)

Our current JavaScript target standard is ES2020. We use WebAssembly to implement certain cryptographic functions.

We're happy to adjust this list according to users' needs as long as you don't ask for Internet Explorer support. If your environment does not support Wasm, we can work on a solution with swappable implementations.

Webpack Configs

With WebPack 5, you have to be explicit about the usage of Node.js types and modules that were simply replaced with re-implementations for browsers in Webpack 4.

Configs for 0.28 and later:

1module.exports = [
2  {
3    // ...
4    plugins: [
5      ...,
6      new webpack.ProvidePlugin({
7        Buffer: ["buffer", "Buffer"],
8      }),
9    ],
10    // ...
11    resolve: {
12      fallback: {
13        buffer: false,
14        crypto: false,
15        events: false,
16        path: false,
17        stream: false,
18        string_decoder: false,
19      },
20    },
21  },
22];

Configs for CosmJS < 0.28

1module.exports = [
2  {
3    // ...
4    plugins: [
5      ...,
6      new webpack.ProvidePlugin({
7        Buffer: ["buffer", "Buffer"],
8      }),
9    ],
10    // ...
11    resolve: {
12      fallback: {
13        buffer: false,
14        crypto: false,
15        events: false,
16        path: false,
17        stream: require.resolve("stream-browserify"),
18        string_decoder: false,
19      },
20    },
21  },
22];

Roadmap

We maintain a development board, use release milestones and share important updates in the CosmWasm Community Call. For higher level roadmap discussion please reach out to the team.

Known limitations

0.26

When connecting to a Cosmos SDK 0.44+ backend, the verified queries from AuthExtension and BankExtension as well as StargateClient.getAccountVerified will fail because the storage keys are not stable. Unverified queries can be used instead. Those queries are deprecated now and will be removed in 0.27 (#910).

0.25

Decoding blocks of height 1 is unsupported. This is fixed in #815 and will be released as part of CosmJS 0.26.

0.24

AuthExtension and all higher level Stargate clients only support BaseAccounts for all functionality, including getting account numbers and sequences for transaction signing. This will be implemented for all common Cosmos SDK account types in the 0.25 series.

Get in touch

The CosmJS development team is happy to get in touch with you for all questions and suggestions.

GitHub issues for bugs and feature requests
The #cosmjs channel on the "Cosmos Community" Discord server for questions and open discussions
#CosmJS on Twitter to spread the word

Development

See HACKING.md.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

8

SAST

Determines if the project uses static code analysis.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.7

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@cosmjs/encoding

Installations

Pull Requests

36

931

82

813

Issues

144

674

530

Releases

Unable to fetch releases

Developer

Developer Guide

CommonJS

Yes

Statistics

Languages

Total Downloads

16,847,598

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Documentation

API documentation

Using custom Stargate modules

Packages

Modularity

Supported JS environments

Webpack Configs

Roadmap

Known limitations

0.26

0.25

0.24

Get in touch

Development

10

10

10

9

8

4

0

0

0

0

0

0

4.7

/10