Giter VIP home page Giter VIP logo

spark-gov-relay's Introduction

🏛️⚡️ Spark Gov Relay 🏛️⚡️

This repository contains infrastructure necessary to process cross-chain execution of governance proposals.

The codebase uses Foundry as the development framework. In order to run tests, deploy contracts, or perform other operations, use standard Foundry commands.

⚙️ Components

🚦 Executors

Executors serve as admins of the bridged domain instances of the protocol.
They are responsible for storying the queue of proposals passed from the host domain governance and their execution.
They manage bridged domain protocol instance using standard payload pattern.

✍️ Architecture Diagram

Architecture Diagram

🤝 Contribution Guidelines

In order to add governance relay infrastructure for a new domain, perform the following steps:

  1. Go to XChain Helpers repository and add:
    1. A domain helper abstracting away the process of passing messages between host domain and your bridged domain.
    2. A helper function to the XChainForwarders library abstracting away host domain interactions with the bridge.
  2. Add BridgeExecutor to the /src/executors directory. Follow currently used naming convention.
  3. Add a new test file for your domain to the /test directory. Inherit CrosschainTestBase and add tests specific to your domain to the test suite. All of the tests have to pass. Follow linting and naming convention used in other test files.
  4. Use proper labeling for your open PR (always set adequate priority and status)
  5. Get an approving review from at least one of three designated reviewers - @hexonaut, @lucas-manuel or @barrutko
  6. Enjoy governance messages being passed through the bridge to your domain! 🎉

The IP in this repository was assigned to Mars SPC Limited in respect of the MarsOne SP

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.