Context of the Problem
Cardano developers approach Charli3 everyday asking for data-feeds, but most do not have any idea what’s involved in setting up a feed, where to start, and even what questions to ask – the process of integrating off-chain data feeds to a Cardano DApp is shrouded in mystery.
Building on an established solution:
Charli3 already has an audited MVP of our Decentralized Oracle Ecosystem Solution. Our core service is launching and managing an ecosystem of data providers, node operators, our proprietary software and on-chain consensus solution to enable the consumption of accurate, secure, and trusted off-chain data by Cardano smart contracts. We were the very first project to pass the IOHK Audit Certification Program; we were awarded level 2 certification from CertiK.
This proposal goes beyond our core service to create a publicly accessible environment for Cardano DApp creators to easily integrate our off-chain data feeds, including the free oracle community data feeds recently awarded funding in Fund7 (<https://cardano.ideascale.com/c/idea/384686>).
Our Proposed Solution: Oracle Developer Portal
The Oracle Developer Portal breaks down into two main components.
Firstly, the “Developer Portal” itself will contain everything you’ll need to integrate a data feed into your DApp and test it. This includes a SDK with technical documentation along with substantial FAQs, guides, developer resources, and community links to get support. The main deliverable will be the SDK and accompanying documentation. However, there is more the portal than just the SDK… we intend to create educational resources so developers can self-service. Below is a list of deliverables for the Developer Portal – also please view the attached mock-up designs to view our vision.
- SDK (to integrate Charli3 off-chain data feeds)
- Documentation
- Technical SDK Documentation
- How Charli3 Works
- Downloading The Testbed
- Your First Contract
- Configure Your Feed
- Feed Characteristics
- Custom Feeds
- And More…
- Resources for Support
- Videos
- Links to community forums etc.
- And more…
Secondly, the “Node/Feed Portal” will contain live feeds from our ecosystem showing what available data feeds there are for developers, roughly the costs, and we will include a fee estimator. The purpose of this section is for developers to quickly see what data is available, decide on what they will use in their own solution. Again, here is a list of the key deliverables
- List of available feeds, live nodes, costs, and more (these feeds will be pulled from our ecosystem and updated frequently; this is probably the most complex part of our solution requiring the most amount of development work)
- Fee estimator (New-feed-explorer that lets a user specify data source, update interval and node count, and get a price estimate (along with documentation about how to choose those variables intelligently)
- Documentation for developers building DApps as well as node operators
- How Charli3 Nodes operate
- Node Requirements
- Downloading
- Configuration
- And more…
Please find attached to this proposal 4 mock-ups of our vision of the user-experience (2 for the developer portal and 2 for the Node/Feed Portal. Also, here is medium article link where we will likely update mock-ups as we get closer to voting and/or add more details to the proposal: <https://oraclecharli3.medium.com/catalyst-fund-8-74ff2702fe93>
Future roadmap (out of scope of proposal)
- Developer forum
- Dedicated support team
- Account system for setting up profiles
- And more.
<u>Who Benefits?</u>
By significantly reducing the challenge for Cardano developers to integrate off-chain data, more Cardano Dapps will leverage off-chain data in their end-user solution. The impact will be a richer overall experience from the DApps in the Cardano ecosystem. Our vision is to grow an off-chain data feed portal with education, easy access to free/paid feeds, and support for Cardano’s Dapp builders – significantly reducing the barrier to launch.
We understand the goals and main KPIs of this category to be the following:
- Increase overall quality of Cardano DApps in ecosystem
- Increase new viable applications on Cardano
- Attract more users to Cardano
As a Decentralized Oracle solution, Charli3 is not an end-user DApp. Instead, we see ourselves as an essential integration layer that will empower DApp builders. Here are our assumptions and arguments for why funding our proposal will achieve all of the above goals in the category:
<u>Assumptions</u>
A1: not much is currently known on how to integrate off-chain data into Cardano DApps (problem)
A2: the easier it is and the more Cardano developers know how-to integrate off-chain data feeds into their DApps, the more likely they will do so (increase new viable applications)
A3: DApps with off-chain data integrations provide a richer end-user experience (Increase overall quality)
Assumption 4: An ecosystem with a greater number of rich end-user experiences will increase adoption (Attract more users)
<u>Impact</u>
Our solution is designed to educate developers and provide the tools necessary to integrate off-chain data feeds into their DApps. The outcome will be that Cardano Developers will more likely integrate off-chain data and build richer experiences for end-users, which will lead to an increase in adoption of DApps on Cardano as a whole.
Risks
- Uncertain Cardano Development (changes to the PAB or adoption of alternative scaling solutions) could cause the content and SDK to change materially along with refactors needed on our core solution
- Underestimating the amount of Development needed to maintain the portal after it is launched; the proposal covers the cost of launching and maintaining it for only a limited period of time.
- Lack of clarity over completion of project
- Building the Node/Feed Portal + Fee estimator is complex and will require our team to build web-based solutions dependent on getting accurate data from the ecosystem; such a solution requires maintenance and scalability built into the design – if we don't do it properly we risk having inaccurate or unreliable feed information.
- Increasing engagement might be a challenge; not enough engagement can significantly reduce the value
Strategies
- We are adopting the same strategy that we use on our core solution: build a buffer into our development estimates that leave room for refactors. Our strategy is to remain transparent on our progress and need to refactor through our monthly reporting with Catalyst.
- Our team is setting aside a separate internal budget to maintain the developer portal after launch. We consider this proposal as funding the launch, after which the costs of sustainment are on our team.
- A clear definition of done is needed for both the Developer Portal and Node/Feed Portal.
- Developer Portal
- SDK and documentation are done when a user can access the website, download the SDK, find the information to successfully integrate an off-chain data feed into their DApp (or other solution)
- Node/Feed Portal
- The portal is done when;
- A user can view all available nodes/feeds (at least 1) that are updated within the last 24 hours. We obviously want to strive for real-time updates, but this would give us a satisfactory MVP.
- The Fee Estimator functions to return a cost estimate for a data feed that is within 10% of the actual cost.
- A user can access documentation/information that successfully enables them to interpret the available node/feed lists, use the fee estimator successfully, and/or set up as a node operator.
- Our strategy is to overestimate development on this part and dedicate our internal developers along with external contractors to ensure this part of the solution is robust enough to scale with more feeds.
- The Charli3 marketing team will launch a campaign to raise awareness.