funded

JSON API service for developers

$20,800.00 Received
$26,000.00 Requested
Ideascale logo View on ideascale
Community Review Results (1 reviewers)
Addresses Challenge
Feasibility
Auditability
Solution

We want to provide developers with fast API access to blockchain data without having to run a full blockchain search platform

Problem:

Cardano Blockchain adoption and size increase has resulted in blockchain data search and access require larger and larger servers

Yes Votes:
₳ 138,763,150
No Votes:
₳ 7,171,047
Votes Cast:
1051

This proposal was approved and funded by the Cardano Community via Project F8: Developer Ecosystem Catalyst funding round.

  • download
  • download

[IMPACT]

We already have a platform we call Cardano Blockchain Intelligence (https://bi.stakepoolcentral.com) to enable users to manually search for Cardano metadata messages and browsing the different data types. The platform has even been called the "Google of Cardano Metadata".

Since going live, we have experienced first hand how the platform needs increasingly more computing power to deliver fast data access. This is why we proposed some enhancements in Catalyst Fund6 to enhance both functionality and response time.

Now that this proposal has been delivered successfully, we want to address the need for developers to also have this access. Our site has been designed to provide data access for users wanting to browse blockchain data manually. Developers need access to data without having to cope with possible user interface changes breaking their search. We want to add JSON api for our site data, so developers can search the blockchain using our already running platform

Access to blockchain data requires more and more computing resources. Increased requirements for computing resources, means increased cost for developers wanting fast and reliable access to Cardano data. During the months and years since Cardano Shelley mainnet, the requirements have increased dramatically and is no longer affordable and available for everyone. We want to expand our running Blockchain Intelligence site with a JSON api to make our fast search engine available to developers without each having to run their own Cardano search platform.

JSON is an established standard developers use when communicating and querying data from sites. The beauty of providing JSON API to developers is that the site user interface can change without breaking the functionality developers already use.

We do not foresee any difficulties regarding the project delivery. The api will be developed using established technology and standards.

[FEASIBILITY]

We project mainnet delivery of the API within 3 months of successful funding by Catalyst community.

This is our projected timeline

May 2022

June and July 2022

We budget to deliver 6 calls in this proposal. The exact calls will decided when detailed specification is ready and we will connect with community developers to get suggestions for most wanted ones. The following are our suggestions at this point.

  • metadata full text search
  • get all metadata messages of specific transaction
  • NFT / token full text search
  • Verification for data signatures
  • proof of donation
  • get oracle data, current value and historic data by oracle symbol

Budget breakdown

  • Detailed specification and solution design - 3k
  • Development of JSON api (per call) - 2k and documentation (1k per call): <u>Total 18k</u>
  • Buffer for maintenance and change requests after go-live - 5k

Budget summarized: 26k

Our team already has the experience needed to deliver this new API. We have successfully maintained and developed the Blockchain Intelligence site (https://bi.stakepoolcentral.com) since October 2020

[AUDITABILITY]

Our test site (https://bi-testnet.stakepoolcentral.com) will always be running the latest development version of the API. This give developers early access to the api so they can test their solutions with testnet blockchain data.

We will also send bi-weekly updates to the Catalyst community reporting the current status of the deliverables. This report will be available for the Community in accordance with Catalyst status report governance.

Today we provide fast and easy access to search and browse Cardano blockchain data. This data is not as easy accessible to developers as and this is what we want enhanced this time. This project is successful when developers can use our search results in their own solutions.

This proposal is a continuation of our Fund6 funded and delivered proposal Metadata search engine enhancements (<https://cardano.ideascale.com/a/dtd/368588-48088>). The community voted for functionality and response time enhancements in our solution. These enhancements are now available to the public on our site https://bi.stakepoolcentral.com, and with this new proposal we now want to make the enhancements available also for developers

Community Reviews (1)

Comments

Monthly Reports

Nothing to share at this time

Disbursed to Date
$20,800
Status
Still in progress
Completion Target
7/31/2022
Comments 0

Login or Register to leave a comment!

Nothing more to add in addition to the already shared documentation

Disbursed to Date
$20,800
Status
Still in progress
Completion Target
7/31/2022
Attachment(s)
Comments 0

Login or Register to leave a comment!

No

Disbursed to Date
$20,800
Status
Still in progress
Completion Target
1. In the next month
Attachment(s)
Comments 0

Login or Register to leave a comment!

Nothing in addition to the project status report

Disbursed to Date
$20,800
Status
Still in progress
Completion Target
1. In the next month
Attachment(s)
Comments 0

Login or Register to leave a comment!

We have done some development the last month even though preparations for Vasil hard-fork and other NFT Guild activities has taken most of our time. The developed solution is what we are now planning to convert to web calls and publish the coming month

Disbursed to Date
$20,800
Status
Still in progress
Completion Target
1. In the next month
Comments 0

Login or Register to leave a comment!

We have developed some new API calls and are currently debugging these and creating more in our testnet environment. More details can be found in our monthly status report which is linked to this form.

Disbursed to Date
$20,800
Status
Still in progress
Completion Target
2. In the next 3 months
Comments 0

Login or Register to leave a comment!

close

Playlist

  • EP2: epoch_length

    Authored by: Darlington Kofa

    d. 3 se. 24
    Darlington Kofa
  • EP1: 'd' parameter

    Authored by: Darlington Kofa

    d. 4 se. 3
    Darlington Kofa
  • EP3: key_deposit

    Authored by: Darlington Kofa

    d. 3 se. 48
    Darlington Kofa
  • EP4: epoch_no

    Authored by: Darlington Kofa

    d. 2 se. 16
    Darlington Kofa
  • EP5: max_block_size

    Authored by: Darlington Kofa

    d. 3 se. 14
    Darlington Kofa
  • EP6: pool_deposit

    Authored by: Darlington Kofa

    d. 3 se. 19
    Darlington Kofa
  • EP7: max_tx_size

    Authored by: Darlington Kofa

    d. 4 se. 59
    Darlington Kofa
0:00
/
~0:00