Skip to content
Ethereum JavaScript API
JavaScript TypeScript Shell HTML
Branch: 1.x
Clone or download
nivida Merge pull request #3325 from ethereum/feature/ENS-registry
Implements all methods of the ENS registry
Latest commit 93009e0 Feb 21, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist minified file, CHANGELOG.md, and versions manually updated if required Jan 27, 2020
docs web3-eth-ens doc typos fixed Feb 6, 2020
packages funcDoc method notation fixed in Regsitry.js 'ttl' -> 'getTTL' Feb 5, 2020
scripts Merge branch '1.x' into feature/ENS-registry Feb 5, 2020
test wrongly formatted semicolon moved in eth.ens test file Feb 5, 2020
.bowerrc fixed #149 Mar 30, 2015
.editorconfig Updated bower.json & Readme Nov 5, 2014
.gitignore ensAddress test config added to .gitignore Jan 14, 2020
.jshintignore Release - 1.2.2 (#3147) Oct 23, 2019
.jshintrc fixes #1340, #1341, 1342 Feb 13, 2018
.npmignore Add E2E tests for geth and ganache dev clients (#3122) Oct 15, 2019
.travis.yml separate e2e ens travis container re-added Jan 29, 2020
.versions clean install to update all package-locks entries to the latest defin… Nov 14, 2019
CHANGELOG.md Merge branch '1.x' into feature/ENS-registry Feb 3, 2020
CONTRIBUTIONS.md Lengthen release review to 1 week, require stylistic consistency Dec 16, 2019
ISSUE_TEMPLATE.md Issue and PR template added (#1821) Jul 31, 2018
LICENSE update license per name change to web3.js Jun 10, 2015
PULL_REQUEST_TEMPLATE.md PR template extended Feb 6, 2020
README.md URL of the coveralls badge in the root readme file corrected Feb 2, 2020
bower.json required changes from the patch release PR applied on 1.x Feb 2, 2020
circle.yml CI - add circleCI config Aug 26, 2016
gulpfile.js Remove unnecessary formatting changes from gulpfile Dec 10, 2019
karma.conf.js Remove unnecessary karma flag, improve comments Dec 10, 2019
lerna.json v1.2.5 Jan 27, 2020
package-lock.json Bump @ensdomains/ens from 0.3.11 to 0.4.0 Jan 30, 2020
package.js minified file, CHANGELOG.md, and versions manually updated if required Jan 27, 2020
package.json Add npm alias scripts for generating html cov report locally Feb 5, 2020
verdaccio.yml Use registry uplink timeout & non-conflicting package version Feb 3, 2020
web3js.ai added readmes to sub packages Jul 24, 2017
web3js.jpg improved readme Jul 20, 2017
web3js.svg added readmes to sub packages Jul 24, 2017

README.md

web3.js - Ethereum JavaScript API

Join the chat at https://gitter.im/ethereum/web3.jsnpm Build Status dependency status dev dependency status Coverage Status lerna

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

Meteor

Note: works only in the Browser for now. (PR welcome).

meteor add ethereum:web3

In the Browser

Use the prebuild dist/web3.min.js, or build using the web3.js repository:

npm run-script build

Then include dist/web3.js in your html file. This will expose Web3 on the window object.

Or via jsDelivr CDN

<script src="https://cdn.jsdelivr.net/npm/web3@latest/dist/web3.min.js"></script>

UNPKG

<script src="https://unpkg.com/web3@latest/dist/web3.min.js"></script>

Usage

// in node.js
var Web3 = require('web3');

var web3 = new Web3('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');
// or
web3.setProvider(new Web3.providers.WebsocketProvider('ws://localhost:8546'));

There you go, now you can use it:

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

Usage with TypeScript

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

You can use web3.js as follows:

import Web3 from 'web3';
const web3 = new Web3('ws://localhost:8546');

If you are using the types in a commonjs module like for example a node app you just have to enable esModuleInterop in your tsconfig compile option, also enable allowSyntheticDefaultImports for typesystem compatibility:

"compilerOptions": {
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true,
    ....

Documentation

Documentation can be found at read the docs.

Building

Requirements

sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm

Building (gulp)

Build only the web3.js package

npm run-script build

Or build all sub packages as well:

npm run-script build-all

This will put all the browser build files into the dist folder.

Testing (mocha)

npm test

Contributing

The contribution guidelines are provided in CONTRIBUTIONS

Community

Similar libraries in other languages

You can’t perform that action at this time.