Irys-xyz / arweave-js-sdk

JS SDK for Irys on Arweave
111 stars 96 forks source link

Pass user tags to upload folder verified #83

Closed jshaw-decides closed 1 year ago

jshaw-decides commented 1 year ago

Hey @joshbenaron @JesseTheRobot

The previous PR was saying the commits needed to be verified to get merged into the default branch. Had to setup some keys and rebase this branch to get the commits verified.

There are no changes between this branch and pass-user-tags-to-upload-folder except that the commits are verified commits now.

image
jshaw-decides commented 1 year ago

Here's a link that will allow you to easily compare both branches: https://github.com/Bundlr-Network/js-sdk/compare/main...mogulx-operates:bundlr:pass-user-tags-to-upload-folder-verified

image

joshbenaron commented 1 year ago

Can someone please include the specific API change here. We need a strong record for PRs

jshaw-decides commented 1 year ago

Let me know if this doesn't make sense at a glance @joshbenaron, I'll try to word it / organize it better.

Description:

This PR adds a new property to the interface of the uploadFolder() function of the SDK. (https://github.com/Bundlr-Network/js-sdk/blob/main/src/node/bundlr.ts#L68)

The property is manifestTags and it allows the user to add additional tags to the path manifest file that is created by bundler when uploading a directory.

The manifestTags structure is as follows:

{name: string; value: string}[]

The specific use case I will be using this property for is to add tags to the path manifest of an application that is deployed as a renderer. (ANS-108, ANS-110, ANS-111[proposed])