Git Product home page Git Product logo

agglayer's Introduction

Agglayer

Agglayer is a web service that receives ZKPs from different CDK chains and checks the soundness of them before sending the ZKP to L1 for verification.

To find out more about Polygon, visit the official website.

WARNING: This is a work in progress so architectural changes may happen in the future. The code is still being audited, so please contact the Polygon team if you would like to use it in production.

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • docker
  • docker compose

Usage

Running in local with Docker

Run

make run-docker

Key Signing configuration

  • Install polygon-cli go install github.com/maticnetwork/polygon-cli@latest
  • Create a new signature polygon-cli signer create --kms GCP --gcp-project-id gcp-project --key-id mykey-tmp
  • Install gcloud cli https://cloud.google.com/sdk/docs/install
  • Setup ADC gcloud auth application-default login
  • Configure KMSKeyName in agglayer.toml

Production setup

Currently only one instance of agglayer can be running at the same time, so it should be automatically started in the case of failure using a containerized setup or an OS level service manager/monitoring system.

Installation

  1. Clone the repo
    git clone https://github.com/0xPolygon/agglayer.git
  2. Install Golang dependencies
    go install .

Prerequisites

  • For each CDK chain it's necessary to configure it's corresponding RPC node, synced with the target CDK, this node is for checking the state root after executions of L2 batches.
  • It's recommended to have a durable HA PostgresDB for storage, prefer AWS Aurora Postgres or Cloud SQL for postgres in GCP.

Configuration of agglayer.toml

* Configure `[FullNodeRPCs]` to point to the corresponding L2 full node.
* Configure `[L1]` to point to the corresponding L1 chain.
* Configure the `[DB]` section with the managed database details.

License

Copyright (c) 2024 PT Services DMCC

Licensed under GNU Affero General Public License v3.0 or later (LICENSE)

The SPDX license identifier for this project is AGPL-3.0-or-later.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the AGPL-3.0-or-later, shall be licensed as above, without any additional terms or conditions.

agglayer's People

Contributors

vcastellm avatar rebelartists avatar arnaubennassar avatar stefan-ethernal avatar dependabot[bot] avatar begmaroman avatar christophercampbell avatar goran-ethernal avatar mt-polygon-technology avatar praetoriansentry avatar zuiris avatar nivida avatar rachit77 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.