Skip to content

Commit 68fdeba

Browse files
hacdiashacdias
committed
refactor: upgrade to refactored IPNS package
1 parent ad9e208 commit 68fdeba

File tree

14 files changed

+47
-30
lines changed

14 files changed

+47
-30
lines changed

‎cmd/ipfs/init.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import (
1919
fsrepo "github.com/ipfs/kubo/repo/fsrepo"
2020

2121
options "github.com/ipfs/boxo/coreiface/options"
22+
nsopts "github.com/ipfs/boxo/coreiface/options/namesys"
2223
"github.com/ipfs/boxo/files"
2324
cmds "github.com/ipfs/go-ipfs-cmds"
2425
config "github.com/ipfs/kubo/config"
@@ -262,5 +263,5 @@ func initializeIpnsKeyspace(repoRoot string) error {
262263
return err
263264
}
264265

265-
return nd.Namesys.Publish(ctx, nd.PrivateKey, path.FromCid(emptyDir.Cid()))
266+
return nd.Namesys.Publish(ctx, nd.PrivateKey, path.FromCid(emptyDir.Cid()), nsopts.PublishCompatibleWithV1(true))
266267
}

‎core/commands/dht_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212
func TestKeyTranslation(t *testing.T) {
1313
pid := test.RandPeerIDFatal(t)
1414
pkname := namesys.PkKeyForID(pid)
15-
ipnsname := ipns.RecordKey(pid)
15+
ipnsname := ipns.RoutingRecordKey(pid)
1616

1717
pkk, err := escapeDhtKey("/pk/" + pid.Pretty())
1818
if err != nil {

‎core/commands/name/name.go

+24-15
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,17 @@ Passing --verify will verify signature against provided public key.
151151
return err
152152
}
153153

154-
var entry ipns_pb.IpnsEntry
155-
err = proto.Unmarshal(b.Bytes(), &entry)
154+
// Here we use the old school raw Protobuf pbRecord because we want to inspect it,
155+
// aka, we need to be able to see all of its contents inside. While the boxo/ipns
156+
// provides a good abstraction over the Record type, it doesn't allow for introspection
157+
// of the raw value of the IpnsEntry.
158+
var pbRecord ipns_pb.IpnsEntry
159+
err = proto.Unmarshal(b.Bytes(), &pbRecord)
160+
if err != nil {
161+
return err
162+
}
163+
164+
rec, err := ipns.UnmarshalRecord(b.Bytes())
156165
if err != nil {
157166
return err
158167
}
@@ -164,24 +173,24 @@ Passing --verify will verify signature against provided public key.
164173

165174
result := &IpnsInspectResult{
166175
Entry: IpnsInspectEntry{
167-
Value: string(entry.Value),
168-
ValidityType: entry.ValidityType,
169-
Sequence: *entry.Sequence,
170-
TTL: entry.Ttl,
171-
PublicKey: encoder.Encode(entry.PubKey),
172-
SignatureV1: encoder.Encode(entry.SignatureV1),
173-
SignatureV2: encoder.Encode(entry.SignatureV2),
176+
Value: string(pbRecord.Value),
177+
ValidityType: pbRecord.ValidityType,
178+
Sequence: *pbRecord.Sequence,
179+
TTL: pbRecord.Ttl,
180+
PublicKey: encoder.Encode(pbRecord.PubKey),
181+
SignatureV1: encoder.Encode(pbRecord.SignatureV1),
182+
SignatureV2: encoder.Encode(pbRecord.SignatureV2),
174183
Data: nil,
175184
},
176185
}
177186

178-
if len(entry.Data) != 0 {
187+
if len(pbRecord.Data) != 0 {
179188
// This is hacky. The variable node (datamodel.Node) doesn't directly marshal
180189
// to JSON. Therefore, we need to first decode from DAG-CBOR, then encode in
181190
// DAG-JSON and finally unmarshal it from JSON. Since DAG-JSON is a subset
182191
// of JSON, that should work. Then, we can store the final value in the
183192
// result.Entry.Data for further inspection.
184-
node, err := ipld.Decode(entry.Data, dagcbor.Decode)
193+
node, err := ipld.Decode(pbRecord.Data, dagcbor.Decode)
185194
if err != nil {
186195
return err
187196
}
@@ -198,24 +207,24 @@ Passing --verify will verify signature against provided public key.
198207
}
199208
}
200209

201-
validity, err := ipns.GetEOL(&entry)
210+
validity, err := rec.Validity()
202211
if err == nil {
203212
result.Entry.Validity = &validity
204213
}
205214

206215
verify, ok := req.Options["verify"].(string)
207216
if ok {
208217
key := strings.TrimPrefix(verify, "/ipns/")
209-
id, err := peer.Decode(key)
218+
pid, err := peer.Decode(key)
210219
if err != nil {
211220
return err
212221
}
213222

214223
result.Validation = &IpnsInspectValidation{
215-
PublicKey: id,
224+
PublicKey: pid,
216225
}
217226

218-
err = ipns.ValidateWithPeerID(id, &entry)
227+
err = ipns.ValidateWithPeerID(rec, pid)
219228
if err == nil {
220229
result.Validation.Valid = true
221230
} else {

‎core/commands/name/publish.go

+4
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ const (
2828
ttlOptionName = "ttl"
2929
keyOptionName = "key"
3030
quieterOptionName = "quieter"
31+
compatibleWithV1 = "compatible-v1"
3132
)
3233

3334
var PublishCmd = &cmds.Command{
@@ -83,6 +84,7 @@ Alternatively, publish an <ipfs-path> using a valid PeerID (as listed by
8384
cmds.StringOption(ttlOptionName, "Time duration this record should be cached for. Uses the same syntax as the lifetime option. (caution: experimental)"),
8485
cmds.StringOption(keyOptionName, "k", "Name of the key to be used or a valid PeerID, as listed by 'ipfs key list -l'.").WithDefault("self"),
8586
cmds.BoolOption(quieterOptionName, "Q", "Write only final hash."),
87+
cmds.BoolOption(compatibleWithV1, "Create a V1-compatible IPNS Record.").WithDefault(true),
8688
ke.OptionIPNSBase,
8789
},
8890
Run: func(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) error {
@@ -96,6 +98,7 @@ Alternatively, publish an <ipfs-path> using a valid PeerID (as listed by
9698
}
9799

98100
allowOffline, _ := req.Options[allowOfflineOptionName].(bool)
101+
compatibleWithV1, _ := req.Options[compatibleWithV1].(bool)
99102
kname, _ := req.Options[keyOptionName].(string)
100103

101104
validTimeOpt, _ := req.Options[lifeTimeOptionName].(string)
@@ -108,6 +111,7 @@ Alternatively, publish an <ipfs-path> using a valid PeerID (as listed by
108111
options.Name.AllowOffline(allowOffline),
109112
options.Name.Key(kname),
110113
options.Name.ValidTime(validTime),
114+
options.Name.CompatibleWithV1(compatibleWithV1),
111115
}
112116

113117
if ttl, found := req.Options[ttlOptionName].(string); found {

‎core/core_test.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import (
1212
context "context"
1313

1414
"github.com/ipfs/boxo/ipns"
15+
ipfspath "github.com/ipfs/boxo/path"
1516
"github.com/ipfs/go-cid"
1617
"github.com/ipfs/go-delegated-routing/client"
1718
"github.com/ipfs/kubo/core/node/libp2p"
@@ -300,11 +301,11 @@ func (drs *delegatedRoutingService) GetIPNS(ctx context.Context, id []byte) (<-c
300301
var out client.GetIPNSAsyncResult
301302
switch peer.ID(id) {
302303
case drs.goodPeerID:
303-
ie, err := ipns.Create(drs.pk1, []byte(fmt.Sprintf("RECORD FROM SERVICE %d", drs.serviceID)), 0, time.Now().Add(10*time.Hour), 100*time.Hour)
304+
rec, err := ipns.NewRecord(drs.pk1, ipfspath.Path(fmt.Sprintf("RECORD FROM SERVICE %d", drs.serviceID)), 0, time.Now().Add(10*time.Hour), 100*time.Hour, ipns.CompatibleWithV1(true))
304305
if err != nil {
305306
log.Fatal(err)
306307
}
307-
ieb, err := ie.Marshal()
308+
ieb, err := ipns.MarshalRecord(rec)
308309
if err != nil {
309310
log.Fatal(err)
310311
}

‎core/coreapi/name.go

+1
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ func (api *NameAPI) Publish(ctx context.Context, p path.Path, opts ...caopts.Nam
7979

8080
publishOptions := []nsopts.PublishOption{
8181
nsopts.PublishWithEOL(eol),
82+
nsopts.PublishCompatibleWithV1(options.CompatibleWithV1),
8283
}
8384

8485
if options.TTL != nil {

‎docs/examples/kubo-as-a-library/go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ go 1.18
77
replace github.com/ipfs/kubo => ./../../..
88

99
require (
10-
github.com/ipfs/boxo v0.10.0
10+
github.com/ipfs/boxo v0.10.1-0.20230612085926-cfaa3b85f919
1111
github.com/ipfs/kubo v0.0.0-00010101000000-000000000000
1212
github.com/libp2p/go-libp2p v0.27.5
1313
github.com/multiformats/go-multiaddr v0.9.0

‎docs/examples/kubo-as-a-library/go.sum

+2-2
Original file line numberDiff line numberDiff line change
@@ -319,8 +319,8 @@ github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:
319319
github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
320320
github.com/ipfs/bbloom v0.0.4 h1:Gi+8EGJ2y5qiD5FbsbpX/TMNcJw8gSqr7eyjHa4Fhvs=
321321
github.com/ipfs/bbloom v0.0.4/go.mod h1:cS9YprKXpoZ9lT0n/Mw/a6/aFV6DTjTLYHeA+gyqMG0=
322-
github.com/ipfs/boxo v0.10.0 h1:tdDAxq8jrsbRkYoF+5Rcqyeb91hgWe2hp7iLu7ORZLY=
323-
github.com/ipfs/boxo v0.10.0/go.mod h1:Fg+BnfxZ0RPzR0nOodzdIq3A7KgoWAOWsEIImrIQdBM=
322+
github.com/ipfs/boxo v0.10.1-0.20230612085926-cfaa3b85f919 h1:gXy+LZIvuH85lhwUMwWub4cpjFA7bGmb93ue8kqLRuY=
323+
github.com/ipfs/boxo v0.10.1-0.20230612085926-cfaa3b85f919/go.mod h1:vRJqn2gSu+LkTTVGzxRJxggmiHXnWl0Ws5/YAwQbJLM=
324324
github.com/ipfs/go-bitfield v1.1.0 h1:fh7FIo8bSwaJEh6DdTWbCeZ1eqOaOkKFI74SCnsWbGA=
325325
github.com/ipfs/go-bitfield v1.1.0/go.mod h1:paqf1wjq/D2BBmzfTVFlJQ9IlFOZpg422HL0HqsGWHU=
326326
github.com/ipfs/go-block-format v0.0.2/go.mod h1:AWR46JfpcObNfg3ok2JHDUfdiHRgWhJgCQF+KIgOPJY=

‎fuse/ipns/common.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ package ipns
33
import (
44
"context"
55

6+
nsopts "github.com/ipfs/boxo/coreiface/options/namesys"
67
ft "github.com/ipfs/boxo/ipld/unixfs"
78
nsys "github.com/ipfs/boxo/namesys"
89
path "github.com/ipfs/boxo/path"
@@ -30,5 +31,5 @@ func InitializeKeyspace(n *core.IpfsNode, key ci.PrivKey) error {
3031

3132
pub := nsys.NewIpnsPublisher(n.Routing, n.Repo.Datastore())
3233

33-
return pub.Publish(ctx, key, path.FromCid(emptyDir.Cid()))
34+
return pub.Publish(ctx, key, path.FromCid(emptyDir.Cid()), nsopts.PublishCompatibleWithV1(true))
3435
}

‎fuse/ipns/ipns_unix.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ type Root struct {
8585

8686
func ipnsPubFunc(ipfs iface.CoreAPI, key iface.Key) mfs.PubFunc {
8787
return func(ctx context.Context, c cid.Cid) error {
88-
_, err := ipfs.Name().Publish(ctx, path.IpfsPath(c), options.Name.Key(key.Name()))
88+
_, err := ipfs.Name().Publish(ctx, path.IpfsPath(c), options.Name.Key(key.Name()), options.Name.CompatibleWithV1(true))
8989
return err
9090
}
9191
}

‎go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ require (
1616
github.com/gogo/protobuf v1.3.2
1717
github.com/google/uuid v1.3.0
1818
github.com/hashicorp/go-multierror v1.1.1
19-
github.com/ipfs/boxo v0.10.0
19+
github.com/ipfs/boxo v0.10.1-0.20230612085926-cfaa3b85f919
2020
github.com/ipfs/go-block-format v0.1.2
2121
github.com/ipfs/go-cid v0.4.1
2222
github.com/ipfs/go-cidutil v0.1.0

‎go.sum

+2-2
Original file line numberDiff line numberDiff line change
@@ -354,8 +354,8 @@ github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:
354354
github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
355355
github.com/ipfs/bbloom v0.0.4 h1:Gi+8EGJ2y5qiD5FbsbpX/TMNcJw8gSqr7eyjHa4Fhvs=
356356
github.com/ipfs/bbloom v0.0.4/go.mod h1:cS9YprKXpoZ9lT0n/Mw/a6/aFV6DTjTLYHeA+gyqMG0=
357-
github.com/ipfs/boxo v0.10.0 h1:tdDAxq8jrsbRkYoF+5Rcqyeb91hgWe2hp7iLu7ORZLY=
358-
github.com/ipfs/boxo v0.10.0/go.mod h1:Fg+BnfxZ0RPzR0nOodzdIq3A7KgoWAOWsEIImrIQdBM=
357+
github.com/ipfs/boxo v0.10.1-0.20230612085926-cfaa3b85f919 h1:gXy+LZIvuH85lhwUMwWub4cpjFA7bGmb93ue8kqLRuY=
358+
github.com/ipfs/boxo v0.10.1-0.20230612085926-cfaa3b85f919/go.mod h1:vRJqn2gSu+LkTTVGzxRJxggmiHXnWl0Ws5/YAwQbJLM=
359359
github.com/ipfs/go-bitfield v1.1.0 h1:fh7FIo8bSwaJEh6DdTWbCeZ1eqOaOkKFI74SCnsWbGA=
360360
github.com/ipfs/go-bitfield v1.1.0/go.mod h1:paqf1wjq/D2BBmzfTVFlJQ9IlFOZpg422HL0HqsGWHU=
361361
github.com/ipfs/go-block-format v0.0.2/go.mod h1:AWR46JfpcObNfg3ok2JHDUfdiHRgWhJgCQF+KIgOPJY=

‎test/dependencies/go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ replace github.com/ipfs/kubo => ../../
77
require (
88
github.com/Kubuxu/gocovmerge v0.0.0-20161216165753-7ecaa51963cd
99
github.com/golangci/golangci-lint v1.49.0
10-
github.com/ipfs/boxo v0.10.0
10+
github.com/ipfs/boxo v0.10.1-0.20230612085926-cfaa3b85f919
1111
github.com/ipfs/go-cid v0.4.1
1212
github.com/ipfs/go-cidutil v0.1.0
1313
github.com/ipfs/go-datastore v0.6.0

‎test/dependencies/go.sum

+2-2
Original file line numberDiff line numberDiff line change
@@ -412,8 +412,8 @@ github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NH
412412
github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
413413
github.com/ipfs/bbloom v0.0.4 h1:Gi+8EGJ2y5qiD5FbsbpX/TMNcJw8gSqr7eyjHa4Fhvs=
414414
github.com/ipfs/bbloom v0.0.4/go.mod h1:cS9YprKXpoZ9lT0n/Mw/a6/aFV6DTjTLYHeA+gyqMG0=
415-
github.com/ipfs/boxo v0.10.0 h1:tdDAxq8jrsbRkYoF+5Rcqyeb91hgWe2hp7iLu7ORZLY=
416-
github.com/ipfs/boxo v0.10.0/go.mod h1:Fg+BnfxZ0RPzR0nOodzdIq3A7KgoWAOWsEIImrIQdBM=
415+
github.com/ipfs/boxo v0.10.1-0.20230612085926-cfaa3b85f919 h1:gXy+LZIvuH85lhwUMwWub4cpjFA7bGmb93ue8kqLRuY=
416+
github.com/ipfs/boxo v0.10.1-0.20230612085926-cfaa3b85f919/go.mod h1:vRJqn2gSu+LkTTVGzxRJxggmiHXnWl0Ws5/YAwQbJLM=
417417
github.com/ipfs/go-bitfield v1.1.0 h1:fh7FIo8bSwaJEh6DdTWbCeZ1eqOaOkKFI74SCnsWbGA=
418418
github.com/ipfs/go-bitfield v1.1.0/go.mod h1:paqf1wjq/D2BBmzfTVFlJQ9IlFOZpg422HL0HqsGWHU=
419419
github.com/ipfs/go-block-format v0.1.2 h1:GAjkfhVx1f4YTODS6Esrj1wt2HhrtwTnhEr+DyPUaJo=

0 commit comments

Comments
 (0)