Code Monkey home page Code Monkey logo

apollo's Introduction

Apollo ๐Ÿš€

Apollo exists to simplify development of the modular stack. It's a one click deploy local and easily extendable Celestia network.

Getting Started

To deploy from source, clone the repo and install the binary by running:

git clone https://github.com/cmwaters/apollo.git && cd apollo
go run cmd/apollo.go

Go to http://localhost:8080 to view the control panel. This will show which services are running along with the URLs

apollo control panel

Base Services

The cli tool comes with four services built-in Consensus Node, Bridge Node, Light Node, and Faucet. With these alone you can easily fund your sequencer and deploy your rollup, using the light client to verify the blobs as they are published.

Faucet

The binary comes with a faucet for easily funding accounts. By default it will be hosted at http://localhost:1095. You can use the API by sending a GET request to http://localhost:1095/fund/<your_celestia_address>

faucet web page

REST API

  • /fund/<celestia_address>: Funds the listed celestia address returning the transaction hash if successful or an error
  • /status: Returns the status of the faucet, including the faucet account and any configurations

Adding Services

The atomic unit of this development kit is a service. It can be seen as an arbitrary process that requires certain inputs denoted as endpoints and providing certain outputs also in the form of endpoints. These are predominantly used as the ports these services will communicate across. These services can be started and stopped.

The CLI uses the Conductor with four out of the box services. To add more, write a wrapper of your service that matches the Service interface. Create your own binary with the standard services and your new service.

Contributing

This repo is still a work in progress. If you would like to improve it or notice a bug, feel free to open an issue or PR.

apollo's People

Contributors

cmwaters avatar rootulp 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.