# @routerprotocol/evm-gateway-contracts

> EVM Gateway Contract

Latest version **1.1.13** (published 2023-05-15) · 0 weekly downloads

## Install

```sh
npm install @routerprotocol/evm-gateway-contracts
pnpm add @routerprotocol/evm-gateway-contracts
yarn add @routerprotocol/evm-gateway-contracts
bun add @routerprotocol/evm-gateway-contracts
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.13 |
| Published | 2023-05-15 |
| First published | 2023-03-16 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 45.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | shivam7828, kunalroute, mynk_s_rwt, mankenavenkatesh5389, joydeep_router, ss-sonic, vatsal.eth, harsh-at-router |
| Keywords | blockchain, ethereum, hardhat, smart-contracts, solidity |

## Links

- npm: https://www.npmjs.com/package/@routerprotocol/evm-gateway-contracts
- npm.io page: https://npm.io/package/@routerprotocol/evm-gateway-contracts

## Dependencies (2)

- [@openzeppelin/contracts](https://npm.io/package/@openzeppelin/contracts.md) ^4.4.1
- [@openzeppelin/contracts-upgradeable](https://npm.io/package/@openzeppelin/contracts-upgradeable.md) ^4.7.3

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.1.13 (latest) — 2023-05-15
- 1.1.12 — 2023-05-13
- 1.1.11 — 2023-04-20
- 1.1.10 — 2023-04-20
- 1.1.9 — 2023-04-20
- 1.1.8 — 2023-04-20
- 1.1.7 — 2023-04-18
- 1.1.6 — 2023-04-13
- 1.1.5 — 2023-04-12
- 1.1.4 — 2023-04-12
- 1.1.3 — 2023-04-12
- 1.1.2 — 2023-04-11
- 1.1.1 — 2023-04-11
- 1.1.0 — 2023-04-11
- 1.0.5 — 2023-03-28
- … 5 more at https://npm.io/package/@routerprotocol/evm-gateway-contracts/versions

## README

# Router EVM Gateway contracts

## Overview

The Router EVM Gateway contract will bridge EVM chains with the Router Chain.
We can deploy this gateway contract on any EVM-compatible chain.
The gateway contract validates all incoming requests coming from the router chain using the
validator set signatures. These signatures should have at-least 2/3 validator power.
The current validator set(valset) can update the validator set to a new valset by invoking the _updateValset_ function.

The Gateway contract has a function iSend to send request to other chains, a function iReceive to receive requests from another chain and iAck to receive acknowledgments back from destination chain.

For more details, please check [here](https://router-chain-docs.vercel.app/develop/message-transfer-via-crosstalk/evm-guides/iDapp-functions).

## Please use the following instruction to setup, test and deploy the project

## Setup

To run any command you need to have .env in your local

```
cd router-gateway-contracts/evm
cp .env.test .env
```

then update the value in .env file.

## Compile Project

```
cd router-gateway-contracts/evm
npm install
npx hardhat compile
```

## Run Tests

Use the following commands to run the test cases:

```
npx hardhat test
```

## Deploy Gateway Contract on live network

```
cd router-gateway-contracts/evm
npx hardhat deploy:Gateway --network <network> --chaintype <chainType> --valsetnonce <valsetNonce> --validators <validators> --powers <powers>
```

## Upgrade Gateway Contract on live network

```
cd router-gateway-contracts/evm
npx hardhat upgrade:Gateway --network <network>
```

## Verify GateWay Contract on a network

```
cd router-gateway-contracts/evm
npx hardhat verify --constructor-args <args-file-path> <gateway-contract-address> --network <network-name>
```

Example:-

```
npx hardhat verify --constructor-args scripts/arguments.js 0x610aEe9387488398c25Aca6aDFBac662177DB24D --network polygonMumbai
```

## Generate ABIs, BIN and GO bindings of the Gateway Contract

```
cd router-gateway-contracts
npm install
sh scripts/createBinding.sh
```

---
_Source: https://npm.io/package/@routerprotocol/evm-gateway-contracts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._