starknet-io / tokei Goto Github PK

Description

Starkvest - Implement func releasable_amount_all_vestings

Signature :

    func releasable_amount_all_vestings(account: felt) -> (releasable_amount: Uint256) {
    }

Acceptance Criteria

• Impl the function into repo carbonable-starknet
• Impl unit tests

Develop a MVP for Token Vesting with lockup_linear functionality

🔍 Project Overview

Transitioning a token vesting smart contract from Solidity to Cairo. The original contract in Solidity manages token vesting with a lockup_linear feature. Goal: replicate and optimize this functionality in Cairo.

🎯 Objectives

1. Replicate Core Features: Maintain all essential functionalities from the Solidity version.
2. Cairo Optimization: Adapt and optimize for Cairo language features.
3. Maintain Security Standards: High security and robustness in the Cairo implementation.

🔑 Key Features

• Lockup Linear Streams: Implement stream mapping, creation, and management.
• User-Facing Functions: Port functions like getAsset, getCliffTime, etc., to Cairo.
• Internal Logic: Replicate internal logic such as _calculateStreamedAmount, _statusOf, etc.
• Error Handling: Adapt custom error handling.

🧪 Testing and Validation

• Develop comprehensive unit and integration tests.
• Adapt and mirror test cases from Solidity to Cairo.
• Working examples usage with Starknet.js for example

📚 Documentation

• Detailed code comments for clarity.
• Documentation comparing Solidity and Cairo versions.
• Usage instructions and examples.

Description

Upgrade the Cairo language from 0.9 to 0.10.1.

Acceptance Criteria

• Upgraded to Cairo 0.10.1
• Upgraded protostar to 0.7
• Upgraded Github action CI_TEST

@all-contributors please add @abdelhamidbakhta for infrastructure, tests, doc and code

Develop a human interaction interface for Starknet Explorers with LLMs.

🔍 Project Overview
This project seeks to innovate the way users interact with blockchain data on Voyager and StarkScan, the leading explorers for Starknet. The goal is to introduce a solution featuring a chat-like interface or modal that simplifies the blockchain data displayed on these explorers into a more understandable, human-readable format. This initiative aims to make blockchain data like transactions, accounts, addresses, and tokens more accessible and comprehensible to the general public.

🎯 Objectives

• Enhanced Accessibility: Develop a user-friendly interface that overlays on Voyager and StarkScan pages, making blockchain data easier to understand.
• Dynamic Data Interpretation: Utilize algorithms to translate technical blockchain information into simple, human-readable content.
• Interactive Queries: Enable direct user queries for specific blockchain elements through a conversational interface.
• Scalable Solution: Design the system with adaptability in mind, allowing for future expansion to additional blockchain explorers.

🔑 Key Features

• Conversational Interface: Deploy a React-based chat interface accessible on Voyager and StarkScan explorer pages.
• Page Content Analysis: Implement JavaScript logic to dynamically read and interpret the content of blockchain explorer pages.
• Blockchain Jargon Translation: Translate complex blockchain terms and data into easy-to-understand information.
• Interactive Search and Query: Integrate functionality for users to search and inquire about blockchain-related data through the interface.
• Real-time Updates: Ensure the interface reflects real-time data as users navigate and interact with blockchain explorers.

🧪 Testing and Validation

• Conduct comprehensive testing, including unit, integration, and user acceptance tests, to ensure the tool's reliability and user-friendliness.
• Validate the solution's adaptability by testing with Voyager and StarkScan, and plan for compatibility with future explorers.
• Implement user testing sessions to refine usability and functionality based on feedback.

📚 Documentation

• Offer detailed in-line code documentation and a clear explanation of the solution's architecture.
• Provide setup and integration guides for applying the chat interface to Voyager and StarkScan or other scanners.
• Create user documentation with examples to showcase the interface's capabilities and guide users on its effective use.

🔄 Expansion and Future Development

• Initially, the solution will leverage RAG (Retrieval-Augmented Generation) for context understanding and function calling for blockchain data reading.
• Plans to incorporate a fine-tuned open-source model to tailor the solution more closely to blockchain-specific use cases, enhancing privacy, specificity, and knowledge.
• Create a stand-alone Explorer that does a multitude of such operations that translate functionalities from Blockchain jargon/terminology or deep technical aspects into human readable content.

By bridging the gap between complex blockchain data and user understanding, this project aims to democratize access to blockchain insights, fostering greater engagement and knowledge among users. The vision is to create a scalable, adaptable interface that evolves with blockchain technology and user needs.

Description

Frontend for Tokei platform, Token vesting platform written in Cairo.

Creating an interface for every user can:

• create a lockup_linear with the create_with_range function on the Cairo contracts.
• See lockups created
• See lockups can be claimed
• Lockup Data about the waiting time and linear release.

I'm waiting for the PR on the Cairo contract to be merged, and I can start the implementation of the front end after.

Example of UI: https://app.sablier.com

Acceptance Criteria

• Linear lockup
• Data visibility for lockup by sender and recipients.

Additional context

UI Example of Vesting creation:

Description

Refactor library and starkvest file to change the access control (Ownable) check.
The purpose is to be aligned with the latest best practices and expose the library to be upgradable (Proxy) friendly.

Acceptance Criteria

• Implementation in library and starkvest file
• Update tests unitary and integration to check access control into integration tests