RAPIDE & IPSL: first proof of concept

.github/CODEOWNERS

@@ -4,3 +4,7 @@
 
 # HTTP Gateway
 gateway/ @lidel @hacdias
+
+# IPSL
+ipsl/* @Jorropo
+rapide/* @Jorropo

blocks/blocks.go

@@ -24,6 +24,10 @@ type Block interface {
  Loggable() map[string]interface{}
 }
 
+type BlockIterator interface {
+ Next() (Block, error)
+}
+
 // A BasicBlock is a singular block of data in ipfs. It implements the Block
 // interface.
 type BasicBlock struct {
@@ -80,3 +84,20 @@ func (b *BasicBlock) Loggable() map[string]interface{} {
  "block": b.Cid().String(),
  }
 }
+
+// BlockOrError is either an error or a block.
+type BlockOrError struct {
+ block Block
+ err error
+}
+
+func Is(b Block) BlockOrError {
+ return BlockOrError{block: b}
+}
+func IsNot(err error) BlockOrError {
+ return BlockOrError{err: err}
+}
+
+func (boe BlockOrError) Get() (Block, error) {
+ return boe.block, boe.err
+}

examples/go.mod

@@ -12,9 +12,10 @@ require (
  github.com/ipfs/go-libipfs v0.4.0
  github.com/ipfs/go-merkledag v0.9.0
  github.com/ipfs/go-path v0.3.0
- github.com/ipfs/go-unixfs v0.3.1
+ github.com/ipfs/go-unixfs v0.4.2
  github.com/ipfs/go-unixfsnode v1.5.1
  github.com/ipfs/interface-go-ipfs-core v0.10.0
+ github.com/ipld/go-car v0.6.0
  github.com/ipld/go-car/v2 v2.6.0
  github.com/ipld/go-codec-dagpb v1.5.0
  github.com/ipld/go-ipld-prime v0.19.0
@@ -43,7 +44,6 @@ require (
  github.com/ipfs/go-datastore v0.6.0 // indirect
  github.com/ipfs/go-ipfs-ds-help v1.1.0 // indirect
  github.com/ipfs/go-ipfs-exchange-interface v0.2.0 // indirect
- github.com/ipfs/go-ipfs-files v0.3.0 // indirect
  github.com/ipfs/go-ipfs-redirects-file v0.1.1 // indirect
  github.com/ipfs/go-ipfs-util v0.0.2 // indirect
  github.com/ipfs/go-ipld-cbor v0.0.6 // indirect
@@ -53,7 +53,6 @@ require (
  github.com/ipfs/go-log/v2 v2.5.1 // indirect
  github.com/ipfs/go-metrics-interface v0.0.1 // indirect
  github.com/ipfs/go-verifcid v0.0.2 // indirect
- github.com/ipld/go-car v0.5.0 // indirect
  github.com/jbenet/goprocess v0.1.4 // indirect
  github.com/klauspost/cpuid/v2 v2.2.3 // indirect
  github.com/libp2p/go-buffer-pool v0.1.0 // indirect
@@ -91,7 +90,7 @@ require (
  go.uber.org/multierr v1.9.0 // indirect
  go.uber.org/zap v1.24.0 // indirect
  golang.org/x/crypto v0.5.0 // indirect
- golang.org/x/exp v0.0.0-20230129154200-a960b3787bd2 // indirect
+ golang.org/x/exp v0.0.0-20230131160201-f062dba9d201 // indirect
  golang.org/x/net v0.5.0 // indirect
  golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4 // indirect
  golang.org/x/sys v0.4.0 // indirect

examples/go.sum

@@ -397,8 +397,6 @@ github.com/ipfs/go-ipfs-exchange-offline v0.1.1/go.mod h1:vTiBRIbzSwDD0OWm+i3xeT
 github.com/ipfs/go-ipfs-exchange-offline v0.3.0 h1:c/Dg8GDPzixGd0MC8Jh6mjOwU57uYokgWRFidfvEkuA=
 github.com/ipfs/go-ipfs-exchange-offline v0.3.0/go.mod h1:MOdJ9DChbb5u37M1IcbrRB02e++Z7521fMxqCNRrz9s=
 github.com/ipfs/go-ipfs-files v0.0.3/go.mod h1:INEFm0LL2LWXBhNJ2PMIIb2w45hpXgPjNoE7yA8Y1d4=
-github.com/ipfs/go-ipfs-files v0.3.0 h1:fallckyc5PYjuMEitPNrjRfpwl7YFt69heCOUhsbGxQ=
-github.com/ipfs/go-ipfs-files v0.3.0/go.mod h1:xAUtYMwB+iu/dtf6+muHNSFQCJG2dSiStR2P6sn9tIM=
 github.com/ipfs/go-ipfs-posinfo v0.0.1 h1:Esoxj+1JgSjX0+ylc0hUmJCOv6V2vFoZiETLR6OtpRs=
 github.com/ipfs/go-ipfs-posinfo v0.0.1/go.mod h1:SwyeVP+jCwiDu0C313l/8jg6ZxM0qqtlt2a0vILTc1A=
 github.com/ipfs/go-ipfs-pq v0.0.1/go.mod h1:LWIqQpqfRG3fNc5XsnIhz/wQ2XXGyugQwls7BgUmUfY=
@@ -455,8 +453,8 @@ github.com/ipfs/go-peertaskqueue v0.1.0/go.mod h1:Jmk3IyCcfl1W3jTW3YpghSwSEC6IJ3
 github.com/ipfs/go-peertaskqueue v0.7.0/go.mod h1:M/akTIE/z1jGNXMU7kFB4TeSEFvj68ow0Rrb04donIU=
 github.com/ipfs/go-peertaskqueue v0.8.0 h1:JyNO144tfu9bx6Hpo119zvbEL9iQ760FHOiJYsUjqaU=
 github.com/ipfs/go-unixfs v0.2.4/go.mod h1:SUdisfUjNoSDzzhGVxvCL9QO/nKdwXdr+gbMUdqcbYw=
-github.com/ipfs/go-unixfs v0.3.1 h1:LrfED0OGfG98ZEegO4/xiprx2O+yS+krCMQSp7zLVv8=
-github.com/ipfs/go-unixfs v0.3.1/go.mod h1:h4qfQYzghiIc8ZNFKiLMFWOTzrWIAtzYQ59W/pCFf1o=
+github.com/ipfs/go-unixfs v0.4.2 h1:hdQlsHHK5tek9gC9mjGVua8xyTqC+eopGseCRcbCZNg=
+github.com/ipfs/go-unixfs v0.4.2/go.mod h1:L+x6JRlFE0PfyMqeoLYVOKLhn5IeZHvNT7ZI51Y9Qyc=
 github.com/ipfs/go-unixfsnode v1.1.2/go.mod h1:5dcE2x03pyjHk4JjamXmunTMzz+VUtqvPwZjIEkfV6s=
 github.com/ipfs/go-unixfsnode v1.5.1 h1:JcR3t5C2nM1V7PMzhJ/Qmo19NkoFIKweDSZyDx+CjkI=
 github.com/ipfs/go-unixfsnode v1.5.1/go.mod h1:ed79DaG9IEuZITJVQn4U6MZDftv6I3ygUBLPfhEbHvk=
@@ -465,8 +463,8 @@ github.com/ipfs/go-verifcid v0.0.2 h1:XPnUv0XmdH+ZIhLGKg6U2vaPaRDXb9urMyNVCE7uvT
 github.com/ipfs/go-verifcid v0.0.2/go.mod h1:40cD9x1y4OWnFXbLNJYRe7MpNvWlMn3LZAG5Wb4xnPU=
 github.com/ipfs/interface-go-ipfs-core v0.10.0 h1:b/psL1oqJcySdQAsIBfW5ZJJkOAsYlhWtC0/Qvr4WiM=
 github.com/ipfs/interface-go-ipfs-core v0.10.0/go.mod h1:F3EcmDy53GFkF0H3iEJpfJC320fZ/4G60eftnItrrJ0=
-github.com/ipld/go-car v0.5.0 h1:kcCEa3CvYMs0iE5BzD5sV7O2EwMiCIp3uF8tA6APQT8=
-github.com/ipld/go-car v0.5.0/go.mod h1:ppiN5GWpjOZU9PgpAZ9HbZd9ZgSpwPMr48fGRJOWmvE=
+github.com/ipld/go-car v0.6.0 h1:d5QrGLnHAxiNLHor+DKGrLdqnM0dQJh2whfSXRDq6J0=
+github.com/ipld/go-car v0.6.0/go.mod h1:tBrW1XZ3L2XipLxA69RnTVGW3rve6VX4TbaTYkq8aEA=
 github.com/ipld/go-car/v2 v2.6.0 h1:UTJmJ99nxgYpPueoaZ1GrFQtUDe9QnVLlHYTNDSDb90=
 github.com/ipld/go-car/v2 v2.6.0/go.mod h1:qoqfgPnQYcaAYcfphctffdaNWJIWBR2QN4pjuKUtgao=
 github.com/ipld/go-codec-dagpb v1.3.0/go.mod h1:ga4JTU3abYApDC3pZ00BC2RSvC3qfBb9MSJkMLSwnhA=
@@ -1144,8 +1142,8 @@ golang.org/x/exp v0.0.0-20191227195350-da58074b4299/go.mod h1:2RIsYlXP63K8oxa1u0
 golang.org/x/exp v0.0.0-20200119233911-0405dc783f0a/go.mod h1:2RIsYlXP63K8oxa1u096TMicItID8zy7Y6sNkU49FU4=
 golang.org/x/exp v0.0.0-20200207192155-f17229e696bd/go.mod h1:J/WKrq2StrnmMY6+EHIKF9dgMWnmCNThgcyBT1FY9mM=
 golang.org/x/exp v0.0.0-20200224162631-6cc2880d07d6/go.mod h1:3jZMyOhIsHpP37uCMkUooju7aAi5cS1Q23tOzKc+0MU=
-golang.org/x/exp v0.0.0-20230129154200-a960b3787bd2 h1:5sPMf9HJXrvBWIamTw+rTST0bZ3Mho2n1p58M0+W99c=
-golang.org/x/exp v0.0.0-20230129154200-a960b3787bd2/go.mod h1:CxIveKay+FTh1D0yPZemJVgC/95VzuuOLq5Qi4xnoYc=
+golang.org/x/exp v0.0.0-20230131160201-f062dba9d201 h1:BEABXpNXLEz0WxtA+6CQIz2xkg80e+1zrhWyMcq8VzE=
+golang.org/x/exp v0.0.0-20230131160201-f062dba9d201/go.mod h1:CxIveKay+FTh1D0yPZemJVgC/95VzuuOLq5Qi4xnoYc=
 golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js=
 golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0=
 golang.org/x/lint v0.0.0-20180702182130-06c8688daad7/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=

examples/rapido/README.md

@@ -0,0 +1,11 @@
+# RAPIDO
+
+RAPIDO is an example CLI which download an unordered `.car` for some unixfs data from multiple gateways using [`rapide`](../../rapide).
+
+This code is not maintained up to "production ready" standars, this is an example demonstrating how to use RAPIDE.
+
+## Usage
+
+```console
+$ rapido -gw https://ipfs.io/ipfs/ -gw https://strn.pl/ipfs/ QmT2EHPdRvUDxiuZBbYg5ZHy1f8L6MY1HxD45zHycLobMJ | pv > 2023-02-03.ipfs.io.car
+```

examples/rapido/main.go

@@ -0,0 +1,83 @@
+package main
+
+import (
+ "context"
+ "flag"
+ "fmt"
+ "os"
+ "strings"
+
+ "github.com/ipfs/go-cid"
+ "github.com/ipfs/go-libipfs/ipsl/unixfs"
+ "github.com/ipfs/go-libipfs/rapide"
+ "github.com/ipfs/go-libipfs/rapide/gateway"
+ "github.com/ipld/go-car"
+ "github.com/ipld/go-car/util"
+)
+
+type stringFlagSlice []string
+
+func (sfs *stringFlagSlice) String() string {
+ return strings.Join(*sfs, ",")
+}
+
+func (sfs *stringFlagSlice) Set(s string) error {
+ *sfs = append(*sfs, s)
+ return nil
+}
+
+func main() {
+ err := mainRet()
+ if err != nil {
+ os.Stderr.WriteString(err.Error())
+ os.Exit(1)
+ }
+ os.Exit(0)
+}
+
+func mainRet() error {
+ // Argument Parsing
+ var gateways stringFlagSlice
+ flag.Var(&gateways, "gw", `Set once to add a gateway, setable multiple times to use multiple gateways. Format expected is "-gw https://ipfs.io/ipfs/" for example.`)
+ flag.Parse()
+
+ cidStrs := flag.Args()
+ if len(cidStrs) != 1 {
+ return fmt.Errorf("expected one CID as positional argument; got %d", len(cidStrs))
+ }
+
+ root, err := cid.Decode(cidStrs[0])
+ if err != nil {
+ return fmt.Errorf("decoding CID: %w", err)
+ }
+
+ // Setup header for the output car
+ err = car.WriteHeader(&car.CarHeader{
+ Roots: []cid.Cid{root},
+ Version: 1,
+ }, os.Stdout)
+ if err != nil {
+ return fmt.Errorf("writing car header: %w", err)
+ }
+
+ // configure rapide
+ downloaders := make([]rapide.ServerDrivenDownloader, len(gateways)) // create a slice holding our multiple gateways
+ for i, g := range gateways {
+ downloaders[i] = gateway.Gateway{PathName: g} // create a gateway protocol implementation
+ }
+ client := rapide.Client{ServerDrivenDownloaders: downloaders}
+
+ // do request and iterate over the resulting blocks, rapide.(*Client).Get returns a channel
+ for maybeBlock := range client.Get(context.Background(), root, unixfs.Everything()) {
+ block, err := maybeBlock.Get() // block or error ?
+ if err != nil {
+ return fmt.Errorf("downloading: %w", err)
+ }
+ err = util.LdWrite(os.Stdout, block.Cid().Bytes(), block.RawData()) // write to the output car
+ if err != nil {
+ return fmt.Errorf("writing to output car: %w", err)
+ }
+ }
+
+ return nil
+}

go.mod

@@ -12,25 +12,30 @@ require (
  github.com/gogo/protobuf v1.3.2
  github.com/google/uuid v1.3.0
  github.com/gorilla/mux v1.8.0
+ github.com/ipfs/go-blockservice v0.5.0
  github.com/ipfs/go-cid v0.3.2
  github.com/ipfs/go-datastore v0.6.0
  github.com/ipfs/go-detect-race v0.0.1
  github.com/ipfs/go-ipfs-blockstore v1.2.0
  github.com/ipfs/go-ipfs-blocksutil v0.0.1
  github.com/ipfs/go-ipfs-delay v0.0.1
  github.com/ipfs/go-ipfs-exchange-interface v0.2.0
+ github.com/ipfs/go-ipfs-exchange-offline v0.3.0
  github.com/ipfs/go-ipfs-redirects-file v0.1.1
  github.com/ipfs/go-ipfs-routing v0.3.0
  github.com/ipfs/go-ipfs-util v0.0.2
  github.com/ipfs/go-ipld-format v0.4.0
  github.com/ipfs/go-ipns v0.3.0
  github.com/ipfs/go-log v1.0.5
  github.com/ipfs/go-log/v2 v2.5.1
+ github.com/ipfs/go-merkledag v0.9.0
  github.com/ipfs/go-metrics-interface v0.0.1
  github.com/ipfs/go-path v0.3.0
  github.com/ipfs/go-peertaskqueue v0.8.0
+ github.com/ipfs/go-unixfs v0.4.2
  github.com/ipfs/interface-go-ipfs-core v0.10.0
  github.com/ipld/go-car v0.5.0
+ github.com/ipld/go-car/v2 v2.6.0
  github.com/ipld/go-ipld-prime v0.19.0
  github.com/jbenet/goprocess v0.1.4
  github.com/libp2p/go-buffer-pool v0.1.0
@@ -40,18 +45,19 @@ require (
  github.com/libp2p/go-msgio v0.2.0
  github.com/multiformats/go-multiaddr v0.8.0
  github.com/multiformats/go-multibase v0.1.1
- github.com/multiformats/go-multicodec v0.6.0
+ github.com/multiformats/go-multicodec v0.7.0
  github.com/multiformats/go-multihash v0.2.1
  github.com/multiformats/go-multistream v0.3.3
  github.com/prometheus/client_golang v1.13.0
  github.com/samber/lo v1.36.0
  github.com/stretchr/testify v1.8.1
  go.opencensus.io v0.23.0
- go.opentelemetry.io/otel v1.7.0
- go.opentelemetry.io/otel/trace v1.7.0
- go.uber.org/multierr v1.8.0
- go.uber.org/zap v1.23.0
- golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab
+ go.opentelemetry.io/otel v1.12.0
+ go.opentelemetry.io/otel/trace v1.12.0
+ go.uber.org/multierr v1.9.0
+ go.uber.org/zap v1.24.0
+ golang.org/x/exp v0.0.0-20230131160201-f062dba9d201
+ golang.org/x/sys v0.4.0
 )
 
 require (
@@ -67,17 +73,15 @@ require (
  github.com/huin/goupnp v1.0.3 // indirect
  github.com/ipfs/bbloom v0.0.4 // indirect
  github.com/ipfs/go-block-format v0.1.1 // indirect
- github.com/ipfs/go-blockservice v0.5.0 // indirect
  github.com/ipfs/go-fetcher v1.6.1 // indirect
  github.com/ipfs/go-ipfs-ds-help v1.1.0 // indirect
  github.com/ipfs/go-ipfs-pq v0.0.2 // indirect
  github.com/ipfs/go-ipld-cbor v0.0.6 // indirect
  github.com/ipfs/go-ipld-legacy v0.1.1 // indirect
- github.com/ipfs/go-merkledag v0.9.0 // indirect
  github.com/ipfs/go-verifcid v0.0.2 // indirect
  github.com/ipld/go-codec-dagpb v1.5.0 // indirect
  github.com/jackpal/go-nat-pmp v1.0.2 // indirect
- github.com/klauspost/cpuid/v2 v2.1.2 // indirect
+ github.com/klauspost/cpuid/v2 v2.2.3 // indirect
  github.com/koron/go-ssdp v0.0.3 // indirect
  github.com/libp2p/go-cidranger v1.1.0 // indirect
  github.com/libp2p/go-libp2p-asn-util v0.2.0 // indirect
@@ -91,29 +95,28 @@ require (
  github.com/minio/sha256-simd v1.0.0 // indirect
  github.com/mr-tron/base58 v1.2.0 // indirect
  github.com/multiformats/go-base32 v0.1.0 // indirect
- github.com/multiformats/go-base36 v0.1.0 // indirect
+ github.com/multiformats/go-base36 v0.2.0 // indirect
  github.com/multiformats/go-multiaddr-dns v0.3.1 // indirect
  github.com/multiformats/go-multiaddr-fmt v0.1.0 // indirect
  github.com/multiformats/go-varint v0.0.7 // indirect
  github.com/opentracing/opentracing-go v1.2.0 // indirect
  github.com/pkg/errors v0.9.1 // indirect
  github.com/pmezard/go-difflib v1.0.0 // indirect
- github.com/polydawn/refmt v0.0.0-20201211092308-30ac6d18308e // indirect
+ github.com/polydawn/refmt v0.89.0 // indirect
  github.com/prometheus/client_model v0.2.0 // indirect
  github.com/prometheus/common v0.37.0 // indirect
  github.com/prometheus/procfs v0.8.0 // indirect
  github.com/spacemonkeygo/spacelog v0.0.0-20180420211403-2296661a0572 // indirect
  github.com/spaolacci/murmur3 v1.1.0 // indirect
  github.com/stretchr/objx v0.5.0 // indirect
  github.com/ucarion/urlpath v0.0.0-20200424170820-7ccc79b76bbb // indirect
- github.com/whyrusleeping/cbor-gen v0.0.0-20221220214510-0333c149dec0 // indirect
+ github.com/whyrusleeping/cbor-gen v0.0.0-20230126041949-52956bd4c9aa // indirect
  go.uber.org/atomic v1.10.0 // indirect
- golang.org/x/crypto v0.0.0-20220525230936-793ad666bf5e // indirect
- golang.org/x/exp v0.0.0-20220916125017-b168a2c6b86b // indirect
- golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 // indirect
- golang.org/x/net v0.0.0-20220920183852-bf014ff85ad5 // indirect
+ golang.org/x/crypto v0.5.0 // indirect
+ golang.org/x/mod v0.6.0 // indirect
+ golang.org/x/net v0.5.0 // indirect
  golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4 // indirect
- golang.org/x/tools v0.1.12 // indirect
+ golang.org/x/tools v0.2.0 // indirect
  golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
  google.golang.org/protobuf v1.28.1 // indirect
  gopkg.in/yaml.v3 v3.0.1 // indirect