# @maticnetwork/maticjs

[![npm version](https://img.shields.io/npm/v/@maticnetwork/maticjs.svg)](https://www.npmjs.com/package/@maticnetwork/maticjs)
[![CI](https://github.com/0xPolygon/matic.js/actions/workflows/ci-trigger.yml/badge.svg?branch=master)](https://github.com/0xPolygon/matic.js/actions/workflows/ci-trigger.yml)
[![Release](https://github.com/0xPolygon/matic.js/actions/workflows/npm-release-trigger.yml/badge.svg?branch=master)](https://github.com/0xPolygon/matic.js/actions/workflows/npm-release-trigger.yml)
[![License: MIT](https://img.shields.io/npm/l/@maticnetwork/maticjs.svg)](LICENSE)

JavaScript SDK for the Polygon (Matic) Network. Move assets between
Ethereum and Polygon and withdraw using fraud proofs, without needing
deep familiarity with the underlying smart contracts.

## Install

```bash
npm install @maticnetwork/maticjs
# or
pnpm add @maticnetwork/maticjs
```

A plugin is required for the EVM library you use:

- [`@maticnetwork/maticjs-ethers`](https://www.npmjs.com/package/@maticnetwork/maticjs-ethers) — ethers v5
- [`@maticnetwork/maticjs-web3`](https://www.npmjs.com/package/@maticnetwork/maticjs-web3) — web3.js

## Documentation

<https://docs.polygon.technology/tools/matic-js/get-started>

## Source

<https://github.com/0xPolygon/matic.js> — issues, contributions, and the
broader monorepo. The published package directory is
[`packages/maticjs/`](https://github.com/0xPolygon/matic.js/tree/master/packages/maticjs).

## Support

Reach the team on [Discord](https://discord.com/invite/0xpolygonrnd).

## License

MIT — see [LICENSE](LICENSE).