Rust icSwagger - #25b

Current Status: Discussion

• Discussion (12/03/2022)
• Ratification
• Open for application
• Assigned
• In Review
• Closed

Forum Link - Discussion

Bounty Details

• Bounty Amount: $5,000 USD of ICP at award date - $5000 USD of ICP Match Available
• ICDevs.org DFINITY Foundation Grant Match Available: $5000 USD of ICP at award time - (For every ICP sent to c637ee6eb27a470765785a8373f061012c1e13379eae8b5d0eb86ee8e94aa80e, ICDevs.org will add $40 USD of ICP at award date to the bounty, up to the first 125 ICP donated, After 125 ICP, donations to the above address will add .25 ICP to this issue and .75 ICP to fund other ICDevs.org initiatives)
• Project Type: Team
• Opened: 09/02/2022
• Time Commitment: Weeks
• Project Type: Library
• Experience Type: Intermediate - Rust;

Description

This framework will allow classic web developers used to using rest-based web services a simple onboarding pathway to use the Internet Computer.

This bounty gives the opportunity to

• learn Rust
• learn about encryption
• learn about authorization
• learn about Swagger
• learn about Code Generation

The icSwagger bounty seeks to streamline the development of IC-based services and make those services accessible to traditional web 2 developers.

The bounty involves building a set of base features that can be iterated and expanded upon in future bounties.

Base features:

• Code generation from a swagger file
• Json to candid mapper
• Base http_request and http_request_upgraded functionality
• Signing function for js
• Signature verification for Rust

Code generation from a swagger file

Given a swagger file, the application should produce a base skeleton of code that can be injected into an actor without overwriting current functionality.

This will likely include:

• Request and response Rust types for each swagger function.
• A handler function that http_request can call to handle the swagger functions. This handler function should call external functions that the user can manipulate without fear of them being overwritten.
• Json to candid mapping functions that unwrap an incoming json body into a comparable candid structure.
• An internal principal to nonce counter that will keep track of max-nonce requests and keep duplicate requests from being processed.

Signature verification for Rust

The body will arrive as json text accompanied by a signature of the request + ulid nonce.

The canister will need to verify the signature matches the body and set a caller based on the derived principal.

Http request handling

Get methods should be handled via http_request while post methods should be upgraded so that they can manipulate the state.

Signing function and examples in js

The code should provide a js library or extension that will allow node.js and js devs the ability to sign their transactions and send them to the server. This should impede the standard swagger workflow as little as possible so that standard swagger tools can be used. Likely signature will need to be a part of each request and the code will need to remove that field for the signature. A stable json sort will need to be used in js and marched in Rust.

To complete this bounty please implement a minimum viable solution for each of these requirements. Once a base end-to-end solution is working for a minimum feature set we can close this bounty and issue another one with additional features, bells, and whistles.

A sample application should be provided(something simple like a wall application that keeps track of different users and their messages will be suitable).

To apply for this bounty you should:

• Include links to previous work writing tutorials and any other open-source contributions(ie. your github).
• Include a brief overview of how you will complete the task. This can include things like which dependencies you will use, how you will make it self-contained, the sacrifices you would have to make to achieve that, or how you will make it simple. Anything that can convince us you are taking a thoughtful and expert approach to this design.
• Give an estimated timeline on completing the task.
• Post your application text to the Bounty Thread

Selection Process

The ICDevs.org developer’s advisors will propose a vote to award the bounty and the Developer Advisors will vote.

Bounty Completion

Please keep your ongoing code in a public repository(fork or branch is ok). Please provide regular (at least weekly) updates. Code commits count as updates if you link to your branch/fork from the bounty thread. We just need to be able to see that you are making progress.

The balance of the bounty will be paid out at completion.

Once you have finished, please alert the dev forum thread that you have completed work and where we can find that work. We will review and award the bounty reward if the terms have been met. If there is any coordination work(like a pull request) or additional documentation needed we will inform you of what is needed before we can award the reward.

Bounty Abandonment and Re-awarding

If you cease work on the bounty for a prolonged(at the Developer Advisory Board’s discretion) or if the quality of work degrades to the point that we think someone else should be working on the bounty we may re-award it. We will be transparent about this and try to work with you to push through and complete the project, but sometimes, it may be necessary to move on or to augment your contribution with another resource which would result in a split bounty.

Funding

The bounty was generously funded by the DFINITY Foundation. If you would like to turbocharge this bounty you can seed additional donations of ICP to c637ee6eb27a470765785a8373f061012c1e13379eae8b5d0eb86ee8e94aa80e. ICDevs will match the bounty $40:1 ICP for the first 125 ICP out of the DFINITY grant and then 0.25:1 after that. All donations will be tax deductible for US Citizens and Corporations. If you send a donation and need a donation receipt, please email the hash of your donation transaction, physical address, and name to donations@icdevs.org. More information about how you can contribute can be found at our donations page.

FYI: General Bounty Process

Discussion

The draft bounty is posted to the DFINITY developer’s forum for discussion

Ratification

The developer advisor’s board will propose a bounty be ratified and a vote will take place to ratify the bounty. Until a bounty is ratified by the Dev it hasn’t been officially adopted. Please take this into consideration if you are considering starting early.

Open for application

Developers can submit applications to the Dev Forum post. The council will consider these as they come in and propose a vote to award the bounty to one of the applicants. If you would like to apply anonymously you can send an email to austin at icdevs dot org or sending a PM on the dev forum.

Assigned

A developer is currently working on this bounty, you are free to contribute, but any splitting of the award will need to be discussed with the currently assigned developer.

In Review

The Dev Council is reviewing the submission

Awarded

The award has been given and the bounty is closed.

Matches

DFINITY Foundation Grant: - $5000 USD of ICP at award date

Other ICDevs.org Bounties