@maticnetwork/maticjs

Matic SDK

This repository contains the maticjs client library. maticjs makes it easy for developers, who may not be deeply familiar with smart contract development, to interact with the various components of Matic Network.

This library will help developers to move assets from Ethereum chain to Matic chain, and withdraw from Matic to Ethereum using fraud proofs.

We will be improving this library to make all features available like Plasma Faster Exit, challenge exit, finalize exit and more.

Installation

NPM

---

$ npm install --save @maticnetwork/maticjs

CDN

---

<script src="https://cdn.jsdelivr.net/npm/@maticnetwork/maticjs@2.0.0/dist/matic.js"></script>

Matic is also available on unpkg

---

Getting started

// Import default Matic sdk
import Matic from '@maticnetwork/maticjs'
// create network instance
  const network = new Network(
    _network, // set network name e.g `testnet` or `mainnet`
    _version // set version e.g `mumbai` or `v1`
  )

// Create sdk instance
const matic = new Matic({
  network: <network-name>, // set network name
  version: <network-version> // set network version

  // Set Matic provider - string or provider instance
  // Example: <network.Matic.RPC> OR new Web3.providers.HttpProvide(<network.Matic.RPC>)
  // Some flows like startExitFor[Metadata]MintableBurntToken, require a webSocket provider such as new web3 providers.WebsocketProvider('ws://localhost:8546')
  maticProvider: <web3-provider>,

  // Set Mainchain provider - string or provider instance
  // Example: 'https://ropsten.infura.io' OR new Web3.providers.HttpProvider('http://localhost:8545')
  parentProvider: <web3-provider>,
  // set default options e.g { from }
  parentDefaultOptions: { <options> },
  // set default options
  maticDefaultOptions: { <options> },
})

// init matic

matic.initialize()

// Set wallet
// Warning: Not-safe
// matic.setWallet(<private-key>) // Use metamask provider or use WalletConnect provider instead.

// get ERC20 token balance
await matic.balanceOfERC20(
  user, //User address
  tokenAddress, // Token address
  options // transaction fields
)

// get ERC721 token balance
await matic.balanceOfERC721(
  user, // User address
  tokenAddress,  // Token address
  options // transaction fields
)

// get ERC721 token ID
await matic.tokenOfOwnerByIndexERC721(
  from, // User address
  tokenAddress,  // Token address
  index, // index of tokenId
  options // transaction fields
)

// Deposit Ether into Matic chain
await matic.depositEther(
  amount, // amount in wei for deposit
  options // transaction fields
)

// Approve ERC20 token for deposit
await matic.approveERC20TokensForDeposit(
  token,  // Token address,
  amount,  // Token amount for approval (in wei)
  options // transaction fields
)

// Deposit token into Matic chain. Remember to call `approveERC20TokensForDeposit` before
await matic.depositERC20ForUser(
  token,  // Token address
  user,   // User address (in most cases, this will be sender's address),
  amount,  // Token amount for deposit (in wei),
  options // transaction fields
)

// Deposit ERC721 token into Matic chain.
await matic.safeDepositERC721Tokens(
  token,  // Token address
  tokenId,  // TokenId for deposit
  options // transaction fields
)

// Transfer token on Matic
await matic.transferERC20Tokens(
  token,  // Token address
  user,   // Recipient address
  amount,  // Token amount
  options // transaction fields
)

// Transfer ERC721 token on Matic
await matic.transferERC721Tokens(
  token,  // Token address
  user,   // Recipient address
  tokenId,  // TokenId
  options // transaction fields
)

// generate transfer signature off-chain (can be used to in place of `approve`)
await matic.getTransferSignature(
  toSell, // sell order obj
  toBuy, // buy order obj
  options // transaction fields
)

// execute transfer/swap of assets on-chain, using off-chain signature
await matic.transferWithSignature(
  sig, // signature: intent to sell tokens
  toSell, // sell order obj
  toBuy, // buy order obj
  orderFiller, // address to transfer tokens to
  options // transaction fields
)


// Initiate withdrawal of ERC20 from Matic and retrieve the Transaction id
await matic.startWithdraw(
  token, // Token address
  amount, // Token amount for withdraw (in wei)
  options // transaction fields
)

// Initiate withdrawal of ERC721 from Matic and retrieve the Transaction id
await matic.startWithdrawForNFT(
  token, // Token address
  tokenId, // TokenId for withdraw
  options // transaction fields
)

// Withdraw funds from the Matic chain using the Transaction id generated from the 'startWithdraw' method
// after header has been submitted to mainchain
await matic.withdraw(
  txId, // Transaction id generated from the 'startWithdraw' method
  options // transaction fields
)

await matic.withdrawNFT(
  txId, // Transaction id generated from the 'startWithdraw' method
  options // transaction fields
)

await matic.processExits(
  tokenAddress, // root `token` addres
  options // transaction fields
)


// Import Matic sdk for POS Portal
import MaticPOSClient from '@maticnetwork/maticjs'

const maticPOSClient = new MaticPOSClient({

  // Set Matic provider - string or provider instance
  // Example: 'https://testnet.matic.network' OR new Web3.providers.HttpProvider('http://localhost:8545')
  // Some flows like startExitFor[Metadata]MintableBurntToken, require a webSocket provider such as new web3.providers.WebsocketProvider('ws://localhost:8546')
  maticProvider: <web3-provider>,

  // Set Mainchain provider - string or provider instance
  // Example: 'https://kovan.infura.io' OR new Web3.providers.HttpProvider('http://localhost:8545')
  parentProvider: <web3-provider>,

  // Set rootchain contract. See below for more information
  rootChain: <root-contract-address>,

  // Set pos-root-chain-manager Address. See below for more information
  posRootChainManager: <pos-root-chain-manager-address>,
})

// Approve ERC20 tokens for deposit using POS Portal
await maticPOSClient.approveERC20ForDeposit(
  rootToken, // RootToken address,
  amount, // Amount for approval (in wei)
  options // transaction fields
)

// Deposit tokens into Matic chain using POS Portal.
// Remember to call `approveERC20ForDeposit` before this
await maticPOSClient.depositERC20ForUser(
  rootToken, // RootToken address
  user, // User address (in most cases, this will be sender's address),
  amount, // Amount for deposit (in wei)
  options // transaction fields
)

// Deposit ether into Matic chain using POS Portal.
// It is an ERC20 token on Matic chain
await maticPOSClient.depositEtherForUser(
  user, // User address (in most cases, this will be sender's address),
  amount, // Amount for deposit (in wei)
  options // transaction fields
)

// Burn ERC20 tokens(deposited using POS Portal) on Matic chain and retrieve the Transaction id
await maticPOSClient.burnERC20(
  childToken, // ChildToken address
  amount, // Amount to burn (in wei)
  options // transaction fields
)

// Exit funds from the POS Portal using the Transaction id generated from the 'burnERC20' method
// Can be called after checkpoint has been submitted for the block containing burn tx.
await maticPOSClient.exitERC20(
  txId, // Transaction id generated from the 'burnERC20' method
  options // transaction fields
)

How it works?

The flow for asset transfers on the Matic Network is as follows:

• User deposits crypto assets in Matic contract on mainchain
• Once deposited tokens get confirmed on the main chain, the corresponding tokens will get reflected on the Matic chain.
• The user can now transfer tokens to anyone they want instantly with negligible fees. Matic chain has faster blocks (approximately ~ 1 second). That way, the transfer will be done almost instantly.
• Once a user is ready, they can withdraw remaining tokens from the mainchain by establishing proof of remaining tokens on Root contract (contract deployed on Ethereum chain)

Network and version

• Network is network name you want to use e.g mainnet or testnet

• version is network verstion e.g v1, v2, mumbai

Contracts and addresses

You don't have to worry about contract addresses, giving correct network name and version will pickup respective addresses :grinning:

Faucet

https://faucet.matic.network

API

• new Matic()
• matic.balanceOfERC20()
• matic.balanceOfERC721()
• matic.tokenOfOwnerByIndexERC721()
• matic.depositEther()
• matic.approveERC20TokensForDeposit()
• matic.depositERC20ForUser()
• matic.safeDepositERC721Tokens()
• matic.transferERC20Tokens()
• matic.transferERC721Tokens()
• matic.startWithdraw()
• matic.startWithdrawForNFT()
• matic.withdraw()
• matic.withdrawNFT()
• matic.getTransferSignature()
• matic.transferWithSignature()
• matic.processExits()

WithdrawManager

• matic.withdrawManager.startExitForMintableBurntToken()
• matic.withdrawManager.startExitForMetadataMintableBurntToken()

POS Portal

• maticPOSClient.approveERC20ForDeposit()
• maticPOSClient.depositERC20ForUser()
• maticPOSClient.depositEtherForUser()
• maticPOSClient.burnERC20()
• maticPOSClient.exitERC20()

---

new Matic(options)

Creates Matic SDK instance with give options. It returns a MaticSDK object.

import Matic from 'maticjs'

const matic = new Matic(options)
matic.initialize()

• options is simple Javascript object which can have following fields:
  • network can be string
  • version can be string
  • maticProvider can be string or Web3.providers instance. This provider must connect to Matic chain. Value can be anyone of following:
    • network.Matic.RPC
    • new Web3.providers.HttpProvider(network.Matic.RPC)
    • WalletConnect Provider instance
  • parentProvider can be string or Web3.providers instance. This provider must connect to Ethereum chain (testnet or mainchain). Value can be anyone of following:
    • network.Main.RPC
    • new Web3.providers.HttpProvider(network.Main.RPC)
    • WalletConnect Provider instance
  • parentDefaultOptions is simple Javascript object with following options
    • from must be valid account address(required)
  • maticDefaultOptions is simple Javascript object with following options
    • from must be valid account address(required)

---

matic.balanceOfERC20(userAddress, token, options)

get balance of ERC20 token for address.

• token must be valid token address
• userAddress must be valid user address
• options see more infomation here
  • parent must be boolean value. For balance on Main chain, use parent: true

This returns balance.

Example:

matic
  .balanceOfERC20('0xABc578455...', '0x5E9c4ccB05...', {
    from: '0xABc578455...',
  })
  .then(balance => {
    console.log('balance', balance)
  })

---

matic.balanceOfERC721(userAddress, token, options)

get balance of ERC721 token for address.

• token must be valid token address
• userAddress must be valid user address
• options see more infomation here
  • parent must be boolean value. For balance on Main chain, use parent: true

This returns balance.

Example:

matic
  .balanceOfERC721('0xABc578455...', '0x5E9c4ccB05...', {
    from: '0xABc578455...',
  })
  .then(balance => {
    console.log('balance', balance)
  })

---

matic.tokenOfOwnerByIndexERC721(userAddress, token, index, options)

get ERC721 tokenId at index for token and for address.

• token must be valid token address
• userAddress must be valid user address
• index index of tokenId

This returns matic tokenId.

Example:

matic
  .tokenOfOwnerByIndexERC721('0xfeb14b...', '21', 0, {
    from: '0xABc578455...',
  })
  .then(tokenID => {
    console.log('Token ID', tokenID)
  })

matic.depositEthers(amount, options)

Deposit options.value

• amount must be token amount in wei (string, not in Number)
• options see more infomation here.
  • from must be valid account address(required)
  • encodeAbi must be boolean value. For Byte code of transaction, use encodeAbi: true

This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

matic.depositEthers(amount, {
  from: '0xABc578455...',
})

---

matic.approveERC20TokensForDeposit(token, amount, options)

Approves given amount of token to rootChainContract.

• token must be valid ERC20 token address
• amount must be token amount in wei (string, not in Number)
• options (optional) must be valid javascript object containing from, gasPrice, gasLimit, nonce, value, onTransactionHash, onReceipt or onError
  • from must be valid account address(required)
  • gasPrice same as Ethereum sendTransaction
  • gasLimit same as Ethereum sendTransaction
  • nonce same as Ethereum sendTransaction
  • value contains ETH value. Same as Ethereum sendTransaction. This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

matic.approveERC20TokensForDeposit('0x718Ca123...', '1000000000000000000', {
  from: '0xABc578455...',
})

---

matic.depositERC20ForUser(token, user, amount, options)

Deposit given amount of token with user user.

• token must be valid ERC20 token address
• user must be value account address
• amount must be token amount in wei (string, not in Number)
• options see more infomation here
  • encodeAbi must be boolean value. For Byte code of transaction, use encodeAbi: true

This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

const user = <your-address> or <any-account-address>

matic.depositToken('0x718Ca123...', user, '1000000000000000000', {
  from: '0xABc578455...'
})

---

matic.safeDepositERC721Tokens(token, tokenId, options)

Deposit given TokenID of token with user user.

• token must be valid ERC20 token address
• tokenId must be valid token ID
• options see more infomation here

This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

matic.safeDepositERC721Tokens('0x718Ca123...', '70000000000', {
  from: '0xABc578455...',
})

---

matic.transferERC20Tokens(token, user, amount, options)

Transfer given amount of token to user.

• token must be valid ERC20 token address
• user must be value account address
• amount must be token amount in wei (string, not in Number)
• options see more infomation here
  • parent must be boolean value. For token transfer on Main chain, use parent: true
  • encodeAbi must be boolean value. For Byte code of transaction, use encodeAbi: true

This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

const user = <your-address> or <any-account-address>

matic.transferERC20Tokens('0x718Ca123...', user, '1000000000000000000', {
  from: '0xABc578455...',

  // For token transfer on Main network
  // parent: true
})

---

matic.transferERC721Tokens(token, user, tokenId, options)

Transfer given tokenId of token to user.

• token must be valid ERC721 token address
• user must be value account address
• tokenId must be token amount in wei (string, not in Number)
• options see more infomation here
  • parent must be boolean value. For token transfer on Main chain, use parent: true
  • encodeAbi must be boolean value. For Byte code of transaction, use encodeAbi: true

This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

const user = <your-address> or <any-account-address>

matic.transferERC721Tokens('0x718Ca123...', user, '100006500000000000000', {
  from: '0xABc578455...',

  // For token transfer on Main network
  // parent: true
})

---

matic.getTransferSignature(toSell, toBuy)

Off-chain signature generation for transferWithSig function call

• toSell object

  • token: address of token owned,
  • amount: amount/tokenId of the token to sell,
  • expiry: expiry (block number after which the signature should be invalid),
  • orderId: a random 32 byte hex string,
  • spender: the address approved to execute this transaction

• toBuy object

  • token: address of token to buy
  • amount: amount/tokenId of token to buy

• options see more infomation here

  • from: owner of the token (toSell)

  // sell order
  let toSell = {
    token: token2,
    amount: value2,
    expiry: expire,
    orderId: orderId,
    spender: spender,
  }
  
  // buy order
  let toBuy = {
    token: token1,
    amount: value1,
  }
  
  const sig = await matic.getTransferSignature(toSell, toBuy, {
    from: tokenOwner,
  })
  

---

matic.transferWithSignature(sig, toSell, toBuy, orderFiller)

Executes transferWithSig on child token (erc20/721). Takes input as signature generated from matic.getTransferSignature

• sig: signature generated with matic.getTransferSignature
• toSell: object
  • token: address of token owned,
  • amount: amount/tokenId of the token to sell,
  • expiry: expiry (block number after which the signature should be invalid),
  • orderId: a random 32 byte hex string,
  • spender: the address approved to execute this transaction
• toBuy: object
  • token: address of token to buy
  • amount: amount/tokenId of token to buy
• orderFiller: address of user to transfer the tokens to
• options see more infomation here
  • from: the approved spender in the toSell object by the token owner

transfers toSell.token from tokenOwner to orderFiller

// sell order
let toSell = {
  token: token2,
  amount: value2,
  expiry: expire,
  orderId: orderId,
  spender: spender,
}

// buy order
let toBuy = {
  token: token1,
  amount: value1,
}

let sig = await matic.getTransferSignature(toSell, toBuy, { from: tokenOwner })

const tx = await matic.transferWithSignature(
  sig, // signature with the intent to buy tokens
  toSell, // sell order
  toBuy, // buy order
  orderFiller, // order fulfiller
  {
    from: spender, // approved spender
  }
)

---

matic.startWithdraw(token, amount, options)

Start withdraw process with given amount for token.

• token must be valid ERC20 token address
• amount must be token amount in wei (string, not in Number)
• options see more infomation here
  • encodeAbi must be boolean value. For Byte code of transaction, use encodeAbi: true

This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

matic.startWithdraw('0x718Ca123...', '1000000000000000000', {
  from: '0xABc578455...',
})

---

matic.startWithdrawForNFT(token, tokenId, options)

Start withdraw process with given tokenId for token.

• token must be valid ERC721 token address
• tokenId must be token tokenId (string, not in Number)
• options see more infomation here
  • encodeAbi must be boolean value. For Byte code of transaction, use encodeAbi: true

This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

matic.startWithdrawForNFT('0x718Ca123...', '1000000000000000000', {
  from: '0xABc578455...',
})

---

matic.withdraw(txId, options)

Withdraw tokens on mainchain using txId from startWithdraw method after header has been submitted to mainchain.

• txId must be valid tx hash
• options see more infomation here

This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

matic.withdraw('0xabcd...789', {
  from: '0xABc578455...',
})

---

matic.withdrawNFT(txId, options)

Withdraw tokens on mainchain using txId from startWithdraw method after header has been submitted to mainchain.

• txId must be valid tx hash
• options see more infomation here
  • encodeAbi must be boolean value. For Byte code of transaction, use encodeAbi: true

This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

matic.withdrawNFT('0xabcd...789', {
  from: '0xABc578455...',
})

---

matic.processExits(rootTokenAddress, options)

Call processExits after completion of challenge period, after that withdrawn funds get transfered to your account on mainchain

• rootTokenAddress RootToken address
• options see more infomation here
  • encodeAbi must be boolean value. For Byte code of transaction, use encodeAbi: true

This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

matic.processExits('0xabcd...789', {
  from: '0xABc578455...',
})

---

WithdrawManager

matic.withdrawManager.startExitForMintableBurntToken(burnTxHash, predicate: address, options)

/**
  * Start an exit for a token that was minted and burnt on the side chain
  * Wrapper over contract call: MintableERC721Predicate.startExitForMintableBurntToken
  * @param burnTxHash Hash of the burn transaction on Matic
  * @param predicate address of MintableERC721Predicate
  */

See MintableERC721Predicate.startExitForMintableBurntToken

const burn = await this.maticClient.startWithdrawForNFT(childErc721.address, tokenId)
await this.maticClient.withdrawManager.startExitForMintableBurntToken(burn.transactionHash, predicate.address)

---

matic.withdrawManager.startExitForMintableBurntToken(burnTxHash, predicate: address, options)

/**
  * Start an exit for a token with metadata (token uri) that was minted and burnt on the side chain
  * Wrapper over contract call: MintableERC721Predicate.startExitForMetadataMintableBurntToken
  * @param burnTxHash Hash of the burn transaction on Matic
  * @param predicate address of MintableERC721Predicate
  */

See MintableERC721Predicate.startExitForMetadataMintableBurntToken

const burn = await this.maticClient.startWithdrawForNFT(childErc721.address, tokenId)
await this.maticClient.withdrawManager.startExitForMetadataMintableBurntToken(burn.transactionHash, predicate.address)

---

POS Portal

maticPOSClient.approveERC20ForDeposit(rootToken, amount, options)

Approves given amount of rootToken to POS Portal contract.

• rootToken must be valid ERC20 token address
• amount must be token amount in wei (string, not in Number)
• options see more infomation here
  • encodeAbi must be boolean value. For Byte code of transaction, use encodeAbi: true

This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

maticPOSClient.approveERC20ForDeposit('0x718Ca123...', '1000000000000000000', {
  from: '0xABc578455...',
})

---

maticPOSClient.depositERC20ForUser(rootToken, user, amount, options)

Deposit given amount of rootToken for user via POS Portal.

• rootToken must be valid ERC20 token address
• user must be valid account address
• amount must be token amount in wei (string, not in Number)
• options see more infomation here
  • encodeAbi must be boolean value. For Byte code of transaction, use encodeAbi: true

The given amount must be approved for deposit beforehand. This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

const user = <your-address> or <any-account-address>

maticPOSClient.depositERC20ForUser('0x718Ca123...', user, '1000000000000000000', {
  from: '0xABc578455...'
})

---

maticPOSClient.depositEtherForUser(rootToken, user, amount, options)

Deposit given amount of ETH for user via POS Portal. ETH is an ERC20 token on Matic chain, follow ERC20 burn and exit to withdraw it.

• user must be valid account address
• amount must be ETH amount in wei (string, not in Number)
• options see more infomation here
  • encodeAbi must be boolean value. For Byte code of transaction, use encodeAbi: true

This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

const user = <your-address> or <any-account-address>

maticPOSClient.depositEtherForUser(user, '1000000000000000000', {
  from: '0xABc578455...'
})

---

maticPOSClient.burnERC20(childToken, amount, options)

Burn given amount of childToken to be exited from POS Portal.

• childToken must be valid ERC20 token address
• amount must be token amount in wei (string, not in Number)
• options see more infomation here
  • encodeAbi must be boolean value. For Byte code of transaction, use encodeAbi: true

This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

maticPOSClient.burnERC20('0x718Ca123...', '1000000000000000000', {
  from: '0xABc578455...',
})

---

maticPOSClient.exitERC20(burnTxHash, options)

Exit tokens from POS Portal. This can be called after checkpoint has been submitted for the block containing burn tx.

• burnTxHash must be valid tx hash for token burn using burnERC20.
• options see more infomation here

This returns Promise object, which will be fulfilled when transaction gets confirmed (when receipt is generated).

Example:

maticPOSClient.exitERC20('0xabcd...789', {
  from: '0xABc578455...',
})

---

Support

Please write to [e-mail] for integration support. If you have any queries, feedback or feature requests, feel free to reach out to us on telegram: t.me/maticnetwork

License

MIT