Giter VIP home page Giter VIP logo

web3.js's Introduction

Web3.js logo

web3.js - Ethereum JavaScript API

npm Build Status Coverage Status Join 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

import Web3 from 'web3';

const 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 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:

import Web3 from 'web3';
const web3 = new Web3("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

browsers node

Community

Similar libraries in other languages

web3.js's People

Contributors

frozeman avatar debris avatar joshstevens19 avatar nivida avatar cubedro avatar obscuren avatar aalok05 avatar gavofyork avatar huanzhang89 avatar ethers avatar kumavis avatar chevdor avatar lefterisjp avatar bethnull avatar ewingrj avatar tcrowe avatar nujabes403 avatar victortaelin avatar shayanb avatar lihengl avatar frewsxcv avatar gabmontes avatar grandvizierolaf avatar flash-git avatar caktux avatar jdkanani avatar carver avatar chriseth avatar tetratorus avatar bas-vk avatar

Watchers

Akeem Adeniji avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.