# platon-web3-eth-contract

> Web3 module to interact with Ethereum smart contracts.

Latest version **1.2.4** (published 2021-12-28) · LGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install platon-web3-eth-contract
pnpm add platon-web3-eth-contract
yarn add platon-web3-eth-contract
bun add platon-web3-eth-contract
```

## Health

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

Positive: has types; no vulnerabilities; popular repo.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.4 |
| Published | 2021-12-28 |
| First published | 2021-12-28 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 10 |
| Unpacked size | 53.5 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 19908 |
| Maintainers | rileyge |

## Links

- npm: https://www.npmjs.com/package/platon-web3-eth-contract
- Repository: https://github.com/ethereum/web3.js/tree/1.x/packages/web3-eth-contract
- npm.io page: https://npm.io/package/platon-web3-eth-contract

## Dependencies (10)

- [rlp](https://npm.io/package/rlp.md) ^2.2.4
- [underscore](https://npm.io/package/underscore.md) 1.9.1
- [@types/bn.js](https://npm.io/package/@types/bn.js.md) ^4.11.4
- [platon-web3-core](https://npm.io/package/platon-web3-core.md) 1.2.4
- [platon-web3-utils](https://npm.io/package/platon-web3-utils.md) 1.2.5
- [platon-web3-eth-abi](https://npm.io/package/platon-web3-eth-abi.md) 1.2.4
- [platon-web3-core-method](https://npm.io/package/platon-web3-core-method.md) 1.2.4
- [platon-web3-core-helpers](https://npm.io/package/platon-web3-core-helpers.md) 1.2.4
- [platon-web3-core-promievent](https://npm.io/package/platon-web3-core-promievent.md) 1.2.4
- [platon-web3-core-subscriptions](https://npm.io/package/platon-web3-core-subscriptions.md) 1.2.4

## Recent versions

- 1.2.4 (latest) — 2021-12-28
- 1.2.7-beta.0 (beta) — 2021-12-29

## README

# web3-eth-contract

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

This is the contract package to be used in the `web3-eth` package.
Please read the [documentation][docs] for more.

## Installation

### Node.js

```bash
npm install web3-eth-contract
```

### In the Browser

Build running the following in the [web3.js][repo] repository:

```bash
npm run-script build-all
```

Then include `dist/web3-eth-contract.js` in your html file.
This will expose the `Web3EthContract` object on the window object.

## Usage

```js
// in node.js
var Web3EthContract = require('web3-eth-contract');

// set provider for all later instances to use
Web3EthContract.setProvider('ws://localhost:8546');

var contract = new Web3EthContract(jsonInterface, address);
contract.methods.somFunc().send({from: ....})
.on('receipt', function(){
    ...
});
```

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js

## Types

All the typescript typings are placed in the types folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js

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