# web3-types

> Provide the common data structures and interfaces for web3 modules.

Latest version **1.10.0** (published 2024-12-03) · LGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install web3-types
pnpm add web3-types
yarn add web3-types
bun add web3-types
```

## Health

**Score 45/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score; popular repo.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.10.0 |
| Published | 2024-12-03 |
| First published | 2022-08-24 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=14 |
| Dependencies | 0 |
| Unpacked size | 293.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 19907 |
| Author | ChainSafe Systems |
| Maintainers | luu-alex, mpetrunic, gregthegreek, jdevcs, spacesailor |

## Links

- npm: https://www.npmjs.com/package/web3-types
- Repository: https://github.com/ChainSafe/web3.js
- Homepage: https://github.com/ChainSafe/web3.js#readme
- Issues: https://github.com/ChainSafe/web3.js/issues
- npm.io page: https://npm.io/package/web3-types

## Recent versions

- 1.10.0 (latest) — 2024-12-03
- 1.10.1-dev.bf16917.0 (dev) — 2025-01-17
- 1.1.0-rc.0 (rc) — 2023-08-09
- 1.10.1-dev.bc4a34b.0 — 2025-01-16
- 1.10.1-dev.89976a9.0 — 2025-01-14
- 1.10.1-dev.ae99434.0 — 2024-12-11
- 1.10.1-dev.fa5ce5b.0 — 2024-12-10
- 1.10.1-dev.f41ca32.0 — 2024-12-10
- 1.10.1-dev.594f83a.0 — 2024-12-03
- 1.9.1-dev.b3ee417.0 — 2024-12-03
- 1.9.1-dev.acdb0c7.0 — 2024-12-03
- 1.9.1-dev.926044b.0 — 2024-11-26
- 1.9.1-dev.7a8df69.0 — 2024-11-25
- 1.9.1-dev.984cb7c.0 — 2024-11-22
- 1.9.1-dev.3b122a2.0 — 2024-11-21
- … 370 more at https://npm.io/package/web3-types/versions

## README

<p align="center">
  <img src="assets/logo/web3js.jpg" width="500" alt="web3.js" />
</p>

# web3-types

![ES Version](https://img.shields.io/badge/ES-2020-yellow)
![Node Version](https://img.shields.io/badge/node-14.x-green)
[![NPM Package][npm-image]][npm-url]
[![Downloads][downloads-image]][npm-url]

This is a sub-package of [web3.js][repo].

`web3-types` contains the common data structures and interfaces used in [web3.js][repo].

## Installation

You can install the package either using [NPM](https://www.npmjs.com/package/web3-types) or using [Yarn](https://yarnpkg.com/package/web3-types)

### Using NPM

```bash
npm install web3-types
```

### Using Yarn

```bash
yarn add web3-types
```

## Getting Started

-   :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP)
    ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord)

## Prerequisites

-   :gear: [NodeJS](https://nodejs.org/) (LTS/Fermium)
-   :toolbox: [Yarn](https://yarnpkg.com/)/[Lerna](https://lerna.js.org/)

## Package.json Scripts

| Script           | Description                                        |
| ---------------- | -------------------------------------------------- |
| clean            | Uses `rimraf` to remove `dist/`                    |
| build            | Uses `tsc` to build package and dependent packages |
| lint             | Uses `eslint` to lint package                      |
| lint:fix         | Uses `eslint` to check and fix any warnings        |
| format           | Uses `prettier` to format the code                 |
| test             | Uses `jest` to run unit tests                      |
| test:integration | Uses `jest` to run tests under `/test/integration` |
| test:unit        | Uses `jest` to run tests under `/test/unit`        |

[docs]: https://docs.web3js.org/
[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-types
[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-types%2Fpackage.json
[npm-url]: https://npmjs.org/package/web3-types
[downloads-image]: https://img.shields.io/npm/dm/web3-types?label=npm%20downloads

---
_Source: https://npm.io/package/web3-types · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._