Code Monkey home page Code Monkey logo

hermez-api-rs's Introduction

Idiomatic interface to the Hermez v1 API for Rust.

The Hermez node API is the layer that allows 3rd party apps and services to interface with the node to use the layer two features of the Hermez rollup. Examples of these apps are:

  • Wallet: send L2 transactions, check balance, ...
  • Explorer: List transactions, slots, batches, ...
  • Exchange integrations

Note that some of the interactions with the rollup must be done using the Ethereum network directly. Another way to integrate with the rollup is to deploy a node and connect directly to its PostgreSQL database.

Usage

All access is done though a HermezApi object. Create an instance by calling HermezApi::new() with a valid base URL for the node.

HermezApi provides three URL constants that can be used.

  • MAINNET_URL: Use with Mainnet
  • TESTNET_URL: Use with the Rinkeby test net
  • LOCALHOST_URL: Use with a locally hosted node. Use for unit tests.

Examples

use hermez_api::HermezApi;

let api_test = HermezApi::new(HermezApi::TESTNET_URL).unwrap();
let api_other = HermezApi::new("https://some.other.domain/hermez").unwrap();

Useful Links

API Reference

Hermez Home

hermez-api-rs's People

Contributors

jaypha avatar

Watchers

James Cloos 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.