Please describe your proposed solution.
Solution
Sense is designed to automatically parse the methods of a smart contract from one or several files and provide a clear explanation to end-users who may not be advanced developers. This explanation includes the functionality of the contract, how it works, and any security considerations that have been incorporated into the functionality. This proposal is to expand the tool that already works for solidity contracts to also include Plutus.
Description
Moreover, there are 4 steps that lead us from the proposed problem to the solution
Step 1: Input
Initially, we require the user to give us the address to the smart contract which she likes to analyze. Using the address our system will fetch the corresponding contract and all related contracts. It is also possible to upload the files directly to the system. Additionally, The user can specify which methods she’d like to understand better.
Step 2: Code aggregation and pre-processing
pre-processing can remove any redundant and malicious lines (for example malicious comments), resulting in an optimal code for generating the description
Step 3: Prompt generation
Artificial Intelligence has become the centerpiece of the current decade. Furthermore, the art of prompt engineering is crucial to get optimal results. Sense not only generates an optimal version of the code but it creates segmented structured prompts enhanced for AI models.
Step 4: Result
Lastly, Sense uses the latest state-of-the-art AI models such as OpenAI's GPT models to get comprehensive descriptions of the specified methods.
The user can benefit from this system through 2 different yet simple procedures. First and foremost is our website, users can simply enter their input and enjoy the results. Second to that, is our API, which empowers different applications to provide comprehensive descriptions to their users to further help them understand how a method works, what are the consequences of it, and how secure the action they are taking.
Rational
Blockchain has been one of the fastest-growing subjects in the past few years. Although the development of new tools and libraries has been immense, the community is severely suffering from a lack of documentation and knowledge generalization. Sense can help a wide spectrum of users from non-technical users wanting to ack knowingly to professional developers aiming to learn an overview of a complex project not to mention this tool can prevent lots of missusage and malicious intents just by providing a brief security overview to novices.
How does your proposed solution address the challenge and what benefits will this bring to the Cardano ecosystem?
The "Sense" project aims to significantly lower the barrier to entry for individuals seeking to understand and interact with smart contracts within the Cardano ecosystem. By automatically parsing and explaining smart contract code, the tool is likely to make the ecosystem more accessible and attractive to both non-technical users and developers.
For non-technical users, it can promote wider adoption of Cardano's blockchain technologies by demystifying smart contract functionality. For developers, it can save time in understanding complex smart contract code, allowing them to focus more on innovation and less on deciphering existing contracts. This efficiency could potentially attract more developers to the ecosystem, expanding the breadth and depth of applications built on Cardano.
Moreover, the additional security check features of Sense can contribute to improving the overall security within the Cardano ecosystem. It could reduce the risk of misuse and malicious intent, promoting trust and confidence among the users.
How do you intend to measure the success of your project?
The success of the "Sense" project can be measured through a combination of quantitative and qualitative metrics:
User Engagement: The frequency of use, time spent on the platform, and the number of smart contracts analyzed can indicate the level of user engagement and satisfaction with the tool.
User Satisfaction: User satisfaction surveys can provide direct feedback on the tool's effectiveness and identify areas for improvement.
Developer Feedback: Feedback from developers, including testimonials and reviews, can provide valuable insight into how well the tool meets their needs in understanding or auditing contracts.
User Adoption: The number of users, both individuals and API consumers, using the platform can provide a clear measure of success.
These metrics will provide a comprehensive view of the project's impact, allowing the team to assess success and guide future development.
Please describe your plans to share the outputs and results of your project?
Our team is using an agile methodology in which each team member is required to finish a certain amount of story points during each sprint. our two-week sprints are focused on finalizing user stories rather than developing aimlessly.
To show our commitment and progress throughout the project we can provide our sprint planning which concludes sprint goals, user stories, deliverables, and scope of work. On top of that, we’ll provide bi-weekly progress reports concluding a summary, delivered scope, and upcoming work.
These reports will be publicly available for all interested parties to review.
Moreover, we’re aiming to have at least 1 early adaptor using our APIs by the end of phase one and over 200 users using our platform to further understand smart contracts.