Giter Club home page Giter Club logo

near-enhanced-api-server's Introduction

NEAR Enhanced API

API for providing useful information about NEAR blockchain.
Still under heavy development.

Phase 1 goals: [development goes here now]

  • Provide NEAR balances information, recent history
  • Provide FT balances information, recent FT coin history for the contracts implementing Events NEP
  • Provide NFT information and recent history for the contracts implementing Events NEP
  • Provide corresponding Metadata for FT, NFT contracts, NFT items
  • [aspirational] Collect usage statistics which could help us to prioritize next steps

Note, Phase 1 will not provide pagination through all the history.
Phase 1 also does not provide the information about contracts which are not upgraded to Events NEP.

If you are interested in a more detailed development status, use git clone and search for TODO PHASE 1.
See also our thoughts about the proposed DB design which will help us to achieve Phase 2 goals.

Future plans. Phase 2 goals:

  • Provide pagination for all existing endpoints where applicable
  • Support contracts which are not upgraded to Events NEP, such as wrap.near, aurora
  • Add reconciliation logic
  • [aspirational] Show data from failed receipts in the history
  • [aspirational] Support MT contracts
  • [aspirational] Support of querying the balance/history info by symbol (e.g. GET "/accounts/{account_id}/coins/USN")

Future plans. Phase 3+ goals:

  • Make wrappers around existing RPC endpoints for the general blockchain info (blocks, chunks, transactions, etc.)

How to run it yourself

You need to create .env file with 3 variables: DATABASE_URL, DATABASE_URL_BALANCES, RPC_URL.
DATABASE_URL_BALANCES is a temp solution with the new table, it's under development.

All the other stuff is super standard for Rust world.
To modify and then review tests, use cargo insta review.

near-enhanced-api-server's People

Contributors

frol avatar neeeekitos avatar telezhnaya 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.