MystenLabs / MystenLabs/walrus

Set attribute (metadata) when storing

Open
#2,012 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

client enhancement storage client
Dominant language
Rust
Stars
420
Forks
136
Avg merge
19h
Merged PRs (30d)
29

Description

Description

Feature
Currently, the Walrus CLI requires two separate steps to store a blob and then set its attributes.
I’d like to request support for setting attributes at the time of blob creation, ideally using the HTTP API.

Use case
We're uploading images and need to set the content-type and content-disposition attributes for each blob so that we can display images from the aggregator inside web pages.

Docs
Having docs for the metadata module would help other developers better understand and interact with the protocol's on-chain metadata structure.

https://testnet.suivision.xyz/package/0xd84704c17fc870b8764832c535aa6b11f21a95cd6f5bb38a9b07d2cf42220c66

We could, for example, use a PTB to set the metadata for multiple blobs at a time.

Code of Conduct
  • I agree to follow this project's Code of Conduct.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the Walrus CLI's blob-creation flow and the HTTP API, then review the metadata module and its on-chain structure. Done means blob creation can set content-type and content-disposition attributes, with documentation explaining the metadata module and support for setting metadata for multiple blobs through a PTB.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api, blockchain, cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.