(RFP): SoftSDK_v1 Development

Governance
1

SDK proposal
SDK proposal1920×960 146 KB

Introduction

The DAO is looking for an easy way to facilitate third-party develop on Soft DAO contracts whereby anyone can use the SOFT SDK to launch a sale or distribute tokens.

The DAO is seeking proposals for the development of SoftSDK_v1, an SDK designed to integrate with sale/distribution contracts which can be found here: GitHub - SoftDAO/contracts

This SDK will serve as a foundational tool to simplify the complexities of token sales/launches and distributions, as well as deploying contracts, configuring airdrops, and claiming tokens across multiple EVM-compatible chains.

Project Overview

The SoftSDK_v1 aims to:

  • Provide Multi-Chain Support for seamless interaction across various EVM-compatible chains.
  • Simplify Deployment of sale and distribution contracts.
  • Streamline Airdrop Setup for admins, including eligibility, token quantities, domains, and vesting schedules.
  • Enable easy Token Claims for beneficiaries through various methods.
  • Include comprehensive Testing and Documentation for all functionalities.

Scope of Work

The selected developer(s) will be responsible for:

  • Ensuring developer-friendly interaction and implementation across various EVM compatible chains.
  • Developing functionalities for deploying contracts, launching token sales, configuring airdrops, and claiming tokens.
  • Ensuring the SDK’s modular architecture for easy maintenance and extension.
  • Conducting rigorous unit testing to ensure the SDK’s reliability and stability.
  • Creating a comprehensive documentation website to assist developers in utilizing the SDK.

Deliverables

  • A fully functional SoftSDK_v1 that meets the outlined features.
  • A documentation website with a quick start guide, installation instructions, and usage examples.
  • Complete unit test coverage for all core functionalities and exposed classes.

Budget and Timeline

  • Total Project Cost: TBD based on proposal duration and SDK accompanying features
  • Project Duration: 1-2 Months, accounting for unexpected developments or additional iterations.

Proposal Requirements

Interested parties should submit a proposal including:

  • Background and experience in blockchain SDK development.
  • Proposed approach and methodology.
  • Detailed timeline with milestones.
  • Breakdown of costs and payment terms.
  • Examples of previous similar projects.

Evaluation Criteria

Proposals will be evaluated based on:

  • Demonstrated experience and technical capability in blockchain technology and SDK development.
  • Clarity and completeness of the proposal.
  • Feasibility of the proposed timeline and budget.
  • Previous work and references.

Submission Instructions

Proposals should be submitted as a Proposal as well as a reply to this RFP by March 4th, 2024. Please ensure your proposal includes all required information and adheres to the submission guidelines.

For further information or clarification contact the team in the channel reserved for SDK support which can be found here: The Soft DAO

Participation

We encourage all interested developers and teams with experience in blockchain development and a passion for advancing the web3 ecosystem to submit their proposals. This is an opportunity to contribute to a foundational project within the Soft DAO, aimed at enhancing accessibility and innovation in the decentralized space.

9 Likes
2

Its not clear what language the SDK should be in. Perhaps it should be in the most popular language for smart contract developers, not sure whether that is rust or typescript atm.

4 Likes
3

Great initiative! From my side, I’d like to point out that adding an expanded description of the concept of SDK and its functionalities would be interesting and beneficial for the community : )

3 Likes
4

its good yes, you are moving ahead, but im confused-
What exactly mean SDK?
How long will it take for integration?
what about benefits?

4 Likes
5

SDK = Software Development Kit

5 Likes
6

Governance Proposal: Cross-Chain Distributor SDK

Executive Summary

This proposal introduces the Cross-Chain Distributor SDK, a comprehensive toolkit designed to revolutionize the way airdrops and token claims are managed across multiple blockchain networks. It aims to drastically reduce the technical barriers for protocol interaction, fostering innovation and broader access to decentralized finance (DeFi) opportunities.

Detailed Overview

Background and Rationale

The decentralized ecosystem’s expansion has accentuated the need for seamless interoperability and user-friendly tools for cross-chain transactions. The Cross-Chain Distributor SDK addresses this by offering an integrated solution to deploy, manage, and participate in token distributions across various chains, leveraging the capabilities of Satellite.sol and CrosschainTrancheVestingMerkle.sol contracts.

SDK Components and Features

  • Unified Interface: Simplifies interactions with blockchain contracts, enhancing user experience and developer productivity.
  • Contract Deployment Tools: Streamlines the process of deploying Satellite.sol and CrosschainTrancheVestingMerkle.sol contracts, making them accessible to a wider audience.
  • Airdrop Configuration and Management: Provides customizable templates and management tools for airdrop campaigns, reducing the operational complexity.
  • Cross-Chain Token Claiming: Facilitates a user-friendly process for claiming tokens on different chains, improving accessibility for non-technical users.
  • Comprehensive Documentation: Offers detailed guides and examples, enabling developers to leverage the SDK’s full potential.

High-Level SDK Workflow

  1. Initialization: Developers initiate the SDK, selecting the target chains and configuring the necessary contracts.
  2. Deployment: The SDK simplifies contract deployment, abstracting away the complexities of interacting with smart contracts.
  3. Airdrop Setup: Developers can configure airdrops, specifying distribution parameters and schedules through the SDK’s interfaces.
  4. Claim Process: Users interact with a straightforward interface to claim tokens, supported by the SDK’s cross-chain capabilities.

Benefits

  • Enhanced Creativity: By lowering technical barriers, the SDK empowers developers to innovate and explore new use cases for airdrops and token distribution.
  • Increased Access: Makes the protocol more accessible, encouraging wider participation and adoption in the DeFi ecosystem.
  • Reduced Friction: Streamlines complex processes, enhancing the overall user experience for both developers and end-users.

Development Plan, Budget, and Timeline

The development of the Cross-Chain Distributor SDK is projected to take 3 weeks, with a budget allocation of $18,000. This includes development, testing, and documentation website.

SDK Architecture Overview

Below is a conceptual UML diagram illustrating the SDK’s architecture and its interaction with the Satellite.sol and CrosschainTrancheVestingMerkle.sol contracts.

[SDK User Interface] --> [SDK Core]
[SDK Core] --> [Contract Deployment Module]
[Contract Deployment Module] --> [Satellite.sol]
[Contract Deployment Module] --> [CrosschainTrancheVestingMerkle.sol]
[SDK Core] --> [Airdrop Management Module]
[SDK Core] --> [Token Claiming Module]
[Airdrop Management Module] <--> [Token Distribution Logic]
[Token Claiming Module] <--> [Cross-Chain Communication]

This UML diagram serves as a high-level representation of how the SDK facilitates interaction with the underlying contracts, streamlining the process of deploying and managing cross-chain airdrops and token claims.

Milestones

  • Milestone 1:
    • SDK Initialization and Core Architecture (20% of total remuneration).
    • Completion of the SDK setup with the ability to select target chains.
      Establishment of the core architecture and interfaces based on the UML diagram.
  • Milestone 2:
    • Contract Deployment and Airdrop Configuration (20%)
    • Completion of the Contract Deployment Module, facilitating easy deployment of Satellite.sol and CrosschainTrancheVestingMerkle.sol contracts.
    • Development of the Airdrop Configuration Module to enable project owners to set up airdrops with custom parameters.
  • Milestone 3:
    • Cross-Chain Functionality and Token Claiming Process (20%)
    • Implementation of cross-chain communication capabilities that support token claims across different blockchains.
    • Development of the Token Claiming Module with a user-friendly interface for claiming tokens.
  • Milestone 4:
    • Comprehensive Documentation and User Guides (20%)
    • Creation of detailed documentation, guides, and examples that help developers understand and leverage the SDK’s full potential.
    • Provision of clear examples and operational guides based on the SDK’s architecture and workflow.
  • Milestone 5:
    • Final Testing, Bug Fixes, and Optimization (15-20%)
    • Conducting a final thorough testing phase across different scenarios to ensure all components work harmoniously.
    • Refinement of the SDK for performance, security, and user experience.
    • Successful launch of the SDK.
    • Provision of post-launch support to address any immediate issues, gather user feedback, and confirm the stability of the SDK.

Conclusion

The Cross-Chain Distributor SDK represents a significant leap forward in making cross-chain functionalities more accessible and user-friendly. By approving this proposal, the community will enable a new wave of innovation and participation, strengthening the ecosystem’s foundation and fostering a more interconnected DeFi landscape.

This enhanced proposal includes a detailed overview, highlighting the SDK’s features, benefits, and a simplified UML diagram to illustrate the architecture. You can further refine the UML diagram based on the specific technical architecture of the SDK.

5 Likes
7

Thank you for your insightful question regarding the programming language for the SDK. The choice of language is crucial for accessibility and developer adoption.

  • Currently, Solidity is the predominant language for Ethereum smart contract development. However, for an SDK that interfaces with smart contracts, TypeScript is widely preferred due to its robust ecosystem, type safety, and its popularity in the web3 development community.
  • TypeScript, being a superset of JavaScript, aligns well with the tools and libraries commonly used in this space.
  • This choice aims to maximize developer convenience and ease of integration with existing systems.
4 Likes
8

I appreciate your curiosity and eagerness to understand more about the SDK. SDK stands for Software Development Kit.

It’s essentially a collection of tools, libraries, documentation, code samples, processes, and guides that enable developers to create software applications more efficiently.

In the context of this RFP, the Cross-Chain Distributor SDK will provide tools and resources for developers to manage and deploy airdrops and token claims across multiple blockchains easily.

  • Integration time: SDK is designed to be as user-friendly and straightforward as possible. For a developer already familiar with blockchain and smart contract development, integrating the SoftSDK into their existing system should take a few days to a week, depending on the complexity of their project. This includes setting up, configuring airdrops, and testing. Comprehensive documentation and support will further aid in this process.

  • The primary benefits of using this SDK include significantly reduced development time, lower chances of errors, and the ability to focus more on the strategic aspects of airdrop campaigns rather than the technical complexities.

4 Likes
9

Maybe I missed something, but does our DAO have a GitHub page?

2 Likes
10

Yep here’s the link: SOFT · GitHub

3 Likes
11
2 Likes