Skip to content

Repository files navigation

Web3.js logo

web3.js - Ethereum JavaScript API

npmBuild StatusCoverage StatusJoin the chat at https://gitter.im/ethereum/web3.js

This is the Ethereum JavaScript API which connects to the Generic JSON RPC spec.

You need to run a local or remote Ethereum node to use this library.

Please read the documentation for more.

Installation

Node

npm install web3

Yarn

yarn add web3

Usage

importWeb3from'web3';constweb3=newWeb3('ws://localhost:8546');console.log(web3);>{eth: ...,shh: ...,utils: ...,
...
}

Additionally you can set a provider using web3.setProvider() (e.g. WebsocketProvider)

web3.setProvider('ws://localhost:8546');// orweb3.setProvider(newWeb3.providers.WebsocketProvider('ws://localhost:8546'));

There you go, now you can use it:

web3.eth.getAccounts().then(console.log);

Usage with TypeScript

We do support types within the repo itself. Please open an issue here if you find any wrong types.

You can use web3.js as follows:

importWeb3from'web3';constweb3=newWeb3("ws://localhost:8546");

Documentation

Documentation can be found at read the docs

Contributing

  • All contributions have to go into the 1.0 branch
  • Please follow the code style of the other files, we use 4 spaces as tabs.

Requirements

Commands

npm run clean // removes all the node_modules folders in all modules
npm run bootstrap // install all dependencies and symlinks the internal modules for all modules
npm run test // runs all tests npm run build // runs rollup
npm run dev // runs rollup with a watcher

Support

browsersnode

Community

Similar libraries in other languages

About

Ethereum JavaScript API

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages