# @portis/web3

> Portis Web3 SDK

Latest version **4.0.7** (published 2022-02-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @portis/web3
pnpm add @portis/web3
yarn add @portis/web3
bun add @portis/web3
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.7 |
| Published | 2022-02-02 |
| First published | 2019-01-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 758.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | katien, portis-owner, sneaky.pangolin, bradian-npm |
| Keywords | blockchain, ethereum, web3, dapp |

## Links

- npm: https://www.npmjs.com/package/@portis/web3
- npm.io page: https://npm.io/package/@portis/web3

## Dependencies (4)

- [penpal](https://npm.io/package/penpal.md) 3.0.7
- [pocket-js-core](https://npm.io/package/pocket-js-core.md) 0.0.3
- [ethereumjs-util](https://npm.io/package/ethereumjs-util.md) 5.2.0
- [web3-provider-engine](https://npm.io/package/web3-provider-engine.md) 16.0.1

## Recent versions

- 4.0.7 (latest) — 2022-02-02
- 4.1.0 (alpha) — 2021-07-29
- 3.0.1 (dev) — 2020-12-30
- 4.0.6 — 2021-10-14
- 4.0.5 — 2021-06-22
- 4.0.4 — 2021-06-02
- 4.0.3 — 2021-06-02
- 4.0.2 — 2021-06-01
- 4.0.1 — 2021-05-31
- 1.0.6 — 2021-05-31
- 4.0.0 — 2021-04-21
- 3.0.10 — 2021-03-30
- 3.0.9 — 2021-03-30
- 3.0.8 — 2021-02-09
- 3.0.7 — 2021-02-09
- … 69 more at https://npm.io/package/@portis/web3/versions

## README

<p align="center">
  <a href="https://portis.io/" target="_blank">
    <img alt="Portis" src="https://s3.amazonaws.com/portis-prod/assets/portis-logo/logo_with_name_medium.png" width="749">
  </a>
</p>

![](https://img.shields.io/npm/v/@portis/web3.svg?colorB=blue&style=flat)
![](https://img.shields.io/badge/chat-telegram-blue.svg)
[![Twitter](https://img.shields.io/badge/twitter-portis-blue.svg?style=flat)](https://twitter.com/portis_io)
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/portis-project/web-sdk/blob/master/LICENSE.txt)
![](https://img.shields.io/github/stars/portis-project/web-sdk.svg?style=flat)

* ⚗️ [demo](https://codesandbox.io/s/l9mn6o89qm)
* 📕 [docs](https://docs.portis.io)
* 💬 [chat](https://t.me/portisHQ)

## Quick Start

It should take no more than 5 minutes to get started with Portis 🚀

1. Register a DApp in the [Portis Dashboard](https://dashboard.portis.io), and copy your DApp ID.

1. Install Portis and Web3

   ```shell
   npm install @portis/web3 web3
   ```

1. Import and initialize a web3 instance

   ```javascript
   import Portis from '@portis/web3';
   import Web3 from 'web3';

   const portis = new Portis('YOUR_DAPP_ID', 'mainnet');
   const web3 = new Web3(portis.provider);
   ```

1. Verify everything works by calling a web3 method such as getAccounts:

   ```javascript
   web3.eth.getAccounts((error, accounts) => {
     console.log(accounts);
   });
   ```

1. You are good to go! 👍

For more information see our [docs](https://docs.portis.io) 📕

## License

MIT

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