ipfs/kubo

canonical method for checking locality of a block via coreAPI

Open

#6726 opened on Oct 24, 2019

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
help wantedkind/enhancement

Description

Location

:wave: 👨‍👧‍👧! I'm looking for the best way to ask "hey is this block local"?

Given that we're in IPFS user land, we should be using core API for this stuff. Which means we're trying to do stuff that's easiest accomplished with a blockstore via coreapi.

Blockstore method that works exactly as we'd like:

https://github.com/ipfs/go-ipfs-blockstore/blob/3eee0dff760dea94c59381e9a18b9aa290361b28/blockstore.go#L36

Relevant coreAPI subsystem:

https://github.com/ipfs/interface-go-ipfs-core/blob/1c94e6217184ed07abab840143aa1f417e314c3d/block.go#L20-L37

Description

We also have the same question about complete DAGs, happy to file a separate issue if you'd prefer. I'd love to be pointed to the canonical methods of determining if a block or dag is local via core API.

Thanks!

Contributor guide

Tech stack
go
Domain
apibackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GoIPFS core APIblockstore
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue asks for a canonical way to check if a block is local using the core API. The user points to the blockstore.Has method and the coreAPI block subsystem. To resolve, first examine the existing coreAPI block methods (see interface go ipfs core/block.go) and determine if there is already a method to check locality. If not, propose adding a method such as `IsLocal` or `Has` to the coreAPI block interface, and implement it in the Kubo repo. Also consider the question about complete DAGs. Reference the blockstore interface and ensure the new method uses it internally.