Rename go-libipfs to boxo #215

BigLep · 2023-03-20T21:05:45Z

Done Criteria

go-libipfs the repo is renamed to boxo in such a way that existing consumers aren't broken when they dependended on an explicit version of go-libipfs
key consumers of go-libipfs use boxo instead (e.g., Kubo)
public docs in this repo that use the term "go-libipfs" have been updated to say "boxo"

Why Important

A project's name can set expectations on what a project provides to consumers. We don't want someone to think that they need to use go-libipfs if writing an IPFS implementation in Go. It may be helpful, but it isn't required. Worked started in lead up to IPFS Thing 2022 and is ongoing (ipfs/specs#381 ) to drive the message home that IPFS compatibility is very broad. For example, they must support addressability using CIDs and expose operations (e.g., provision, retrieval) on resources using CIDs. IPFS implementations don't need to support all the functionality of Kubo or all the functionality that is possible with go-libipfs.

Why are we doing this now?

"boxo" has had this history about its name:

2021Q4: project pitched and experimented with in "ipfs/go-libipfs": Consolidate IPFS Repositories kubo#8543
202211: started making active effort on it in an incremental fashion. In that process, we renamed "go-libipfs" to "libkubo", but reverted back to go-libipfs because we found it "to be even more confusing since its intention is to have code that is reusable and not Kubo-specific" (see Consolidate IPFS Repositories kubo#8543 (comment))
202303: @ipfs/kubo-maintainers got feedback from @jbenet on how the "go-libipfs" name can cause confusion about what constitutes an IPFS implementation or set expectations about this repo that we don't want (i.e., that one needs to use this repo for one's IPFS implementation written in go).

Renames aren't free, but it's better to do it now before even more start depending on it as part of #196.

Why was this name chosen?

"boxo" is physical toolbox vendor. "boxo" the project is intended to be a toolbox of modules, tools, and examples that can aid one in their go-based IPFS implementation.
Similarity between the "box" and IPFS's "cube" shape.
Audible resonance with "kubo", which is the archeologically-rich soil from which "boxo" has sprouted from and "kubo" is at least currently one of the significant consumers of "boxo".
"boxo" is short.

Why wasn't the community given input into the name?

The request for a name change came late while we were part way through #196. That work was already drawing on and impacting other work. Team resolve to be in limbo was low 1) given current situation and 2) having done a lot of renaming last year with go-ipfs and Kubo, and the name was compelling enough for the reasons listed.

Tasks

Fixes ipfs#215

Fixes #215

BigLep · 2023-03-21T01:03:08Z

@ipfs/kubo-maintainers :

Issue description updated with more details here. Feel free to correct.
I updated [Milestone] Getting boxo "over the hump" #196 to add this to the list.
I updated the FAQ with a TODO to extract portions from here: [WIP] Frequently Asked Questions about this project #190
Added some extra requirements for the migration tooling here: Tooling to minimize impact on those updating to boxo #181

Thanks @Jorropo for leading the charge.

Include rename from: github.com/ipfs/go-libipfs => github.com/ipfs/boxo Migrated repos: - github.com/ipfs/interface-go-ipfs-core => ./coreiface - github.com/ipfs/go-pinning-service-http-client => ./pinning/remote/client - github.com/ipfs/go-path => ./path - github.com/ipfs/go-namesys => ./namesys - github.com/ipfs/go-mfs => ./mfs - github.com/ipfs/go-ipfs-provider => ./provider - github.com/ipfs/go-ipfs-pinner => ./pinning/pinner - github.com/ipfs/go-ipfs-keystore => ./keystore - github.com/ipfs/go-filestore => ./filestore - github.com/ipfs/go-ipns => ./ipns - github.com/ipfs/go-blockservice => ./blockservice - github.com/ipfs/go-ipfs-chunker => ./chunker - github.com/ipfs/go-fetcher => ./fetcher - github.com/ipfs/go-ipfs-blockstore => ./blockstore - github.com/ipfs/go-ipfs-posinfo => ./filestore/posinfo - github.com/ipfs/go-ipfs-util => ./util - github.com/ipfs/go-ipfs-ds-help => ./datastore/dshelp - github.com/ipfs/go-verifcid => ./verifcid - github.com/ipfs/go-ipfs-exchange-offline => ./exchange/offline - github.com/ipfs/go-ipfs-routing => ./routing - github.com/ipfs/go-ipfs-exchange-interface => ./exchange - github.com/ipfs/go-unixfs => ./ipld/unixfs - github.com/ipfs/go-merkledag => ./ipld/merkledag - github.com/ipld/go-car => ./ipld/car Fixes #215 Updates #202

Include rename from: github.com/ipfs/go-libipfs => github.com/ipfs/boxo This unmigrate: ./blocks => github.com/ipfs/go-block-format Migrated repos: - github.com/ipfs/interface-go-ipfs-core => ./coreiface - github.com/ipfs/go-pinning-service-http-client => ./pinning/remote/client - github.com/ipfs/go-path => ./path - github.com/ipfs/go-namesys => ./namesys - github.com/ipfs/go-mfs => ./mfs - github.com/ipfs/go-ipfs-provider => ./provider - github.com/ipfs/go-ipfs-pinner => ./pinning/pinner - github.com/ipfs/go-ipfs-keystore => ./keystore - github.com/ipfs/go-filestore => ./filestore - github.com/ipfs/go-ipns => ./ipns - github.com/ipfs/go-blockservice => ./blockservice - github.com/ipfs/go-ipfs-chunker => ./chunker - github.com/ipfs/go-fetcher => ./fetcher - github.com/ipfs/go-ipfs-blockstore => ./blockstore - github.com/ipfs/go-ipfs-posinfo => ./filestore/posinfo - github.com/ipfs/go-ipfs-util => ./util - github.com/ipfs/go-ipfs-ds-help => ./datastore/dshelp - github.com/ipfs/go-verifcid => ./verifcid - github.com/ipfs/go-ipfs-exchange-offline => ./exchange/offline - github.com/ipfs/go-ipfs-routing => ./routing - github.com/ipfs/go-ipfs-exchange-interface => ./exchange - github.com/ipfs/go-unixfs => ./ipld/unixfs - github.com/ipfs/go-merkledag => ./ipld/merkledag - github.com/ipld/go-car => ./ipld/car Fixes #215 Updates #202

Include rename from: github.com/ipfs/go-libipfs => github.com/ipfs/boxo This migration was reverted: ./blocks => github.com/ipfs/go-block-format Migrated repos: - github.com/ipfs/interface-go-ipfs-core => ./coreiface - github.com/ipfs/go-pinning-service-http-client => ./pinning/remote/client - github.com/ipfs/go-path => ./path - github.com/ipfs/go-namesys => ./namesys - github.com/ipfs/go-mfs => ./mfs - github.com/ipfs/go-ipfs-provider => ./provider - github.com/ipfs/go-ipfs-pinner => ./pinning/pinner - github.com/ipfs/go-ipfs-keystore => ./keystore - github.com/ipfs/go-filestore => ./filestore - github.com/ipfs/go-ipns => ./ipns - github.com/ipfs/go-blockservice => ./blockservice - github.com/ipfs/go-ipfs-chunker => ./chunker - github.com/ipfs/go-fetcher => ./fetcher - github.com/ipfs/go-ipfs-blockstore => ./blockstore - github.com/ipfs/go-ipfs-posinfo => ./filestore/posinfo - github.com/ipfs/go-ipfs-util => ./util - github.com/ipfs/go-ipfs-ds-help => ./datastore/dshelp - github.com/ipfs/go-verifcid => ./verifcid - github.com/ipfs/go-ipfs-exchange-offline => ./exchange/offline - github.com/ipfs/go-ipfs-routing => ./routing - github.com/ipfs/go-ipfs-exchange-interface => ./exchange - github.com/ipfs/go-unixfs => ./ipld/unixfs - github.com/ipfs/go-merkledag => ./ipld/merkledag - github.com/ipld/go-car => ./ipld/car Fixes #215 Updates #202

BigLep · 2023-03-27T20:23:35Z

@Jorropo : Congrats on merging #220 🎉 🎉 🎉 .

I'm reopening this issue because there are still a couple of tasks that aren't completed in the checklist above.

Context: ipfs/boxo#215 We use commit from ipfs/boxo#176 (comment) to unblock work on ipfs-inactive/bifrost-gateway#61

Context: ipfs/boxo#215 Used commits from ipfs/boxo#176 (comment) and filecoin-saturn/caboose#68 to unblock work on #61

BigLep · 2023-04-06T15:35:57Z

2023-04-06 maintainer conversation: we will close this when the Lotus side is in. We're not going to block on Cluster given @hsanjuan is out currently (unless @guseggert learns of someone else who can review/approve there).

BigLep self-assigned this Mar 20, 2023

Jorropo added a commit to Jorropo/go-libipfs that referenced this issue Mar 20, 2023

Boxo !!!

ffe91ec

Fixes ipfs#215

Jorropo mentioned this issue Mar 20, 2023

Boxo !!! #216

Closed

Jorropo added a commit to Jorropo/go-libipfs that referenced this issue Mar 20, 2023

Boxo !!!

58b1a61

Fixes ipfs#215

Jorropo added a commit to Jorropo/go-libipfs that referenced this issue Mar 20, 2023

Boxo !!!

8800cde

Fixes ipfs#215

Jorropo added a commit to Jorropo/go-libipfs that referenced this issue Mar 20, 2023

Boxo !!!

ad1d7ef

Fixes ipfs#215

Jorropo mentioned this issue Mar 20, 2023

Boxo #217

Closed

Jorropo added a commit that referenced this issue Mar 20, 2023

Boxo !!!

e99b1a6

Fixes #215

Jorropo added a commit that referenced this issue Mar 20, 2023

Boxo !!!

aa5bea9

Fixes #215

Jorropo added a commit that referenced this issue Mar 20, 2023

Boxo !!!

d7a0230

Fixes #215

Jorropo added a commit that referenced this issue Mar 20, 2023

Boxo !!!

1b37371

Fixes #215

Jorropo self-assigned this Mar 21, 2023

Jorropo added a commit that referenced this issue Mar 21, 2023

Boxo !!!

2ac774b

Fixes #215

Jorropo added a commit that referenced this issue Mar 21, 2023

Boxo !!!

3863bad

Fixes #215

This was referenced Mar 21, 2023

[Milestone] Getting boxo "over the hump" #196

Closed

[WIP] Frequently Asked Questions about this project #190

Closed

Tooling to minimize impact on those updating to boxo #181

Closed

Jorropo mentioned this issue Mar 22, 2023

feat: Über Migration (and Boxo rename) #220

Merged

Jorropo closed this as completed in #220 Mar 27, 2023

BigLep reopened this Mar 27, 2023

lidel added a commit to filecoin-saturn/caboose that referenced this issue Mar 29, 2023

refactor: go-libipfs → boxo

83577ee

Context: ipfs/boxo#215 We use commit from ipfs/boxo#176 (comment) to unblock work on ipfs-inactive/bifrost-gateway#61

lidel mentioned this issue Mar 29, 2023

feat: switch to boxo and fix CAR fetch timeouts filecoin-saturn/caboose#68

Merged

7 tasks

lidel added a commit to ipfs-inactive/bifrost-gateway that referenced this issue Mar 29, 2023

refactor: switch to boxo/gateway.NewBlocksGateway

955bcd5

Context: ipfs/boxo#215 Used commits from ipfs/boxo#176 (comment) and filecoin-saturn/caboose#68 to unblock work on #61

lidel added a commit to ipfs-inactive/bifrost-gateway that referenced this issue Mar 29, 2023

refactor: switch to boxo/gateway.NewBlocksGateway

fd484ac

Context: ipfs/boxo#215 Used commits from ipfs/boxo#176 (comment) and filecoin-saturn/caboose#68 to unblock work on #61

BigLep closed this as completed Apr 25, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename go-libipfs to boxo #215

Rename go-libipfs to boxo #215

BigLep commented Mar 20, 2023 •

edited

Loading

BigLep commented Mar 21, 2023 •

edited

Loading

BigLep commented Mar 27, 2023

BigLep commented Apr 6, 2023

Rename go-libipfs to boxo #215

Rename go-libipfs to boxo #215

Comments

BigLep commented Mar 20, 2023 • edited Loading

Done Criteria

Why Important

Why are we doing this now?

Why was this name chosen?

Why wasn't the community given input into the name?

Tasks

BigLep commented Mar 21, 2023 • edited Loading

BigLep commented Mar 27, 2023

BigLep commented Apr 6, 2023

BigLep commented Mar 20, 2023 •

edited

Loading

BigLep commented Mar 21, 2023 •

edited

Loading