Shaloo/ar 4947 chunksize #166
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for storagesdk-ref-guide ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
SauravKanchan
approved these changes
Nov 14, 2022
mmjee
reviewed
Nov 14, 2022
|
|
||
| ### Upload Chunk Size | ||
|
|
||
| Arcana Storage SDK uses chunked uploading mode. Each file is split into chunks of default size 10MB and chunks are uploaded one by one. These chunks are further processed on the server, encrypted, and split into multiple parts before being stored in the Arcana Store. Chunked uploading helps to overcome the server's default upload size limitation and there is no server-side setting change required to upload a very large file size. Also, it helps in decentralizing data storage. |
There was a problem hiding this comment.
Uses chunked uploading mode
What does that even mean? I suggest: “uploads files in chunks”.
chunks of default size 10MB
I recommend: “chunks (10 MiB by default)”.
mmjee
reviewed
Nov 14, 2022
|
|
||
| Arcana Storage SDK uses chunked uploading mode. Each file is split into chunks of default size 10MB and chunks are uploaded one by one. These chunks are further processed on the server, encrypted, and split into multiple parts before being stored in the Arcana Store. Chunked uploading helps to overcome the server's default upload size limitation and there is no server-side setting change required to upload a very large file size. Also, it helps in decentralizing data storage. | ||
|
|
||
| You can change the default chunk size while uploading a file. Make sure the new chunk size is a multiple of 16 otherwise there may be issues in downloading the file. |
There was a problem hiding this comment.
there may be issues in downloading the file
Could be worded more precisely.
Suggested change
| You can change the default chunk size while uploading a file. Make sure the new chunk size is a multiple of 16 otherwise there may be issues in downloading the file. | |
| You can change the default chunk size while uploading a file. Make sure the new chunk size is a multiple of 16 (bytes) otherwise you may face unexpected issues if you try to download the file. |
mmjee
reviewed
Nov 14, 2022
| 2. Import `StorageProvider` from the Storage SDK package in the dApp. Call `init` method of `StorageProvider` and specify the Web3 wallet `provider` and the `appAddress` as input parameters. **Note:** Get the provider via the Auth SDK or third-party supported wallet. You can copy the appAddress from the [Arcana Developer Dashboard](https://docs.beta.arcana.network/docs/config_dapp) after registering your dApp | ||
| 3. Use `StorageProvider` to: | ||
| - `upload` and push file data into the Arcana Store. **Note:** Save file DID that is returned after file upload operation is successful. | ||
| - `upload` and push file data into the Arcana Store. **Note:** Save file DID that is returned after the file upload operation is successful. |
There was a problem hiding this comment.
This is a good opportunity to fix this, “Save file DID” is not English.
Suggested change
| - `upload` and push file data into the Arcana Store. **Note:** Save file DID that is returned after the file upload operation is successful. | |
| - `upload` and push file data into the Arcana Store. **Note:** The newly saved file's DID is returned once the file upload operation is successful. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Template
Resolves or continues AR-4947.
Blocking dependencies
NA
Changes
Upload File section updated with additional code snippet and some usage guidance on specifying chunk size during upload.
Checklist
developer/AR-XXX-issue-name.