Giter Club home page Giter Club logo

bridge-api's Introduction

Bridge API

The bridge API is a REST API for fetching proofs from Avail's Kate RPC and Succinct API to submit on Ethereum or any off-chain proof verification.

Deploying the bridge API

  • Create an .env file according to the .env.example
  • To build the service:
# for developing, make a debug build
cargo build
# and run it!
cargo run
  • Or instead, make release builds for production:
cargo run --release
# you can use maxperf to optimize for runtime performance:
cargo run --profile maxperf
# you can use RUSTFLAGS to use CPU-native optimizations:
RUSTFLAGS="-C target-cpu=native" cargo run --profile maxperf

Usage

  • The bridge API operates on the 8080 port by default (can be configured).
  • To verify that the API is live, you can query the root like:
# curl <endpoint URL>
curl http://localhost:8080
# should return:
# {"name":"Avail Bridge API"}
  • To generate a proof, simply query the /proof endpoint with the block hash and extrinsic index like (both are required):
# curl "<endpoint URL>/proof/<blockhash>?index=<tx_index>"
curl "http://localhost:8080/proof/0x021134e8a6c9eebefce062d19db3a0cbca0eacb8bd44d6a6cd19cc39d2e6c02b?index=2"

bridge-api's People

Contributors

qedk avatar

Stargazers

Vavax 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.