--- template remove once ready ---
To submit a proposal, please create a PR adding a file to this folder filling out this template. Please title your file `open-proposal-title.md`, replacing `title` with the name of your project.
--- template remove once ready ---

# Open Grant Proposal: `Multisize Image`

**Name of Project:** `multisize-image`

**Proposer:** [Samyoul](https://github.com/Samyoul) and [oed](https://github.com/oed)

**Do you agree to open source all work you do on behalf of this RFP and dual-license under MIT and APACHE2 licenses?:** Yes

# Project Description

Storing an image in IPFS currently is not optimal for many use cases, but using IPLD can significantly improve this. Multisize-image is a proposed tool to take one image and resize it to multiple images and finally link them together using IPLD.

A major problem developers encounter while building with ipfs is image sizes. Dapps that allow users to upload an image to ipfs are confined to using the image size that the user originally uploaded.

If the user uploads a large picture the dapp will render slowly, since the only available image file for this picture has is large and takes more time to load. This becomes especially apparent when a site is displaying a lot of images. For example the dapp might load 1000x1000 px images to display as 20x20 px thumbnails or icons.

Implementing a multisize-image library that resizes an image and wraps it in an IPLD object would solve these problems. By allowing dapp devs to load the appropriate size of the image at the appropriate time.

## Value

**Benefits of this proposal:** Applications using IPFS images will have flexiblity to chose the context appropriate image size, increasing the application's load time (in some cases significantly so). IPFS will have a mechanism to mature its ecosystem with multiple applications implementing a standardised method of solving image size problems.

**Risk of poor implementation:** A poor specification could lead to multiple incompatible implementations. A computationally inefficient method of image resize could create a poor user image upload experience.

**Project challenges:** Developing a robust specification that is broad enough to handle all major image size use cases, but not too broad as to lead to inconsistent and incompatible implementations. Correctly identifying the most computationally efficient method of image resize.

## Deliverables

A specification for `multisize-image` object storage on IPFS using IPLD, serving as the guidelines for all libraries that wish to provide `multisize-image` functionality for their environment.

A javascript library `multisize-image` that takes a file as imput and outputs a CID of an IPLD encoded map that points to the same image in various sizes. For an outline of the library api [see here](https://github.com/3box/3box/issues/994#issuecomment-604519389).

## Development Roadmap
--- template remove once ready ---
Please break up your development work into a clear set of milestones. This section needs to be very detailed (will vary on the project, but aim for around 2 pages for this section).

For each milestone, please describe:
- The software functionality that we can expect after the completion of each milestone. This should be detailed enough that it can be used to ensure that the software meets the specification you outlined in the Deliverables.
- How many people will be working on each milestone and their roles
- The amount of funding required for each milestone
- How much time this milestone will take to achieve (using real dates)

--- template remove once ready ---

**Milestones :**

- Formalise the `multisize-image` specification
- **IPLD map spec**
- Specify the IPLD map that will point to the various images. This inlcudes how different sizes and image formats are represented.
- **Image format support**
- Specify which image formats are to be supported. Also make it easy for new formats to be added to the spec in the future.
- **Javascript library API**
- Specify what the API of the javascript library will look like.
- Implementation:
- **IPLD module**
- Implement a module that consumes configuration and image CIDs and outputs an IPLD map to these images.
- **Client side**
- Identify the most computationally efficient method for image resize using javascript
- Implement the image resize algorithm using javascript. The implementation will allow the user to load an image and expect an output of multiple predefined image sizes.
- **Server side**
- Identify the most computationally efficient method for image resize using javascript
- Implement the image resize algorithm using javascript. The implementation will allow the user to load an image and expect an output of multiple predefined image sizes.

## Total Budget Requested

Sum up the total requested budget across all milestones, and include that figure here. Also, please include a budget breakdown to specify how you are planning to spend these funds.

## Maintenance and Upgrade Plans

Specify your team's long-term plans to maintain this software and upgrade it over time.

# Team

## Team Members

- Samuel Hawksby-Robinson, Status IM, [profile](https://github.com/Samyoul) (specification and implementation)
- Joel Thorstensson, 3Box / Ceramic, [profile](https://github.com/oed) (advising and reviewing)

## Team Website

https://github.com/3box/js-multisize-image

## Relevant Experience
--- template remove once ready ---
Please describe (in words) your team's relevant experience, and why you think you are the right team to build this project. You can cite your team's prior experience in similar domains, doing similar dev work, individual team members' backgrounds, etc.
--- template remove once ready ---

Joel has been working with ipfs when building and designing 3Box and Ceramic. He knows many of the best practices and intricacies of ipfs and js-ipfs specificly.

## Team code repositories

Once finished the library will be managed by 3Box and Samuel.

# Additional Information

Please include any additional information that you think would be useful in helping us to evaluate your proposal.