funded

Cardanoscan API Javascript SDK

₳15,360.00 Received
₳64,000.00 Requested
Ideascale logo View on ideascale
Community Review Results (1 reviewers)
Impact Alignment
Feasibility
Value for money
Solution

Build a dev-friendly javascript SDK for Cardanoscan APIs. The SDK provides easy-to-use functions to retrieve data from Cardanoscan APIs.

Problem:

Developers need an easy-to-use SDK to be used in their dApps to connect to Cardanoscan APIs. It is time-consuming and a pain to manually work with APIs.

Yes Votes:
₳ 324,821,359
No Votes:
Votes Cast:
635

This proposal was approved and funded by the Cardano Community via Project F11: Cardano Open: Developers - technical Catalyst funding round.

[SOLUTION] Please describe your proposed solution.

We are solving the issue of the exhaustive time developers spend working with APIs and maintaining them. We are proposing to build a javascript SDK that will improve the experience of developers working with Cardanoscan APIs.

An SDK is a library that combines the Cardanoscan APIs into a single npm package which can be installed by developers into their dApps and UI projects. The SDK can also be utilised in the backend codebase.

Developers then can provide their API Key and start fetching Cardano data from the Cardanoscan APIs using easy-to-use functions made available as part of the SDK without configuring the APIs or without worrying about updating their updates.

[IMPACT] Please define the positive impact your project will have on the wider Cardano community.

The ecosystem thrives when there is an increased developer activity. This SDK will help developers build their apps faster and provide an easy entry point for working with Cardano. Thus bringing more developers or increasing the developer activity.

The success of the project can be measured by looking at the GitHub stars of the SDK repository. The addition will have both short-term and long-term implications, encouraging innovation, drawing additional developers to the ecosystem, and adding to Cardano's overall growth and productivity. While the metrics may not be simply based on numerical indicators, positive developer feedback will serve as a qualitative indicator of the project's success.

[CAPABILITY & FEASIBILITY] What is your capability to deliver your project with high levels of trust and accountability? How do you intend to validate if your approach is feasible?

We have a proven track record of successfully completing projects while maintaining high levels of trust and accountability. Since the beginning of the Shelley period, our team has been actively participating in the Cardano ecosystem, and we have successfully developed and maintained Cardanoscan, a widely used Cardano explorer.

In addition to Cardanoscan, we created Typhon Wallet, a highly recognised and user-friendly wallet that has received widespread acclaim from the Cardano community. This wallet is a direct result of our involvement in the Catalyst programme, which demonstrates our dedication to innovation and providing important community solutions.

We have also worked and delivered the Cardano ADA, Native tokens, and ADA Staking integration within Ledger Live bringing the mass userbase of Ledger to Cardano and providing a safe and secure custodial wallet solution to the community.

Furthermore, we have contributed to the Cardano ecosystem through a number of open-source libraries, which can be found on our GitHub repository (https://github.com/StricaHQ). These libraries represent our commitment to providing developers with dependable tools and resources that conform to high-quality and transparent requirements.

Our experience, knowledge, and positive feedback from the community attest to our ability to deliver projects with a strong emphasis on integrity and responsibility. We intend to uphold these values throughout the course of our implementation.

[Project Milestones] What are the key milestones you need to achieve in order to complete your project successfully?

Add support for 4 APIs as below,

-> APIs (Address, Asset, Block, Network)

-> Authentication support

Acceptance Criteria - Provide a GitHub PR showing the work for these features

>Add support for 3 APIs as below,

-> APIs (Pool, Reward Account, Transaction)

Acceptance Criteria - Provide a GitHub PR showing the work for these features

>Final Milestone

-> Release the SDK on NPM

-> Close out report and demo video

Acceptance Criteria - close out report and video provided, SDK released on npm

[RESOURCES] Who is in the project team and what are their roles?

Ashish Prajapati (Project Lead)

https://twitter.com/ashisherc

Pavan Vora (Lead Engineer)

https://twitter.com/pavan_vora

[BUDGET & COSTS] Please provide a cost breakdown of the proposed work and resources.

Total Dev Months - 4 Months

Efforts - open source project setup, API Integration (SDK coding), Testing

2 Devs -> 32,000 ADA x 2 = 64,000

[VALUE FOR MONEY] How does the cost of the project represent value for money for the Cardano ecosystem?

The cost of the project represents value for money for the Cardano ecosystem in several ways. Firstly, by building open-source SDKs like Cardanoscan APIs SDK, we are providing valuable resources that developers can freely utilize, enhancing their ability to create innovative applications on the Cardano blockchain. This supports the growth and expansion of the Cardano ecosystem by fostering a larger developer community and attracting more projects.

The costs of the project have been determined based on developer fees and the resources required to deliver the proposed features and maintain the library. The value for money is demonstrated by the positive impact and benefits that the project brings to the Cardano ecosystem. Providing speedy development experience and user-friendly SDK interface.

Community Reviews (1)

Comments

Monthly Reports

close

Playlist

  • EP2: epoch_length

    Authored by: Darlington Kofa

    3m 24s
    Darlington Kofa
  • EP1: 'd' parameter

    Authored by: Darlington Kofa

    4m 3s
    Darlington Kofa
  • EP3: key_deposit

    Authored by: Darlington Kofa

    3m 48s
    Darlington Kofa
  • EP4: epoch_no

    Authored by: Darlington Kofa

    2m 16s
    Darlington Kofa
  • EP5: max_block_size

    Authored by: Darlington Kofa

    3m 14s
    Darlington Kofa
  • EP6: pool_deposit

    Authored by: Darlington Kofa

    3m 19s
    Darlington Kofa
  • EP7: max_tx_size

    Authored by: Darlington Kofa

    4m 59s
    Darlington Kofa
0:00
/
~0:00