BNT-1: Chunked upload/download library

[domwoe]

Overview

• Project Type: Traditional - One worker contributes, and one worker is paid
• Time Commitment: Weeks
• Experience Level: Intermediate
• Size: USD 5'000 in ICP

Description

The maximum size of an ingress message to the Internet Computer, as well as the response, is currently limited to 2MB. If you want to upload/fetch files that are larger than this limit you have to slice them into chunks and assemble these chunks. This bounty targets the JS/TS client library and must be compatible with the interface of the assets canister.

Use Cases

Upload a file of arbitrary size to a canister exposing an interface compatible with the assets canister. API should allow parallel and sequential uploading.

Fetching a file of arbitrary size from a canister that exposes an interface compatible with the asset canister. Certification should be checked if the certification header is set (See Service worker code as reference)

Acceptance Criteria

• Merged PR to packages
• JSDoc comments
• Unit tests and E2E tests
• Markdown documentation that explains the usage of the API
• Example application, ideally contributed to https://github.com/dfinity/examples

References

• Asset canister code
• Service worker code including streaming

[domwoe]

@sea-snake is taking this bounty based on his work on https://github.com/slide-computer/assets-js

[domwoe]

WIP PR: https://github.com/dfinity/agent-js/pull/603

[domwoe]

• https://github.com/dfinity/agent-js/pull/603 has been merged and released
• WIP PR to examples repo: https://github.com/dfinity/examples/pull/355

[domwoe]

Bounty has been completed by @sea-snake