Compare commits
157 Commits
feat/cbor-
...
v0.6.0
| Author | SHA1 | Date | |
|---|---|---|---|
| cf0ccd2f6e | |||
| a7a1f319b3 | |||
| 8c8b22eab1 | |||
| af732567fd | |||
|
|
1b3fc58457 | ||
|
|
594b41a340 | ||
|
|
7942a87de8 | ||
|
|
6365bffd65 | ||
|
|
1022508918 | ||
|
|
1afa3fef92 | ||
|
|
3b830eb57c | ||
|
|
4d43496971 | ||
|
|
5cddba5d53 | ||
|
|
c38d1ef3f4 | ||
|
|
7f61b44eb9 | ||
|
|
13ed68d2d7 | ||
|
|
b655a59a8a | ||
|
|
81bd42a55c | ||
|
|
23af06e490 | ||
|
|
52653019a7 | ||
|
|
11e146d86d | ||
|
|
91f1b23adf | ||
|
|
607591de0b | ||
|
|
93d2928381 | ||
|
|
1f9bd88a8e | ||
|
|
f6805b41a0 | ||
|
|
01aca4cad3 | ||
|
|
9b08623b01 | ||
|
|
1399b513f9 | ||
|
|
00c494db15 | ||
|
|
d1e16392a7 | ||
|
|
af4cf3c53a | ||
|
|
01fcc60a8c | ||
|
|
663c9b30cf | ||
|
|
4a2ad46e4c | ||
|
|
a126b93d54 | ||
|
|
7db2df1954 | ||
|
|
d900d766af | ||
|
|
aea9f4a20c | ||
|
|
6bf5ab9148 | ||
|
|
ef021a6454 | ||
|
|
13f45bfa17 | ||
|
|
4828462368 | ||
|
|
e12272217c | ||
|
|
3863e676fd | ||
|
|
9a3cbeb6a0 | ||
|
|
f834302da4 | ||
|
|
6b3d27fb29 | ||
|
|
829c826f6b | ||
|
|
8bb6c55e54 | ||
|
|
72c7f21dcd | ||
|
|
93a8da769f | ||
|
|
d46e7f2866 | ||
|
|
83a0e939a4 | ||
|
|
0981f8566c | ||
|
|
166a3a6880 | ||
|
|
8098d66787 | ||
|
|
b98e249130 | ||
|
|
85c423677c | ||
|
|
197da0b712 | ||
|
|
06fe289a6a | ||
|
|
a1630a3bd9 | ||
|
|
225f5db116 | ||
|
|
c2c040dac7 | ||
|
|
b729e38c6e | ||
|
|
823c6b8a59 | ||
|
|
350d6afb62 | ||
|
|
68090a8273 | ||
|
|
69784e9dd7 | ||
|
|
548365f3a7 | ||
|
|
5da28005a9 | ||
|
|
7f6771bc54 | ||
|
|
5b6a9dce73 | ||
|
|
890f55d9f3 | ||
|
|
085afa84d0 | ||
|
|
0052a62190 | ||
|
|
802b45594e | ||
|
|
8f7d7ac18e | ||
|
|
b106e0883a | ||
|
|
386c6cc18a | ||
|
|
f4b3e66993 | ||
|
|
b2064d74a8 | ||
|
|
ddd9ef7248 | ||
|
|
6be8b631d0 | ||
|
|
395d392889 | ||
|
|
1d11990417 | ||
|
|
dc3bb41324 | ||
|
|
28f4a5eab6 | ||
|
|
5640b0169f | ||
|
|
cf76220258 | ||
|
|
9e2855d9ff | ||
|
|
b8eba8ea35 | ||
|
|
2628583977 | ||
|
|
6e96c56557 | ||
|
|
44cccd62db | ||
|
|
de6c03deae | ||
|
|
c4c8760a80 | ||
|
|
8e9280df3d | ||
|
|
b4bcfe45c9 | ||
|
|
979bf3fb85 | ||
|
|
95ec98a9cc | ||
|
|
1c23d3b694 | ||
|
|
5b5d1329c5 | ||
|
|
a42c04af93 | ||
|
|
0582f6b9b2 | ||
|
|
0717510dfb | ||
|
|
e530276a70 | ||
|
|
45f4147a06 | ||
|
|
b34ad3cfa5 | ||
|
|
ec089b8a53 | ||
|
|
efe2d2de45 | ||
|
|
46aac88838 | ||
|
|
f60e346b24 | ||
|
|
8647a1d84b | ||
|
|
de49849130 | ||
|
|
8b9ff3906e | ||
|
|
f7cb4c91eb | ||
|
|
85cd30874e | ||
|
|
12e2623f35 | ||
|
|
d683e9243c | ||
|
|
18af217de6 | ||
|
|
9830f823b5 | ||
|
|
d110f73c43 | ||
|
|
95a7ed4233 | ||
|
|
8dd6fe2778 | ||
|
|
a25d68f3e4 | ||
|
|
7c82f3b81c | ||
|
|
75caa6bdbd | ||
|
|
c1c89c20c1 | ||
|
|
628a0123ed | ||
|
|
266e76d591 | ||
|
|
7d7cb88d78 | ||
|
|
723b4ab105 | ||
|
|
9cb3848e51 | ||
|
|
f458e04107 | ||
|
|
72cd3d39d7 | ||
|
|
c1b740035a | ||
|
|
3da5bbbe45 | ||
|
|
9d598bbdbd | ||
|
|
b420452400 | ||
|
|
ed7dab1755 | ||
|
|
5df89959a0 | ||
|
|
60ab0f84f0 | ||
|
|
08e15f8a6c | ||
|
|
58b483a841 | ||
|
|
79e75dffeb | ||
|
|
d93d4baeab | ||
|
|
cf8cf8856e | ||
|
|
aa8072eeb5 | ||
|
|
51871ccaa9 | ||
|
|
9238d1a533 | ||
|
|
16bbe1cf14 | ||
|
|
c91a795815 | ||
|
|
64acce09e1 | ||
|
|
2a2f67d2c4 | ||
|
|
86ca2a8300 | ||
|
|
e0a778be45 |
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Getting Help on IPFS
|
||||
url: https://ipfs.io/help
|
||||
about: All information about how and where to get help on IPFS.
|
||||
- name: IPFS Official Forum
|
||||
url: https://discuss.ipfs.io
|
||||
about: Please post general questions, support requests, and discussions here.
|
||||
19
.github/ISSUE_TEMPLATE/open_an_issue.md
vendored
Normal file
19
.github/ISSUE_TEMPLATE/open_an_issue.md
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
name: Open an issue
|
||||
about: Only for actionable issues relevant to this repository.
|
||||
title: ''
|
||||
labels: need/triage
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
<!--
|
||||
Hello! To ensure this issue is correctly addressed as soon as possible by the IPFS team, please try to make sure:
|
||||
|
||||
- This issue is relevant to this repository's topic or codebase.
|
||||
|
||||
- A clear description is provided. It should includes as much relevant information as possible and clear scope for the issue to be actionable.
|
||||
|
||||
FOR GENERAL DISCUSSION, HELP OR QUESTIONS, please see the options at https://ipfs.io/help or head directly to https://discuss.ipfs.io.
|
||||
|
||||
(you can delete this section after reading)
|
||||
-->
|
||||
7
.github/Repo.toml
vendored
Normal file
7
.github/Repo.toml
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
[scopes]
|
||||
ci = [".github/workflows"]
|
||||
config = [".github", "codecov.yml", "go.mod", "go.sum", "Makefile", "version.json"]
|
||||
docs = ["README.md", "LICENSE"]
|
||||
tests = ["*_test.go", "fuzz-data"]
|
||||
research = ["_rsrch"]
|
||||
core = ["cid.go", "builder.go", "set.go", "varint.go", "cid_fuzz.go", "deprecated.go"]
|
||||
68
.github/config.yml
vendored
Normal file
68
.github/config.yml
vendored
Normal file
@@ -0,0 +1,68 @@
|
||||
# Configuration for welcome - https://github.com/behaviorbot/welcome
|
||||
|
||||
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
|
||||
# Comment to be posted to on first time issues
|
||||
newIssueWelcomeComment: >
|
||||
Thank you for submitting your first issue to this repository! A maintainer
|
||||
will be here shortly to triage and review.
|
||||
|
||||
In the meantime, please double-check that you have provided all the
|
||||
necessary information to make this process easy! Any information that can
|
||||
help save additional round trips is useful! We currently aim to give
|
||||
initial feedback within **two business days**. If this does not happen, feel
|
||||
free to leave a comment.
|
||||
|
||||
Please keep an eye on how this issue will be labeled, as labels give an
|
||||
overview of priorities, assignments and additional actions requested by the
|
||||
maintainers:
|
||||
|
||||
- "Priority" labels will show how urgent this is for the team.
|
||||
- "Status" labels will show if this is ready to be worked on, blocked, or in progress.
|
||||
- "Need" labels will indicate if additional input or analysis is required.
|
||||
|
||||
Finally, remember to use https://discuss.ipfs.io if you just need general
|
||||
support.
|
||||
|
||||
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
|
||||
# Comment to be posted to on PRs from first time contributors in your repository
|
||||
newPRWelcomeComment: >
|
||||
Thank you for submitting this PR!
|
||||
|
||||
A maintainer will be here shortly to review it.
|
||||
|
||||
We are super grateful, but we are also overloaded! Help us by making sure
|
||||
that:
|
||||
|
||||
* The context for this PR is clear, with relevant discussion, decisions
|
||||
and stakeholders linked/mentioned.
|
||||
|
||||
* Your contribution itself is clear (code comments, self-review for the
|
||||
rest) and in its best form. Follow the [code contribution
|
||||
guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md#code-contribution-guidelines)
|
||||
if they apply.
|
||||
|
||||
Getting other community members to do a review would be great help too on
|
||||
complex PRs (you can ask in the chats/forums). If you are unsure about
|
||||
something, just leave us a comment.
|
||||
|
||||
Next steps:
|
||||
|
||||
* A maintainer will triage and assign priority to this PR, commenting on
|
||||
any missing things and potentially assigning a reviewer for high
|
||||
priority items.
|
||||
|
||||
* The PR gets reviews, discussed and approvals as needed.
|
||||
|
||||
* The PR is merged by maintainers when it has been approved and comments addressed.
|
||||
|
||||
We currently aim to provide initial feedback/triaging within **two business
|
||||
days**. Please keep an eye on any labelling actions, as these will indicate
|
||||
priorities and status of your contribution.
|
||||
|
||||
We are very grateful for your contribution!
|
||||
|
||||
|
||||
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
|
||||
# Comment to be posted to on pull requests merged by a first time user
|
||||
# Currently disabled
|
||||
#firstPRMergeComment: ""
|
||||
8
.github/dependabot.yml
vendored
Normal file
8
.github/dependabot.yml
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: gomod
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: weekly
|
||||
time: "11:00"
|
||||
open-pull-requests-limit: 10
|
||||
14
.github/workflows/generated-pr.yml
vendored
Normal file
14
.github/workflows/generated-pr.yml
vendored
Normal file
@@ -0,0 +1,14 @@
|
||||
name: Close Generated PRs
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 0 * * *'
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
issues: write
|
||||
pull-requests: write
|
||||
|
||||
jobs:
|
||||
stale:
|
||||
uses: ipdxco/unified-github-workflows/.github/workflows/reusable-generated-pr.yml@v1
|
||||
18
.github/workflows/go-check.yml
vendored
Normal file
18
.github/workflows/go-check.yml
vendored
Normal file
@@ -0,0 +1,18 @@
|
||||
name: Go Checks
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches: ["master"]
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event_name == 'push' && github.sha || github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
go-check:
|
||||
uses: ipdxco/unified-github-workflows/.github/workflows/go-check.yml@v1.0
|
||||
20
.github/workflows/go-test.yml
vendored
Normal file
20
.github/workflows/go-test.yml
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
name: Go Test
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
branches: ["master"]
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event_name == 'push' && github.sha || github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
go-test:
|
||||
uses: ipdxco/unified-github-workflows/.github/workflows/go-test.yml@v1.0
|
||||
secrets:
|
||||
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
|
||||
19
.github/workflows/release-check.yml
vendored
Normal file
19
.github/workflows/release-check.yml
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
name: Release Checker
|
||||
|
||||
on:
|
||||
pull_request_target:
|
||||
paths: [ 'version.json' ]
|
||||
types: [ opened, synchronize, reopened, labeled, unlabeled ]
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
release-check:
|
||||
uses: ipdxco/unified-github-workflows/.github/workflows/release-check.yml@v1.0
|
||||
17
.github/workflows/releaser.yml
vendored
Normal file
17
.github/workflows/releaser.yml
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
name: Releaser
|
||||
|
||||
on:
|
||||
push:
|
||||
paths: [ 'version.json' ]
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.sha }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
releaser:
|
||||
uses: ipdxco/unified-github-workflows/.github/workflows/releaser.yml@v1.0
|
||||
14
.github/workflows/stale.yml
vendored
Normal file
14
.github/workflows/stale.yml
vendored
Normal file
@@ -0,0 +1,14 @@
|
||||
name: Close Stale Issues
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 0 * * *'
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
issues: write
|
||||
pull-requests: write
|
||||
|
||||
jobs:
|
||||
stale:
|
||||
uses: ipdxco/unified-github-workflows/.github/workflows/reusable-stale-issue.yml@v1
|
||||
18
.github/workflows/tagpush.yml
vendored
Normal file
18
.github/workflows/tagpush.yml
vendored
Normal file
@@ -0,0 +1,18 @@
|
||||
name: Tag Push Checker
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- v*
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
issues: write
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
releaser:
|
||||
uses: ipdxco/unified-github-workflows/.github/workflows/tagpush.yml@v1.0
|
||||
@@ -1 +0,0 @@
|
||||
0.9.3: QmTbxNB1NwDesLmKTscr4udL2tVP7MaxvXnD1D9yX7g3PN
|
||||
30
.travis.yml
30
.travis.yml
@@ -1,30 +0,0 @@
|
||||
os:
|
||||
- linux
|
||||
|
||||
language: go
|
||||
|
||||
go:
|
||||
- 1.11.x
|
||||
|
||||
env:
|
||||
global:
|
||||
- GOTFLAGS="-race"
|
||||
matrix:
|
||||
- BUILD_DEPTYPE=gomod
|
||||
|
||||
|
||||
# disable travis install
|
||||
install:
|
||||
- true
|
||||
|
||||
script:
|
||||
- bash <(curl -s https://raw.githubusercontent.com/ipfs/ci-helpers/master/travis-ci/run-standard-tests.sh)
|
||||
|
||||
|
||||
cache:
|
||||
directories:
|
||||
- $GOPATH/pkg/mod
|
||||
- $HOME/.cache/go-build
|
||||
|
||||
notifications:
|
||||
email: false
|
||||
5
Makefile
Normal file
5
Makefile
Normal file
@@ -0,0 +1,5 @@
|
||||
all: deps
|
||||
|
||||
deps:
|
||||
go get github.com/mattn/goveralls
|
||||
go get golang.org/x/tools/cmd/cover
|
||||
24
README.md
24
README.md
@@ -5,7 +5,7 @@ go-cid
|
||||
[](http://ipfs.io/)
|
||||
[](http://webchat.freenode.net/?channels=%23ipfs)
|
||||
[](https://github.com/RichardLitt/standard-readme)
|
||||
[](https://godoc.org/github.com/ipfs/go-cid)
|
||||
[](https://godoc.org/code.sonr.org/go/cid)
|
||||
[](https://coveralls.io/github/ipfs/go-cid?branch=master)
|
||||
[](https://travis-ci.org/ipfs/go-cid)
|
||||
|
||||
@@ -14,6 +14,9 @@ go-cid
|
||||
This is an implementation in Go of the [CID spec](https://github.com/ipld/cid).
|
||||
It is used in `go-ipfs` and related packages to refer to a typed hunk of data.
|
||||
|
||||
## Lead Maintainer
|
||||
|
||||
[Eric Myhre](https://github.com/warpfork)
|
||||
|
||||
## Table of Contents
|
||||
|
||||
@@ -28,23 +31,19 @@ It is used in `go-ipfs` and related packages to refer to a typed hunk of data.
|
||||
`go-cid` is a standard Go module which can be installed with:
|
||||
|
||||
```sh
|
||||
go get github.com/ipfs/go-cid
|
||||
go get code.sonr.org/go/cid
|
||||
```
|
||||
|
||||
Note that `go-cid` is packaged with Gx, so it is recommended to use Gx to install and use it (see Usage section).
|
||||
|
||||
## Usage
|
||||
|
||||
### Running tests
|
||||
|
||||
Before running tests, please run:
|
||||
Run tests with `go test` from the directory root
|
||||
|
||||
```sh
|
||||
make deps
|
||||
go test
|
||||
```
|
||||
|
||||
This will make sure that dependencies are rewritten to known working versions.
|
||||
|
||||
### Examples
|
||||
|
||||
#### Parsing string input from users
|
||||
@@ -60,10 +59,17 @@ fmt.Println("Got CID: ", c)
|
||||
#### Creating a CID from scratch
|
||||
|
||||
```go
|
||||
|
||||
import (
|
||||
cid "code.sonr.org/go/cid"
|
||||
mc "github.com/multiformats/go-multicodec"
|
||||
mh "github.com/multiformats/go-multihash"
|
||||
)
|
||||
|
||||
// Create a cid manually by specifying the 'prefix' parameters
|
||||
pref := cid.Prefix{
|
||||
Version: 1,
|
||||
Codec: cid.Raw,
|
||||
Codec: uint64(mc.Raw),
|
||||
MhType: mh.SHA2_256,
|
||||
MhLength: -1, // default length
|
||||
}
|
||||
|
||||
@@ -39,7 +39,8 @@ type Cid interface {
|
||||
// and the Multihash length. It does not contains
|
||||
// any actual content information.
|
||||
// NOTE: The use -1 in MhLength to mean default length is deprecated,
|
||||
// use the V0Builder or V1Builder structures instead
|
||||
//
|
||||
// use the V0Builder or V1Builder structures instead
|
||||
type Prefix struct {
|
||||
Version uint64
|
||||
Codec uint64
|
||||
@@ -12,14 +12,14 @@ import (
|
||||
//
|
||||
// Sample results on linux amd64 go1.11beta:
|
||||
//
|
||||
// BenchmarkCidMap_CidStr-8 100000 16317 ns/op
|
||||
// BenchmarkCidMap_CidIface-8 100000 20516 ns/op
|
||||
// BenchmarkCidMap_CidStr-8 100000 16317 ns/op
|
||||
// BenchmarkCidMap_CidIface-8 100000 20516 ns/op
|
||||
//
|
||||
// With benchmem on:
|
||||
//
|
||||
// BenchmarkCidMap_CidStr-8 100000 15579 ns/op 11223 B/op 207 allocs/op
|
||||
// BenchmarkCidMap_CidIface-8 100000 19500 ns/op 12824 B/op 307 allocs/op
|
||||
// BenchmarkCidMap_StrPlusHax-8 200000 10451 ns/op 7589 B/op 202 allocs/op
|
||||
// BenchmarkCidMap_CidStr-8 100000 15579 ns/op 11223 B/op 207 allocs/op
|
||||
// BenchmarkCidMap_CidIface-8 100000 19500 ns/op 12824 B/op 307 allocs/op
|
||||
// BenchmarkCidMap_StrPlusHax-8 200000 10451 ns/op 7589 B/op 202 allocs/op
|
||||
//
|
||||
// We can see here that the impact of interface boxing is significant:
|
||||
// it increases the time taken to do the inserts to 133%, largely because
|
||||
@@ -36,7 +36,6 @@ import (
|
||||
// re-arranges itself, it involves more or less an O(n) copy of the content
|
||||
// in addition to the alloc itself). This isn't topical to the question of
|
||||
// whether or not interfaces are a good idea; just for contextualizing.
|
||||
//
|
||||
func BenchmarkCidMap_CidStr(b *testing.B) {
|
||||
for i := 0; i < b.N; i++ {
|
||||
mp := map[CidStr]int{}
|
||||
@@ -114,7 +114,7 @@ func NewCidStr(version uint64, codecType uint64, mhash mh.Multihash) CidStr {
|
||||
//
|
||||
// For CidV1, the data buffer is in the form:
|
||||
//
|
||||
// <version><codec-type><multihash>
|
||||
// <version><codec-type><multihash>
|
||||
//
|
||||
// CidV0 are also supported. In particular, data buffers starting
|
||||
// with length 34 bytes, which starts with bytes [18,32...] are considered
|
||||
@@ -110,7 +110,7 @@ func (c CidStruct) Prefix() Prefix {
|
||||
//
|
||||
// For CidV1, the data buffer is in the form:
|
||||
//
|
||||
// <version><codec-type><multihash>
|
||||
// <version><codec-type><multihash>
|
||||
//
|
||||
// CidV0 are also supported. In particular, data buffers starting
|
||||
// with length 34 bytes, which starts with bytes [18,32...] are considered
|
||||
61
benchmark_test.go
Normal file
61
benchmark_test.go
Normal file
@@ -0,0 +1,61 @@
|
||||
package cid_test
|
||||
|
||||
import (
|
||||
"math/rand"
|
||||
"testing"
|
||||
|
||||
"code.sonr.org/go/cid"
|
||||
"github.com/multiformats/go-multihash"
|
||||
)
|
||||
|
||||
// BenchmarkIdentityCheck benchmarks two ways of checking whether a CIDv1 has multihash.IDENTITY
|
||||
// code:
|
||||
// 1. Cid.Prefix(), and
|
||||
// 2. decoding the Cid.Hash().
|
||||
//
|
||||
// This benchmark illustrates that using Cid.Prefix is more efficient than multihash.Decode.
|
||||
// Users wishing to perform such a check should use Cid.Prefix.
|
||||
//
|
||||
// Consider that `Cid.Prefix` is already efficient enough and introducing a dedicated API for
|
||||
// performing this check will likely result in small gains.
|
||||
func BenchmarkIdentityCheck(b *testing.B) {
|
||||
rng := rand.New(rand.NewSource(1413))
|
||||
|
||||
data := make([]byte, rng.Intn(100)+1024)
|
||||
if _, err := rng.Read(data); err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
mh, err := multihash.Sum(data, multihash.IDENTITY, -1)
|
||||
if err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
cv1 := cid.NewCidV1(cid.Raw, mh)
|
||||
|
||||
b.SetBytes(int64(cv1.ByteLen()))
|
||||
b.ReportAllocs()
|
||||
b.ResetTimer()
|
||||
|
||||
b.Run("Prefix", func(b *testing.B) {
|
||||
b.RunParallel(func(pb *testing.PB) {
|
||||
for pb.Next() {
|
||||
if cv1.Prefix().MhType != multihash.IDENTITY {
|
||||
b.Fatal("expected IDENTITY CID")
|
||||
}
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
b.Run("MultihashDecode", func(b *testing.B) {
|
||||
b.RunParallel(func(pb *testing.PB) {
|
||||
for pb.Next() {
|
||||
dmh, err := multihash.Decode(cv1.Hash())
|
||||
if err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
if dmh.Code != multihash.IDENTITY {
|
||||
b.Fatal("expected IDENTITY CID")
|
||||
}
|
||||
}
|
||||
})
|
||||
})
|
||||
}
|
||||
@@ -38,7 +38,7 @@ func (p V0Builder) Sum(data []byte) (Cid, error) {
|
||||
if err != nil {
|
||||
return Undef, err
|
||||
}
|
||||
return NewCidV0(hash), nil
|
||||
return Cid{string(hash)}, nil
|
||||
}
|
||||
|
||||
func (p V0Builder) GetCodec() uint64 {
|
||||
|
||||
@@ -65,9 +65,29 @@ func TestCodecChange(t *testing.T) {
|
||||
p := Prefix{Version: 1, Codec: DagProtobuf, MhType: mh.SHA2_256, MhLength: mh.DefaultLengths[mh.SHA2_256]}
|
||||
testCodecChange(t, p)
|
||||
})
|
||||
t.Run("Prefix-NoChange", func(t *testing.T) {
|
||||
p := Prefix{Version: 0, Codec: DagProtobuf, MhType: mh.SHA2_256, MhLength: mh.DefaultLengths[mh.SHA2_256]}
|
||||
if p.GetCodec() != DagProtobuf {
|
||||
t.Fatal("original builder not using Protobuf codec")
|
||||
}
|
||||
pn := p.WithCodec(DagProtobuf)
|
||||
if pn != p {
|
||||
t.Fatal("should have returned same builder")
|
||||
}
|
||||
})
|
||||
t.Run("V0Builder", func(t *testing.T) {
|
||||
testCodecChange(t, V0Builder{})
|
||||
})
|
||||
t.Run("V0Builder-NoChange", func(t *testing.T) {
|
||||
b := V0Builder{}
|
||||
if b.GetCodec() != DagProtobuf {
|
||||
t.Fatal("original builder not using Protobuf codec")
|
||||
}
|
||||
bn := b.WithCodec(DagProtobuf)
|
||||
if bn != b {
|
||||
t.Fatal("should have returned same builder")
|
||||
}
|
||||
})
|
||||
t.Run("V1Builder", func(t *testing.T) {
|
||||
testCodecChange(t, V1Builder{Codec: DagProtobuf, MhType: mh.SHA2_256})
|
||||
})
|
||||
|
||||
664
cid.go
664
cid.go
@@ -10,7 +10,7 @@
|
||||
//
|
||||
// A CIDv1 has four parts:
|
||||
//
|
||||
// <cidv1> ::= <multibase-prefix><cid-version><multicodec-packed-content-type><multihash-content-address>
|
||||
// <cidv1> ::= <multibase-prefix><cid-version><multicodec-packed-content-type><multihash-content-address>
|
||||
//
|
||||
// As shown above, the CID implementation relies heavily on Multiformats,
|
||||
// particularly Multibase
|
||||
@@ -31,158 +31,141 @@ import (
|
||||
|
||||
mbase "github.com/multiformats/go-multibase"
|
||||
mh "github.com/multiformats/go-multihash"
|
||||
|
||||
cbg "github.com/whyrusleeping/cbor-gen"
|
||||
varint "github.com/multiformats/go-varint"
|
||||
)
|
||||
|
||||
// UnsupportedVersionString just holds an error message
|
||||
const UnsupportedVersionString = "<unsupported cid version>"
|
||||
|
||||
const CidMaxLen = 256
|
||||
// ErrInvalidCid is an error that indicates that a CID is invalid.
|
||||
type ErrInvalidCid struct {
|
||||
Err error
|
||||
}
|
||||
|
||||
func (e ErrInvalidCid) Error() string {
|
||||
return fmt.Sprintf("invalid cid: %s", e.Err)
|
||||
}
|
||||
|
||||
func (e ErrInvalidCid) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
func (e ErrInvalidCid) Is(err error) bool {
|
||||
switch err.(type) {
|
||||
case ErrInvalidCid, *ErrInvalidCid:
|
||||
return true
|
||||
default:
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
var (
|
||||
// ErrVarintBuffSmall means that a buffer passed to the cid parser was not
|
||||
// long enough, or did not contain an invalid cid
|
||||
ErrVarintBuffSmall = errors.New("reading varint: buffer too small")
|
||||
|
||||
// ErrVarintTooBig means that the varint in the given cid was above the
|
||||
// limit of 2^64
|
||||
ErrVarintTooBig = errors.New("reading varint: varint bigger than 64bits" +
|
||||
" and not supported")
|
||||
|
||||
// ErrCidTooShort means that the cid passed to decode was not long
|
||||
// enough to be a valid Cid
|
||||
ErrCidTooShort = errors.New("cid too short")
|
||||
|
||||
// ErrCidTooLong means that the CIDs payload was greater than CidMaxLen
|
||||
// bytes
|
||||
ErrCidTooLong = errors.New("cid too long")
|
||||
ErrCidTooShort = ErrInvalidCid{errors.New("cid too short")}
|
||||
|
||||
// ErrInvalidEncoding means that selected encoding is not supported
|
||||
// by this Cid version
|
||||
ErrInvalidEncoding = errors.New("invalid base encoding")
|
||||
)
|
||||
|
||||
// These are multicodec-packed content types. The should match
|
||||
// the codes described in the authoritative document:
|
||||
// https://github.com/multiformats/multicodec/blob/master/table.csv
|
||||
// Consts below are DEPRECATED and left only for legacy reasons:
|
||||
// <https://code.sonr.org/go/cid/pull/137>
|
||||
// Modern code should use consts from go-multicodec instead:
|
||||
// <https://github.com/multiformats/go-multicodec>
|
||||
const (
|
||||
Raw = 0x55
|
||||
// common ones
|
||||
Raw = 0x55
|
||||
DagProtobuf = 0x70 // https://ipld.io/docs/codecs/known/dag-pb/
|
||||
DagCBOR = 0x71 // https://ipld.io/docs/codecs/known/dag-cbor/
|
||||
DagJSON = 0x0129 // https://ipld.io/docs/codecs/known/dag-json/
|
||||
Libp2pKey = 0x72 // https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#peer-ids
|
||||
|
||||
DagProtobuf = 0x70
|
||||
DagCBOR = 0x71
|
||||
Libp2pKey = 0x72
|
||||
|
||||
GitRaw = 0x78
|
||||
|
||||
EthBlock = 0x90
|
||||
EthBlockList = 0x91
|
||||
EthTxTrie = 0x92
|
||||
EthTx = 0x93
|
||||
EthTxReceiptTrie = 0x94
|
||||
EthTxReceipt = 0x95
|
||||
EthStateTrie = 0x96
|
||||
EthAccountSnapshot = 0x97
|
||||
EthStorageTrie = 0x98
|
||||
BitcoinBlock = 0xb0
|
||||
BitcoinTx = 0xb1
|
||||
ZcashBlock = 0xc0
|
||||
ZcashTx = 0xc1
|
||||
DecredBlock = 0xe0
|
||||
DecredTx = 0xe1
|
||||
DashBlock = 0xf0
|
||||
DashTx = 0xf1
|
||||
// other
|
||||
GitRaw = 0x78
|
||||
DagJOSE = 0x85 // https://ipld.io/specs/codecs/dag-jose/spec/
|
||||
EthBlock = 0x90
|
||||
EthBlockList = 0x91
|
||||
EthTxTrie = 0x92
|
||||
EthTx = 0x93
|
||||
EthTxReceiptTrie = 0x94
|
||||
EthTxReceipt = 0x95
|
||||
EthStateTrie = 0x96
|
||||
EthAccountSnapshot = 0x97
|
||||
EthStorageTrie = 0x98
|
||||
BitcoinBlock = 0xb0
|
||||
BitcoinTx = 0xb1
|
||||
ZcashBlock = 0xc0
|
||||
ZcashTx = 0xc1
|
||||
DecredBlock = 0xe0
|
||||
DecredTx = 0xe1
|
||||
DashBlock = 0xf0
|
||||
DashTx = 0xf1
|
||||
FilCommitmentUnsealed = 0xf101
|
||||
FilCommitmentSealed = 0xf102
|
||||
)
|
||||
|
||||
// Codecs maps the name of a codec to its type
|
||||
var Codecs = map[string]uint64{
|
||||
"v0": DagProtobuf,
|
||||
"raw": Raw,
|
||||
"protobuf": DagProtobuf,
|
||||
"cbor": DagCBOR,
|
||||
"libp2p-key": Libp2pKey,
|
||||
"git-raw": GitRaw,
|
||||
"eth-block": EthBlock,
|
||||
"eth-block-list": EthBlockList,
|
||||
"eth-tx-trie": EthTxTrie,
|
||||
"eth-tx": EthTx,
|
||||
"eth-tx-receipt-trie": EthTxReceiptTrie,
|
||||
"eth-tx-receipt": EthTxReceipt,
|
||||
"eth-state-trie": EthStateTrie,
|
||||
"eth-account-snapshot": EthAccountSnapshot,
|
||||
"eth-storage-trie": EthStorageTrie,
|
||||
"bitcoin-block": BitcoinBlock,
|
||||
"bitcoin-tx": BitcoinTx,
|
||||
"zcash-block": ZcashBlock,
|
||||
"zcash-tx": ZcashTx,
|
||||
"decred-block": DecredBlock,
|
||||
"decred-tx": DecredTx,
|
||||
"dash-block": DashBlock,
|
||||
"dash-tx": DashTx,
|
||||
}
|
||||
|
||||
// CodecToStr maps the numeric codec to its name
|
||||
var CodecToStr = map[uint64]string{
|
||||
Raw: "raw",
|
||||
DagProtobuf: "protobuf",
|
||||
DagCBOR: "cbor",
|
||||
GitRaw: "git-raw",
|
||||
EthBlock: "eth-block",
|
||||
EthBlockList: "eth-block-list",
|
||||
EthTxTrie: "eth-tx-trie",
|
||||
EthTx: "eth-tx",
|
||||
EthTxReceiptTrie: "eth-tx-receipt-trie",
|
||||
EthTxReceipt: "eth-tx-receipt",
|
||||
EthStateTrie: "eth-state-trie",
|
||||
EthAccountSnapshot: "eth-account-snapshot",
|
||||
EthStorageTrie: "eth-storage-trie",
|
||||
BitcoinBlock: "bitcoin-block",
|
||||
BitcoinTx: "bitcoin-tx",
|
||||
ZcashBlock: "zcash-block",
|
||||
ZcashTx: "zcash-tx",
|
||||
DecredBlock: "decred-block",
|
||||
DecredTx: "decred-tx",
|
||||
DashBlock: "dash-block",
|
||||
DashTx: "dash-tx",
|
||||
// tryNewCidV0 tries to convert a multihash into a CIDv0 CID and returns an
|
||||
// error on failure.
|
||||
func tryNewCidV0(mhash mh.Multihash) (Cid, error) {
|
||||
// Need to make sure hash is valid for CidV0 otherwise we will
|
||||
// incorrectly detect it as CidV1 in the Version() method
|
||||
dec, err := mh.Decode(mhash)
|
||||
if err != nil {
|
||||
return Undef, ErrInvalidCid{err}
|
||||
}
|
||||
if dec.Code != mh.SHA2_256 || dec.Length != 32 {
|
||||
return Undef, ErrInvalidCid{fmt.Errorf("invalid hash for cidv0 %d-%d", dec.Code, dec.Length)}
|
||||
}
|
||||
return Cid{string(mhash)}, nil
|
||||
}
|
||||
|
||||
// NewCidV0 returns a Cid-wrapped multihash.
|
||||
// They exist to allow IPFS to work with Cids while keeping
|
||||
// compatibility with the plain-multihash format used used in IPFS.
|
||||
// NewCidV1 should be used preferentially.
|
||||
//
|
||||
// Panics if the multihash isn't sha2-256.
|
||||
func NewCidV0(mhash mh.Multihash) Cid {
|
||||
// Need to make sure hash is valid for CidV0 otherwise we will
|
||||
// incorrectly detect it as CidV1 in the Version() method
|
||||
dec, err := mh.Decode(mhash)
|
||||
c, err := tryNewCidV0(mhash)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
if dec.Code != mh.SHA2_256 || dec.Length != 32 {
|
||||
panic("invalid hash for cidv0")
|
||||
}
|
||||
return Cid{string(mhash)}
|
||||
return c
|
||||
}
|
||||
|
||||
// NewCidV1 returns a new Cid using the given multicodec-packed
|
||||
// content type.
|
||||
//
|
||||
// Panics if the multihash is invalid.
|
||||
func NewCidV1(codecType uint64, mhash mh.Multihash) Cid {
|
||||
hashlen := len(mhash)
|
||||
// two 8 bytes (max) numbers plus hash
|
||||
buf := make([]byte, 2*binary.MaxVarintLen64+hashlen)
|
||||
n := binary.PutUvarint(buf, 1)
|
||||
n += binary.PutUvarint(buf[n:], codecType)
|
||||
cn := copy(buf[n:], mhash)
|
||||
|
||||
// Two 8 bytes (max) numbers plus hash.
|
||||
// We use strings.Builder to only allocate once.
|
||||
var b strings.Builder
|
||||
b.Grow(1 + varint.UvarintSize(codecType) + hashlen)
|
||||
|
||||
b.WriteByte(1)
|
||||
|
||||
var buf [binary.MaxVarintLen64]byte
|
||||
n := varint.PutUvarint(buf[:], codecType)
|
||||
b.Write(buf[:n])
|
||||
|
||||
cn, _ := b.Write(mhash)
|
||||
if cn != hashlen {
|
||||
panic("copy hash length is inconsistent")
|
||||
}
|
||||
|
||||
return Cid{string(buf[:n+hashlen])}
|
||||
return Cid{b.String()}
|
||||
}
|
||||
|
||||
var _ encoding.BinaryMarshaler = Cid{}
|
||||
var _ encoding.BinaryUnmarshaler = (*Cid)(nil)
|
||||
var _ encoding.TextMarshaler = Cid{}
|
||||
var _ encoding.TextUnmarshaler = (*Cid)(nil)
|
||||
var (
|
||||
_ encoding.BinaryMarshaler = Cid{}
|
||||
_ encoding.BinaryUnmarshaler = (*Cid)(nil)
|
||||
_ encoding.TextMarshaler = Cid{}
|
||||
_ encoding.TextUnmarshaler = (*Cid)(nil)
|
||||
)
|
||||
|
||||
// Cid represents a self-describing content addressed
|
||||
// identifier. It is formed by a Version, a Codec (which indicates
|
||||
@@ -212,18 +195,27 @@ func Parse(v interface{}) (Cid, error) {
|
||||
case []byte:
|
||||
return Cast(v2)
|
||||
case mh.Multihash:
|
||||
return NewCidV0(v2), nil
|
||||
return tryNewCidV0(v2)
|
||||
case Cid:
|
||||
return v2, nil
|
||||
default:
|
||||
return Undef, fmt.Errorf("can't parse %+v as Cid", v2)
|
||||
return Undef, ErrInvalidCid{fmt.Errorf("can't parse %+v as Cid", v2)}
|
||||
}
|
||||
}
|
||||
|
||||
// MustParse calls Parse but will panic on error.
|
||||
func MustParse(v interface{}) Cid {
|
||||
c, err := Parse(v)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return c
|
||||
}
|
||||
|
||||
// Decode parses a Cid-encoded string and returns a Cid object.
|
||||
// For CidV1, a Cid-encoded string is primarily a multibase string:
|
||||
//
|
||||
// <multibase-type-code><base-encoded-string>
|
||||
// <multibase-type-code><base-encoded-string>
|
||||
//
|
||||
// The base-encoded string represents a:
|
||||
//
|
||||
@@ -240,15 +232,15 @@ func Decode(v string) (Cid, error) {
|
||||
if len(v) == 46 && v[:2] == "Qm" {
|
||||
hash, err := mh.FromB58String(v)
|
||||
if err != nil {
|
||||
return Undef, err
|
||||
return Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
return NewCidV0(hash), nil
|
||||
return tryNewCidV0(hash)
|
||||
}
|
||||
|
||||
_, data, err := mbase.Decode(v)
|
||||
if err != nil {
|
||||
return Undef, err
|
||||
return Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
return Cast(data)
|
||||
@@ -270,27 +262,16 @@ func ExtractEncoding(v string) (mbase.Encoding, error) {
|
||||
// check encoding is valid
|
||||
_, err := mbase.NewEncoder(encoding)
|
||||
if err != nil {
|
||||
return -1, err
|
||||
return -1, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
return encoding, nil
|
||||
}
|
||||
|
||||
func uvError(read int) error {
|
||||
switch {
|
||||
case read == 0:
|
||||
return ErrVarintBuffSmall
|
||||
case read < 0:
|
||||
return ErrVarintTooBig
|
||||
default:
|
||||
return nil
|
||||
}
|
||||
}
|
||||
|
||||
// Cast takes a Cid data slice, parses it and returns a Cid.
|
||||
// For CidV1, the data buffer is in the form:
|
||||
//
|
||||
// <version><codec-type><multihash>
|
||||
// <version><codec-type><multihash>
|
||||
//
|
||||
// CidV0 are also supported. In particular, data buffers starting
|
||||
// with length 34 bytes, which starts with bytes [18,32...] are considered
|
||||
@@ -299,40 +280,16 @@ func uvError(read int) error {
|
||||
// Please use decode when parsing a regular Cid string, as Cast does not
|
||||
// expect multibase-encoded data. Cast accepts the output of Cid.Bytes().
|
||||
func Cast(data []byte) (Cid, error) {
|
||||
if len(data) > CidMaxLen {
|
||||
return Undef, ErrCidTooLong
|
||||
}
|
||||
|
||||
if len(data) == 34 && data[0] == 18 && data[1] == 32 {
|
||||
h, err := mh.Cast(data)
|
||||
if err != nil {
|
||||
return Undef, err
|
||||
}
|
||||
|
||||
return NewCidV0(h), nil
|
||||
}
|
||||
|
||||
vers, n := binary.Uvarint(data)
|
||||
if err := uvError(n); err != nil {
|
||||
return Undef, err
|
||||
}
|
||||
|
||||
if vers != 1 {
|
||||
return Undef, fmt.Errorf("expected 1 as the cid version number, got: %d", vers)
|
||||
}
|
||||
|
||||
_, cn := binary.Uvarint(data[n:])
|
||||
if err := uvError(cn); err != nil {
|
||||
return Undef, err
|
||||
}
|
||||
|
||||
rest := data[n+cn:]
|
||||
h, err := mh.Cast(rest)
|
||||
nr, c, err := CidFromBytes(data)
|
||||
if err != nil {
|
||||
return Undef, err
|
||||
return Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
return Cid{string(data[0 : n+cn+len(h)])}, nil
|
||||
if nr != len(data) {
|
||||
return Undef, ErrInvalidCid{fmt.Errorf("trailing bytes in data buffer passed to cid Cast")}
|
||||
}
|
||||
|
||||
return c, nil
|
||||
}
|
||||
|
||||
// UnmarshalBinary is equivalent to Cast(). It implements the
|
||||
@@ -370,14 +327,14 @@ func (c Cid) Type() uint64 {
|
||||
if c.Version() == 0 {
|
||||
return DagProtobuf
|
||||
}
|
||||
_, n := uvarint(c.str)
|
||||
codec, _ := uvarint(c.str[n:])
|
||||
_, n, _ := uvarint(c.str)
|
||||
codec, _, _ := uvarint(c.str[n:])
|
||||
return codec
|
||||
}
|
||||
|
||||
// String returns the default string representation of a
|
||||
// Cid. Currently, Base58 is used as the encoding for the
|
||||
// multibase string.
|
||||
// Cid. Currently, Base32 is used for CIDV1 as the encoding for the
|
||||
// multibase string, Base58 is used for CIDV0.
|
||||
func (c Cid) String() string {
|
||||
switch c.Version() {
|
||||
case 0:
|
||||
@@ -433,9 +390,9 @@ func (c Cid) Hash() mh.Multihash {
|
||||
}
|
||||
|
||||
// skip version length
|
||||
_, n1 := binary.Uvarint(bytes)
|
||||
_, n1, _ := varint.FromUvarint(bytes)
|
||||
// skip codec length
|
||||
_, n2 := binary.Uvarint(bytes[n1:])
|
||||
_, n2, _ := varint.FromUvarint(bytes[n1:])
|
||||
|
||||
return mh.Multihash(bytes[n1+n2:])
|
||||
}
|
||||
@@ -443,10 +400,40 @@ func (c Cid) Hash() mh.Multihash {
|
||||
// Bytes returns the byte representation of a Cid.
|
||||
// The output of bytes can be parsed back into a Cid
|
||||
// with Cast().
|
||||
//
|
||||
// If c.Defined() == false, it return a nil slice and may not
|
||||
// be parsable with Cast().
|
||||
func (c Cid) Bytes() []byte {
|
||||
if !c.Defined() {
|
||||
return nil
|
||||
}
|
||||
return []byte(c.str)
|
||||
}
|
||||
|
||||
// ByteLen returns the length of the CID in bytes.
|
||||
// It's equivalent to `len(c.Bytes())`, but works without an allocation,
|
||||
// and should therefore be preferred.
|
||||
//
|
||||
// (See also the WriteTo method for other important operations that work without allocation.)
|
||||
func (c Cid) ByteLen() int {
|
||||
return len(c.str)
|
||||
}
|
||||
|
||||
// WriteBytes writes the CID bytes to the given writer.
|
||||
// This method works without incurring any allocation.
|
||||
//
|
||||
// (See also the ByteLen method for other important operations that work without allocation.)
|
||||
func (c Cid) WriteBytes(w io.Writer) (int, error) {
|
||||
n, err := io.WriteString(w, c.str)
|
||||
if err != nil {
|
||||
return n, err
|
||||
}
|
||||
if n != len(c.str) {
|
||||
return n, fmt.Errorf("failed to write entire cid string")
|
||||
}
|
||||
return n, nil
|
||||
}
|
||||
|
||||
// MarshalBinary is equivalent to Bytes(). It implements the
|
||||
// encoding.BinaryMarshaler interface.
|
||||
func (c Cid) MarshalBinary() ([]byte, error) {
|
||||
@@ -469,7 +456,7 @@ func (c Cid) Equals(o Cid) bool {
|
||||
// UnmarshalJSON parses the JSON representation of a Cid.
|
||||
func (c *Cid) UnmarshalJSON(b []byte) error {
|
||||
if len(b) < 2 {
|
||||
return fmt.Errorf("invalid cid json blob")
|
||||
return ErrInvalidCid{fmt.Errorf("invalid cid json blob")}
|
||||
}
|
||||
obj := struct {
|
||||
CidTarget string `json:"/"`
|
||||
@@ -477,7 +464,7 @@ func (c *Cid) UnmarshalJSON(b []byte) error {
|
||||
objptr := &obj
|
||||
err := json.Unmarshal(b, &objptr)
|
||||
if err != nil {
|
||||
return err
|
||||
return ErrInvalidCid{err}
|
||||
}
|
||||
if objptr == nil {
|
||||
*c = Cid{}
|
||||
@@ -485,12 +472,12 @@ func (c *Cid) UnmarshalJSON(b []byte) error {
|
||||
}
|
||||
|
||||
if obj.CidTarget == "" {
|
||||
return fmt.Errorf("cid was incorrectly formatted")
|
||||
return ErrInvalidCid{fmt.Errorf("cid was incorrectly formatted")}
|
||||
}
|
||||
|
||||
out, err := Decode(obj.CidTarget)
|
||||
if err != nil {
|
||||
return err
|
||||
return ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
*c = out
|
||||
@@ -500,7 +487,7 @@ func (c *Cid) UnmarshalJSON(b []byte) error {
|
||||
|
||||
// MarshalJSON procudes a JSON representation of a Cid, which looks as follows:
|
||||
//
|
||||
// { "/": "<cid-string>" }
|
||||
// { "/": "<cid-string>" }
|
||||
//
|
||||
// Note that this formatting comes from the IPLD specification
|
||||
// (https://github.com/ipld/specs/tree/master/ipld)
|
||||
@@ -526,90 +513,39 @@ func (c Cid) Loggable() map[string]interface{} {
|
||||
|
||||
// Prefix builds and returns a Prefix out of a Cid.
|
||||
func (c Cid) Prefix() Prefix {
|
||||
dec, _ := mh.Decode(c.Hash()) // assuming we got a valid multiaddr, this will not error
|
||||
if c.Version() == 0 {
|
||||
return Prefix{
|
||||
MhType: mh.SHA2_256,
|
||||
MhLength: 32,
|
||||
Version: 0,
|
||||
Codec: DagProtobuf,
|
||||
}
|
||||
}
|
||||
|
||||
offset := 0
|
||||
version, n, _ := uvarint(c.str[offset:])
|
||||
offset += n
|
||||
codec, n, _ := uvarint(c.str[offset:])
|
||||
offset += n
|
||||
mhtype, n, _ := uvarint(c.str[offset:])
|
||||
offset += n
|
||||
mhlen, _, _ := uvarint(c.str[offset:])
|
||||
|
||||
return Prefix{
|
||||
MhType: dec.Code,
|
||||
MhLength: dec.Length,
|
||||
Version: c.Version(),
|
||||
Codec: c.Type(),
|
||||
MhType: mhtype,
|
||||
MhLength: int(mhlen),
|
||||
Version: version,
|
||||
Codec: codec,
|
||||
}
|
||||
}
|
||||
|
||||
func (c Cid) MarshalCBOR(w io.Writer) error {
|
||||
tag := cbg.CborEncodeMajorType(cbg.MajTag, 42)
|
||||
if _, err := w.Write(tag); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
typ := cbg.CborEncodeMajorType(cbg.MajByteString, uint64(len(c.Bytes())+1))
|
||||
if _, err := w.Write(typ); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// that binary multibase prefix...
|
||||
if _, err := w.Write([]byte{0}); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if _, err := w.Write(c.Bytes()); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c *Cid) UnmarshalCBOR(br cbg.ByteReader) error {
|
||||
maj, extra, err := cbg.CborReadHeader(br)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if maj != cbg.MajTag || extra != 42 {
|
||||
return fmt.Errorf("CBOR serialized CIDs must have the tag 42")
|
||||
}
|
||||
|
||||
maj, extra, err = cbg.CborReadHeader(br)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if maj != 2 {
|
||||
return fmt.Errorf("CBOR serialized CIDs must be tagged byte arrays")
|
||||
}
|
||||
|
||||
if extra < 2 {
|
||||
return fmt.Errorf("encoded CID body must be at least two bytes long")
|
||||
}
|
||||
|
||||
if extra > CidMaxLen+1 {
|
||||
return fmt.Errorf("CIDs cannot be longer than 256 bytes")
|
||||
}
|
||||
|
||||
buf := make([]byte, extra)
|
||||
if _, err := io.ReadFull(br, buf); err != nil {
|
||||
return fmt.Errorf("failed to read CID body: %s", err)
|
||||
}
|
||||
|
||||
if buf[0] != 0 {
|
||||
return fmt.Errorf("encoded CID did not have binary multibase")
|
||||
}
|
||||
|
||||
out, err := Cast(buf[1:])
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
*c = out
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Prefix represents all the metadata of a Cid,
|
||||
// that is, the Version, the Codec, the Multihash type
|
||||
// and the Multihash length. It does not contains
|
||||
// any actual content information.
|
||||
// NOTE: The use -1 in MhLength to mean default length is deprecated,
|
||||
// use the V0Builder or V1Builder structures instead
|
||||
//
|
||||
// use the V0Builder or V1Builder structures instead
|
||||
type Prefix struct {
|
||||
Version uint64
|
||||
Codec uint64
|
||||
@@ -621,13 +557,19 @@ type Prefix struct {
|
||||
// and return a newly constructed Cid with the resulting multihash.
|
||||
func (p Prefix) Sum(data []byte) (Cid, error) {
|
||||
length := p.MhLength
|
||||
if p.MhType == mh.ID {
|
||||
if p.MhType == mh.IDENTITY {
|
||||
length = -1
|
||||
}
|
||||
|
||||
if p.Version == 0 && (p.MhType != mh.SHA2_256 ||
|
||||
(p.MhLength != 32 && p.MhLength != -1)) {
|
||||
|
||||
return Undef, ErrInvalidCid{fmt.Errorf("invalid v0 prefix")}
|
||||
}
|
||||
|
||||
hash, err := mh.Sum(data, p.MhType, length)
|
||||
if err != nil {
|
||||
return Undef, err
|
||||
return Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
switch p.Version {
|
||||
@@ -636,44 +578,52 @@ func (p Prefix) Sum(data []byte) (Cid, error) {
|
||||
case 1:
|
||||
return NewCidV1(p.Codec, hash), nil
|
||||
default:
|
||||
return Undef, fmt.Errorf("invalid cid version")
|
||||
return Undef, ErrInvalidCid{fmt.Errorf("invalid cid version")}
|
||||
}
|
||||
}
|
||||
|
||||
// Bytes returns a byte representation of a Prefix. It looks like:
|
||||
//
|
||||
// <version><codec><mh-type><mh-length>
|
||||
// <version><codec><mh-type><mh-length>
|
||||
func (p Prefix) Bytes() []byte {
|
||||
buf := make([]byte, 4*binary.MaxVarintLen64)
|
||||
n := binary.PutUvarint(buf, p.Version)
|
||||
n += binary.PutUvarint(buf[n:], p.Codec)
|
||||
n += binary.PutUvarint(buf[n:], uint64(p.MhType))
|
||||
n += binary.PutUvarint(buf[n:], uint64(p.MhLength))
|
||||
return buf[:n]
|
||||
size := varint.UvarintSize(p.Version)
|
||||
size += varint.UvarintSize(p.Codec)
|
||||
size += varint.UvarintSize(p.MhType)
|
||||
size += varint.UvarintSize(uint64(p.MhLength))
|
||||
|
||||
buf := make([]byte, size)
|
||||
n := varint.PutUvarint(buf, p.Version)
|
||||
n += varint.PutUvarint(buf[n:], p.Codec)
|
||||
n += varint.PutUvarint(buf[n:], p.MhType)
|
||||
n += varint.PutUvarint(buf[n:], uint64(p.MhLength))
|
||||
if n != size {
|
||||
panic("size mismatch")
|
||||
}
|
||||
return buf
|
||||
}
|
||||
|
||||
// PrefixFromBytes parses a Prefix-byte representation onto a
|
||||
// Prefix.
|
||||
func PrefixFromBytes(buf []byte) (Prefix, error) {
|
||||
r := bytes.NewReader(buf)
|
||||
vers, err := binary.ReadUvarint(r)
|
||||
vers, err := varint.ReadUvarint(r)
|
||||
if err != nil {
|
||||
return Prefix{}, err
|
||||
return Prefix{}, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
codec, err := binary.ReadUvarint(r)
|
||||
codec, err := varint.ReadUvarint(r)
|
||||
if err != nil {
|
||||
return Prefix{}, err
|
||||
return Prefix{}, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
mhtype, err := binary.ReadUvarint(r)
|
||||
mhtype, err := varint.ReadUvarint(r)
|
||||
if err != nil {
|
||||
return Prefix{}, err
|
||||
return Prefix{}, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
mhlen, err := binary.ReadUvarint(r)
|
||||
mhlen, err := varint.ReadUvarint(r)
|
||||
if err != nil {
|
||||
return Prefix{}, err
|
||||
return Prefix{}, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
return Prefix{
|
||||
@@ -683,3 +633,185 @@ func PrefixFromBytes(buf []byte) (Prefix, error) {
|
||||
MhLength: int(mhlen),
|
||||
}, nil
|
||||
}
|
||||
|
||||
func CidFromBytes(data []byte) (int, Cid, error) {
|
||||
if len(data) > 2 && data[0] == mh.SHA2_256 && data[1] == 32 {
|
||||
if len(data) < 34 {
|
||||
return 0, Undef, ErrInvalidCid{fmt.Errorf("not enough bytes for cid v0")}
|
||||
}
|
||||
|
||||
h, err := mh.Cast(data[:34])
|
||||
if err != nil {
|
||||
return 0, Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
return 34, Cid{string(h)}, nil
|
||||
}
|
||||
|
||||
vers, n, err := varint.FromUvarint(data)
|
||||
if err != nil {
|
||||
return 0, Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
if vers != 1 {
|
||||
return 0, Undef, ErrInvalidCid{fmt.Errorf("expected 1 as the cid version number, got: %d", vers)}
|
||||
}
|
||||
|
||||
_, cn, err := varint.FromUvarint(data[n:])
|
||||
if err != nil {
|
||||
return 0, Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
mhnr, _, err := mh.MHFromBytes(data[n+cn:])
|
||||
if err != nil {
|
||||
return 0, Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
l := n + cn + mhnr
|
||||
|
||||
return l, Cid{string(data[0:l])}, nil
|
||||
}
|
||||
|
||||
func toBufByteReader(r io.Reader, dst []byte) *bufByteReader {
|
||||
// If the reader already implements ByteReader, use it directly.
|
||||
// Otherwise, use a fallback that does 1-byte Reads.
|
||||
if br, ok := r.(io.ByteReader); ok {
|
||||
return &bufByteReader{direct: br, dst: dst}
|
||||
}
|
||||
return &bufByteReader{fallback: r, dst: dst}
|
||||
}
|
||||
|
||||
type bufByteReader struct {
|
||||
direct io.ByteReader
|
||||
fallback io.Reader
|
||||
|
||||
dst []byte
|
||||
}
|
||||
|
||||
func (r *bufByteReader) ReadByte() (byte, error) {
|
||||
// The underlying reader has ReadByte; use it.
|
||||
if br := r.direct; br != nil {
|
||||
b, err := br.ReadByte()
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
r.dst = append(r.dst, b)
|
||||
return b, nil
|
||||
}
|
||||
|
||||
// Fall back to a one-byte Read.
|
||||
// TODO: consider reading straight into dst,
|
||||
// once we have benchmarks and if they prove that to be faster.
|
||||
var p [1]byte
|
||||
if _, err := io.ReadFull(r.fallback, p[:]); err != nil {
|
||||
return 0, err
|
||||
}
|
||||
r.dst = append(r.dst, p[0])
|
||||
return p[0], nil
|
||||
}
|
||||
|
||||
// CidFromReader reads a precise number of bytes for a CID from a given reader.
|
||||
// It returns the number of bytes read, the CID, and any error encountered.
|
||||
// The number of bytes read is accurate even if a non-nil error is returned.
|
||||
//
|
||||
// It's recommended to supply a reader that buffers and implements io.ByteReader,
|
||||
// as CidFromReader has to do many single-byte reads to decode varints.
|
||||
// If the argument only implements io.Reader, single-byte Read calls are used instead.
|
||||
//
|
||||
// If the Reader is found to yield zero bytes, an io.EOF error is returned directly, in all
|
||||
// other error cases, an ErrInvalidCid, wrapping the original error, is returned.
|
||||
func CidFromReader(r io.Reader) (int, Cid, error) {
|
||||
// 64 bytes is enough for any CIDv0,
|
||||
// and it's enough for most CIDv1s in practice.
|
||||
// If the digest is too long, we'll allocate more.
|
||||
br := toBufByteReader(r, make([]byte, 0, 64))
|
||||
|
||||
// We read the first varint, to tell if this is a CIDv0 or a CIDv1.
|
||||
// The varint package wants a io.ByteReader, so we must wrap our io.Reader.
|
||||
vers, err := varint.ReadUvarint(br)
|
||||
if err != nil {
|
||||
if err == io.EOF {
|
||||
// First-byte read in ReadUvarint errors with io.EOF, so reader has no data.
|
||||
// Subsequent reads with an EOF will return io.ErrUnexpectedEOF and be wrapped here.
|
||||
return 0, Undef, err
|
||||
}
|
||||
return len(br.dst), Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
// If we have a CIDv0, read the rest of the bytes and cast the buffer.
|
||||
if vers == mh.SHA2_256 {
|
||||
if n, err := io.ReadFull(r, br.dst[1:34]); err != nil {
|
||||
return len(br.dst) + n, Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
br.dst = br.dst[:34]
|
||||
h, err := mh.Cast(br.dst)
|
||||
if err != nil {
|
||||
return len(br.dst), Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
return len(br.dst), Cid{string(h)}, nil
|
||||
}
|
||||
|
||||
if vers != 1 {
|
||||
return len(br.dst), Undef, ErrInvalidCid{fmt.Errorf("expected 1 as the cid version number, got: %d", vers)}
|
||||
}
|
||||
|
||||
// CID block encoding multicodec.
|
||||
_, err = varint.ReadUvarint(br)
|
||||
if err != nil {
|
||||
return len(br.dst), Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
// We could replace most of the code below with go-multihash's ReadMultihash.
|
||||
// Note that it would save code, but prevent reusing buffers.
|
||||
// Plus, we already have a ByteReader now.
|
||||
mhStart := len(br.dst)
|
||||
|
||||
// Multihash hash function code.
|
||||
_, err = varint.ReadUvarint(br)
|
||||
if err != nil {
|
||||
return len(br.dst), Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
// Multihash digest length.
|
||||
mhl, err := varint.ReadUvarint(br)
|
||||
if err != nil {
|
||||
return len(br.dst), Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
// Refuse to make large allocations to prevent OOMs due to bugs.
|
||||
const maxDigestAlloc = 32 << 20 // 32MiB
|
||||
if mhl > maxDigestAlloc {
|
||||
return len(br.dst), Undef, ErrInvalidCid{fmt.Errorf("refusing to allocate %d bytes for a digest", mhl)}
|
||||
}
|
||||
|
||||
// Fine to convert mhl to int, given maxDigestAlloc.
|
||||
prefixLength := len(br.dst)
|
||||
cidLength := prefixLength + int(mhl)
|
||||
if cidLength > cap(br.dst) {
|
||||
// If the multihash digest doesn't fit in our initial 64 bytes,
|
||||
// efficiently extend the slice via append+make.
|
||||
br.dst = append(br.dst, make([]byte, cidLength-len(br.dst))...)
|
||||
} else {
|
||||
// The multihash digest fits inside our buffer,
|
||||
// so just extend its capacity.
|
||||
br.dst = br.dst[:cidLength]
|
||||
}
|
||||
|
||||
if n, err := io.ReadFull(r, br.dst[prefixLength:cidLength]); err != nil {
|
||||
// We can't use len(br.dst) here,
|
||||
// as we've only read n bytes past prefixLength.
|
||||
return prefixLength + n, Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
// This simply ensures the multihash is valid.
|
||||
// TODO: consider removing this bit, as it's probably redundant;
|
||||
// for now, it helps ensure consistency with CidFromBytes.
|
||||
_, _, err = mh.MHFromBytes(br.dst[mhStart:])
|
||||
if err != nil {
|
||||
return len(br.dst), Undef, ErrInvalidCid{err}
|
||||
}
|
||||
|
||||
return len(br.dst), Cid{string(br.dst)}, nil
|
||||
}
|
||||
|
||||
@@ -1,10 +1,9 @@
|
||||
// +build gofuzz
|
||||
//go:build gofuzz
|
||||
|
||||
package cid
|
||||
|
||||
func Fuzz(data []byte) int {
|
||||
cid, err := Cast(data)
|
||||
|
||||
if err != nil {
|
||||
return 0
|
||||
}
|
||||
|
||||
591
cid_test.go
591
cid_test.go
@@ -2,45 +2,21 @@ package cid
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/hex"
|
||||
crand "crypto/rand"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"math/rand"
|
||||
"reflect"
|
||||
"strings"
|
||||
"testing"
|
||||
"testing/iotest"
|
||||
|
||||
mbase "github.com/multiformats/go-multibase"
|
||||
mh "github.com/multiformats/go-multihash"
|
||||
)
|
||||
|
||||
// Copying the "silly test" idea from
|
||||
// https://github.com/multiformats/go-multihash/blob/7aa9f26a231c6f34f4e9fad52bf580fd36627285/multihash_test.go#L13
|
||||
// Makes it so changing the table accidentally has to happen twice.
|
||||
var tCodecs = map[uint64]string{
|
||||
Raw: "raw",
|
||||
DagProtobuf: "protobuf",
|
||||
DagCBOR: "cbor",
|
||||
Libp2pKey: "libp2p-key",
|
||||
GitRaw: "git-raw",
|
||||
EthBlock: "eth-block",
|
||||
EthBlockList: "eth-block-list",
|
||||
EthTxTrie: "eth-tx-trie",
|
||||
EthTx: "eth-tx",
|
||||
EthTxReceiptTrie: "eth-tx-receipt-trie",
|
||||
EthTxReceipt: "eth-tx-receipt",
|
||||
EthStateTrie: "eth-state-trie",
|
||||
EthAccountSnapshot: "eth-account-snapshot",
|
||||
EthStorageTrie: "eth-storage-trie",
|
||||
BitcoinBlock: "bitcoin-block",
|
||||
BitcoinTx: "bitcoin-tx",
|
||||
ZcashBlock: "zcash-block",
|
||||
ZcashTx: "zcash-tx",
|
||||
DecredBlock: "decred-block",
|
||||
DecredTx: "decred-tx",
|
||||
DashBlock: "dash-block",
|
||||
DashTx: "dash-tx",
|
||||
}
|
||||
|
||||
func assertEqual(t *testing.T, a, b Cid) {
|
||||
if a.Type() != b.Type() {
|
||||
t.Fatal("mismatch on type")
|
||||
@@ -55,31 +31,11 @@ func assertEqual(t *testing.T, a, b Cid) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestTable(t *testing.T) {
|
||||
if len(tCodecs) != len(Codecs)-1 {
|
||||
t.Errorf("Item count mismatch in the Table of Codec. Should be %d, got %d", len(tCodecs)+1, len(Codecs))
|
||||
}
|
||||
|
||||
for k, v := range tCodecs {
|
||||
if Codecs[v] != k {
|
||||
t.Errorf("Table mismatch: 0x%x %s", k, v)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// The table returns cid.DagProtobuf for "v0"
|
||||
// so we test it apart
|
||||
func TestTableForV0(t *testing.T) {
|
||||
if Codecs["v0"] != DagProtobuf {
|
||||
t.Error("Table mismatch: Codecs[\"v0\"] should resolve to DagProtobuf (0x70)")
|
||||
}
|
||||
}
|
||||
|
||||
func TestPrefixSum(t *testing.T) {
|
||||
// Test creating CIDs both manually and with Prefix.
|
||||
// Tests: https://github.com/ipfs/go-cid/issues/83
|
||||
// Tests: https://code.sonr.org/go/cid/issues/83
|
||||
for _, hashfun := range []uint64{
|
||||
mh.ID, mh.SHA3, mh.SHA2_256,
|
||||
mh.IDENTITY, mh.SHA3, mh.SHA2_256,
|
||||
} {
|
||||
h1, err := mh.Sum([]byte("TEST"), hashfun, -1)
|
||||
if err != nil {
|
||||
@@ -183,8 +139,35 @@ func TestBasesMarshaling(t *testing.T) {
|
||||
}
|
||||
s2 := cid.Encode(encoder)
|
||||
if s != s2 {
|
||||
t.Fatalf("'%s' != '%s'", s, s2)
|
||||
t.Fatalf("%q != %q", s, s2)
|
||||
}
|
||||
|
||||
ee, err := ExtractEncoding(s)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if ee != b {
|
||||
t.Fatalf("could not properly determine base (got %v)", ee)
|
||||
}
|
||||
}
|
||||
|
||||
ee, err := ExtractEncoding("QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if ee != mbase.Base58BTC {
|
||||
t.Fatalf("expected Base58BTC from Qm string (got %v)", ee)
|
||||
}
|
||||
|
||||
ee, err = ExtractEncoding("1")
|
||||
if err == nil {
|
||||
t.Fatal("expected too-short error from ExtractEncoding")
|
||||
}
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatal("expected error to be ErrInvalidCid")
|
||||
}
|
||||
if ee != -1 {
|
||||
t.Fatal("expected -1 from too-short ExtractEncoding")
|
||||
}
|
||||
}
|
||||
|
||||
@@ -193,18 +176,32 @@ func TestBinaryMarshaling(t *testing.T) {
|
||||
hash, _ := mh.Sum(data, mh.SHA2_256, -1)
|
||||
c := NewCidV1(DagCBOR, hash)
|
||||
var c2 Cid
|
||||
var c3 Cid
|
||||
|
||||
data, err := c.MarshalBinary()
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
err = c2.UnmarshalBinary(data)
|
||||
if err != nil {
|
||||
if err = c2.UnmarshalBinary(data); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !c.Equals(c2) {
|
||||
t.Errorf("cids should be the same: %s %s", c, c2)
|
||||
}
|
||||
var buf bytes.Buffer
|
||||
wrote, err := c.WriteBytes(&buf)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if wrote != 36 {
|
||||
t.Fatalf("expected 36 bytes written (got %d)", wrote)
|
||||
}
|
||||
if err = c3.UnmarshalBinary(data); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !c.Equals(c3) {
|
||||
t.Errorf("cids should be the same: %s %s", c, c3)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTextMarshaling(t *testing.T) {
|
||||
@@ -217,13 +214,16 @@ func TestTextMarshaling(t *testing.T) {
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
err = c2.UnmarshalText(data)
|
||||
if err != nil {
|
||||
if err = c2.UnmarshalText(data); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !c.Equals(c2) {
|
||||
t.Errorf("cids should be the same: %s %s", c, c2)
|
||||
}
|
||||
|
||||
if c.KeyString() != string(c.Bytes()) {
|
||||
t.Errorf("got unexpected KeyString() result")
|
||||
}
|
||||
}
|
||||
|
||||
func TestEmptyString(t *testing.T) {
|
||||
@@ -231,6 +231,9 @@ func TestEmptyString(t *testing.T) {
|
||||
if err == nil {
|
||||
t.Fatal("shouldnt be able to parse an empty cid")
|
||||
}
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatal("error must be ErrInvalidCid")
|
||||
}
|
||||
}
|
||||
|
||||
func TestV0Handling(t *testing.T) {
|
||||
@@ -253,6 +256,11 @@ func TestV0Handling(t *testing.T) {
|
||||
t.Fatal("marshaling roundtrip failed")
|
||||
}
|
||||
|
||||
byteLen := cid.ByteLen()
|
||||
if byteLen != 34 {
|
||||
t.Fatalf("expected V0 ByteLen to be 34 (got %d)", byteLen)
|
||||
}
|
||||
|
||||
new, err := cid.StringOfBase(mbase.Base58BTC)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
@@ -268,6 +276,11 @@ func TestV0Handling(t *testing.T) {
|
||||
if cid.Encode(encoder) != old {
|
||||
t.Fatal("Encode roundtrip failed")
|
||||
}
|
||||
|
||||
_, err = cid.StringOfBase(mbase.Base32)
|
||||
if err != ErrInvalidEncoding {
|
||||
t.Fatalf("expected ErrInvalidEncoding for V0 StringOfBase(Base32) (got %v)", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestV0ErrorCases(t *testing.T) {
|
||||
@@ -276,6 +289,9 @@ func TestV0ErrorCases(t *testing.T) {
|
||||
if err == nil {
|
||||
t.Fatal("should have failed to decode that ref")
|
||||
}
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatal("error must be ErrInvalidCid")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewPrefixV1(t *testing.T) {
|
||||
@@ -336,6 +352,53 @@ func TestNewPrefixV0(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestInvalidV0Prefix(t *testing.T) {
|
||||
tests := []Prefix{
|
||||
{
|
||||
MhType: mh.SHA2_256,
|
||||
MhLength: 31,
|
||||
},
|
||||
{
|
||||
MhType: mh.SHA2_256,
|
||||
MhLength: 33,
|
||||
},
|
||||
{
|
||||
MhType: mh.SHA2_256,
|
||||
MhLength: -2,
|
||||
},
|
||||
{
|
||||
MhType: mh.SHA2_512,
|
||||
MhLength: 32,
|
||||
},
|
||||
{
|
||||
MhType: mh.SHA2_512,
|
||||
MhLength: -1,
|
||||
},
|
||||
}
|
||||
|
||||
for i, p := range tests {
|
||||
t.Log(i)
|
||||
_, err := p.Sum([]byte("testdata"))
|
||||
if err == nil {
|
||||
t.Fatalf("should error (index %d)", i)
|
||||
}
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatal("expected error to be ErrInvalidCid")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestBadPrefix(t *testing.T) {
|
||||
p := Prefix{Version: 3, Codec: DagProtobuf, MhType: mh.SHA2_256, MhLength: 3}
|
||||
_, err := p.Sum([]byte{0x00, 0x01, 0x03})
|
||||
if err == nil {
|
||||
t.Fatalf("expected error on v3 prefix Sum")
|
||||
}
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatal("expected error to be ErrInvalidCid")
|
||||
}
|
||||
}
|
||||
|
||||
func TestPrefixRoundtrip(t *testing.T) {
|
||||
data := []byte("this is some test content")
|
||||
hash, _ := mh.Sum(data, mh.SHA2_256, -1)
|
||||
@@ -365,6 +428,37 @@ func TestPrefixRoundtrip(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestBadPrefixFromBytes(t *testing.T) {
|
||||
_, err := PrefixFromBytes([]byte{0x80})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for bad byte 0")
|
||||
}
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatal("expected error to be ErrInvalidCid")
|
||||
}
|
||||
_, err = PrefixFromBytes([]byte{0x01, 0x80})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for bad byte 1")
|
||||
}
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatal("expected error to be ErrInvalidCid")
|
||||
}
|
||||
_, err = PrefixFromBytes([]byte{0x01, 0x01, 0x80})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for bad byte 2")
|
||||
}
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatal("expected error to be ErrInvalidCid")
|
||||
}
|
||||
_, err = PrefixFromBytes([]byte{0x01, 0x01, 0x01, 0x80})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for bad byte 3")
|
||||
}
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatal("expected error to be ErrInvalidCid")
|
||||
}
|
||||
}
|
||||
|
||||
func Test16BytesVarint(t *testing.T) {
|
||||
data := []byte("this is some test content")
|
||||
hash, _ := mh.Sum(data, mh.SHA2_256, -1)
|
||||
@@ -376,7 +470,7 @@ func TestFuzzCid(t *testing.T) {
|
||||
buf := make([]byte, 128)
|
||||
for i := 0; i < 200; i++ {
|
||||
s := rand.Intn(128)
|
||||
rand.Read(buf[:s])
|
||||
crand.Read(buf[:s])
|
||||
_, _ = Cast(buf[:s])
|
||||
}
|
||||
}
|
||||
@@ -389,6 +483,9 @@ func TestParse(t *testing.T) {
|
||||
if !strings.Contains(err.Error(), "can't parse 123 as Cid") {
|
||||
t.Fatalf("expected int error, got %s", err.Error())
|
||||
}
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatalf("expected ErrInvalidCid, got %s", err.Error())
|
||||
}
|
||||
|
||||
theHash := "QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n"
|
||||
h, err := mh.FromB58String(theHash)
|
||||
@@ -397,13 +494,13 @@ func TestParse(t *testing.T) {
|
||||
}
|
||||
|
||||
assertions := [][]interface{}{
|
||||
[]interface{}{NewCidV0(h), theHash},
|
||||
[]interface{}{NewCidV0(h).Bytes(), theHash},
|
||||
[]interface{}{h, theHash},
|
||||
[]interface{}{theHash, theHash},
|
||||
[]interface{}{"/ipfs/" + theHash, theHash},
|
||||
[]interface{}{"https://ipfs.io/ipfs/" + theHash, theHash},
|
||||
[]interface{}{"http://localhost:8080/ipfs/" + theHash, theHash},
|
||||
{NewCidV0(h), theHash},
|
||||
{NewCidV0(h).Bytes(), theHash},
|
||||
{h, theHash},
|
||||
{theHash, theHash},
|
||||
{"/ipfs/" + theHash, theHash},
|
||||
{"https://ipfs.io/ipfs/" + theHash, theHash},
|
||||
{"http://localhost:8080/ipfs/" + theHash, theHash},
|
||||
}
|
||||
|
||||
assert := func(arg interface{}, expected string) error {
|
||||
@@ -412,7 +509,7 @@ func TestParse(t *testing.T) {
|
||||
return err
|
||||
}
|
||||
if cid.Version() != 0 {
|
||||
return fmt.Errorf("expected version 0, got %s", string(cid.Version()))
|
||||
return fmt.Errorf("expected version 0, got %d", cid.Version())
|
||||
}
|
||||
actual := cid.Hash().B58String()
|
||||
if actual != expected {
|
||||
@@ -426,8 +523,7 @@ func TestParse(t *testing.T) {
|
||||
}
|
||||
|
||||
for _, args := range assertions {
|
||||
err := assert(args[0], args[1].(string))
|
||||
if err != nil {
|
||||
if err := assert(args[0], args[1].(string)); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
@@ -461,8 +557,7 @@ func TestFromJson(t *testing.T) {
|
||||
cval := "bafkreie5qrjvaw64n4tjm6hbnm7fnqvcssfed4whsjqxzslbd3jwhsk3mm"
|
||||
jsoncid := []byte(`{"/":"` + cval + `"}`)
|
||||
var c Cid
|
||||
err := json.Unmarshal(jsoncid, &c)
|
||||
if err != nil {
|
||||
if err := json.Unmarshal(jsoncid, &c); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
@@ -472,6 +567,7 @@ func TestFromJson(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestJsonRoundTrip(t *testing.T) {
|
||||
expectedJSON := `{"/":"bafkreie5qrjvaw64n4tjm6hbnm7fnqvcssfed4whsjqxzslbd3jwhsk3mm"}`
|
||||
exp, err := Decode("bafkreie5qrjvaw64n4tjm6hbnm7fnqvcssfed4whsjqxzslbd3jwhsk3mm")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
@@ -483,91 +579,61 @@ func TestJsonRoundTrip(t *testing.T) {
|
||||
t.Fatal(err)
|
||||
}
|
||||
var actual Cid
|
||||
err = json.Unmarshal(enc, &actual)
|
||||
if err = json.Unmarshal(enc, &actual); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !exp.Equals(actual) {
|
||||
t.Fatal("cids not equal for *Cid")
|
||||
}
|
||||
|
||||
if string(enc) != expectedJSON {
|
||||
t.Fatalf("did not get expected JSON form (got %q)", string(enc))
|
||||
}
|
||||
|
||||
// Verify it works for a Cid.
|
||||
enc, err = json.Marshal(exp)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
var actual2 Cid
|
||||
err = json.Unmarshal(enc, &actual2)
|
||||
if err = json.Unmarshal(enc, &actual2); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !exp.Equals(actual2) {
|
||||
t.Fatal("cids not equal for Cid")
|
||||
}
|
||||
}
|
||||
|
||||
func TestCBORSerialization(t *testing.T) {
|
||||
cases := map[string]string{
|
||||
"bafybeibpzhw63c3vh7vushzvfzvkc2nbhr6nm3ui2o7kj33cx3xoovnzp4": "d82a582500017012202fc9eded8b753feb491f352e6aa169a13c7cd66e88d3bea4ef62beeee755b97f",
|
||||
"QmRZCTZPygAnfagZKzjy48b4LMmqPNpJnNBEg5LtCCzHCA": "d82a58230012202fc9eded8b753feb491f352e6aa169a13c7cd66e88d3bea4ef62beeee755b97f",
|
||||
err = actual2.UnmarshalJSON([]byte("1"))
|
||||
if err == nil {
|
||||
t.Fatal("expected error for too-short JSON")
|
||||
}
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatal("expected error to be ErrInvalidCid")
|
||||
}
|
||||
|
||||
for cs, encs := range cases {
|
||||
c, err := Decode(cs)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
buf := new(bytes.Buffer)
|
||||
if err := c.MarshalCBOR(buf); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
exp, err := hex.DecodeString(encs)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if !bytes.Equal(exp, buf.Bytes()) {
|
||||
t.Fatalf("serialization incorrect: %x != %x", buf.Bytes(), exp)
|
||||
}
|
||||
|
||||
var out Cid
|
||||
if err := out.UnmarshalCBOR(bytes.NewReader(exp)); err != nil {
|
||||
t.Fatalf("unmarshal case %s failed: %s", cs, err)
|
||||
}
|
||||
|
||||
if out != c {
|
||||
t.Fatal("unmarshal CBOR failed")
|
||||
}
|
||||
err = actual2.UnmarshalJSON([]byte(`{"nope":"nope"}`))
|
||||
if err == nil {
|
||||
t.Fatal("expected error for bad CID JSON")
|
||||
}
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatal("expected error to be ErrInvalidCid")
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkCBORMarshal(b *testing.B) {
|
||||
c, err := Decode("bafybeibpzhw63c3vh7vushzvfzvkc2nbhr6nm3ui2o7kj33cx3xoovnzp4")
|
||||
err = actual2.UnmarshalJSON([]byte(`bad "" json!`))
|
||||
if err == nil {
|
||||
t.Fatal("expected error for bad JSON")
|
||||
}
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatal("expected error to be ErrInvalidCid")
|
||||
}
|
||||
|
||||
var actual3 Cid
|
||||
enc, err = actual3.MarshalJSON()
|
||||
if err != nil {
|
||||
b.Fatal(err)
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
b.ReportAllocs()
|
||||
|
||||
buf := new(bytes.Buffer)
|
||||
for i := 0; i < b.N; i++ {
|
||||
buf.Reset()
|
||||
if err := c.MarshalCBOR(buf); err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkCBORUnmarshal(b *testing.B) {
|
||||
enc, err := hex.DecodeString("d82a582500017012202fc9eded8b753feb491f352e6aa169a13c7cd66e88d3bea4ef62beeee755b97f")
|
||||
if err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
|
||||
b.ReportAllocs()
|
||||
|
||||
var c Cid
|
||||
for i := 0; i < b.N; i++ {
|
||||
br := bytes.NewReader(enc)
|
||||
if err := c.UnmarshalCBOR(br); err != nil {
|
||||
b.Fatal(err)
|
||||
}
|
||||
if string(enc) != "null" {
|
||||
t.Fatalf("expected 'null' string for undefined CID (got %q)", string(enc))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -587,3 +653,260 @@ func BenchmarkStringV1(b *testing.B) {
|
||||
b.FailNow()
|
||||
}
|
||||
}
|
||||
|
||||
func TestReadCidsFromBuffer(t *testing.T) {
|
||||
cidstr := []string{
|
||||
"bafkreie5qrjvaw64n4tjm6hbnm7fnqvcssfed4whsjqxzslbd3jwhsk3mm",
|
||||
"k2cwueckqkibutvhkr4p2ln2pjcaxaakpd9db0e7j7ax1lxhhxy3ekpv",
|
||||
"Qmf5Qzp6nGBku7CEn2UQx4mgN8TW69YUok36DrGa6NN893",
|
||||
"zb2rhZi1JR4eNc2jBGaRYJKYM8JEB4ovenym8L1CmFsRAytkz",
|
||||
"bafkqarjpmzuwyzltorxxezjpkvcfgqkfjfbfcvslivje2vchkzdu6rckjjcfgtkolaze6mssjqzeyn2ekrcfatkjku2vowseky3fswkfkm2deqkrju3e2",
|
||||
}
|
||||
|
||||
var cids []Cid
|
||||
var buf []byte
|
||||
for _, cs := range cidstr {
|
||||
c, err := Decode(cs)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
cids = append(cids, c)
|
||||
buf = append(buf, c.Bytes()...)
|
||||
}
|
||||
|
||||
var cur int
|
||||
for _, expc := range cids {
|
||||
n, c, err := CidFromBytes(buf[cur:])
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if c != expc {
|
||||
t.Fatal("cids mismatched")
|
||||
}
|
||||
cur += n
|
||||
}
|
||||
if cur != len(buf) {
|
||||
t.Fatal("had trailing bytes")
|
||||
}
|
||||
|
||||
// The same, but now with CidFromReader.
|
||||
// In multiple forms, to catch more io interface bugs.
|
||||
for _, r := range []io.Reader{
|
||||
// implements io.ByteReader
|
||||
bytes.NewReader(buf),
|
||||
|
||||
// tiny reads, no io.ByteReader
|
||||
iotest.OneByteReader(bytes.NewReader(buf)),
|
||||
} {
|
||||
cur = 0
|
||||
for _, expc := range cids {
|
||||
n, c, err := CidFromReader(r)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if c != expc {
|
||||
t.Fatal("cids mismatched")
|
||||
}
|
||||
cur += n
|
||||
}
|
||||
if cur != len(buf) {
|
||||
t.Fatal("had trailing bytes")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestBadCidInput(t *testing.T) {
|
||||
for _, name := range []string{
|
||||
"FromBytes",
|
||||
"FromReader",
|
||||
} {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
usingReader := name == "FromReader"
|
||||
|
||||
fromBytes := CidFromBytes
|
||||
if usingReader {
|
||||
fromBytes = func(data []byte) (int, Cid, error) {
|
||||
return CidFromReader(bytes.NewReader(data))
|
||||
}
|
||||
}
|
||||
|
||||
l, c, err := fromBytes([]byte{mh.SHA2_256, 32, 0x00})
|
||||
if err == nil {
|
||||
t.Fatal("expected not-enough-bytes for V0 CID")
|
||||
}
|
||||
if !usingReader && l != 0 {
|
||||
t.Fatal("expected length==0 from bad CID")
|
||||
} else if usingReader && l == 0 {
|
||||
t.Fatal("expected length!=0 from bad CID")
|
||||
}
|
||||
if c != Undef {
|
||||
t.Fatal("expected Undef CID from bad CID")
|
||||
}
|
||||
|
||||
c, err = Decode("bafkreie5qrjvaw64n4tjm6hbnm7fnqvcssfed4whsjqxzslbd3jwhsk3mm")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
byts := make([]byte, c.ByteLen())
|
||||
copy(byts, c.Bytes())
|
||||
byts[1] = 0x80 // bad codec varint
|
||||
byts[2] = 0x00
|
||||
l, c, err = fromBytes(byts)
|
||||
if err == nil {
|
||||
t.Fatal("expected not-enough-bytes for V1 CID")
|
||||
}
|
||||
if !usingReader && l != 0 {
|
||||
t.Fatal("expected length==0 from bad CID")
|
||||
} else if usingReader && l == 0 {
|
||||
t.Fatal("expected length!=0 from bad CID")
|
||||
}
|
||||
if c != Undef {
|
||||
t.Fatal("expected Undef CID from bad CID")
|
||||
}
|
||||
|
||||
copy(byts, c.Bytes())
|
||||
byts[2] = 0x80 // bad multihash varint
|
||||
byts[3] = 0x00
|
||||
l, c, err = fromBytes(byts)
|
||||
if err == nil {
|
||||
t.Fatal("expected not-enough-bytes for V1 CID")
|
||||
}
|
||||
if !usingReader && l != 0 {
|
||||
t.Fatal("expected length==0 from bad CID")
|
||||
} else if usingReader && l == 0 {
|
||||
t.Fatal("expected length!=0 from bad CID")
|
||||
}
|
||||
if c != Undef {
|
||||
t.Fatal("expected Undef CID from bad CidFromBytes")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestFromReaderNoData(t *testing.T) {
|
||||
// Reading no data from io.Reader should return io.EOF, not ErrInvalidCid.
|
||||
n, cid, err := CidFromReader(bytes.NewReader(nil))
|
||||
if err != io.EOF {
|
||||
t.Fatal("Expected io.EOF error")
|
||||
}
|
||||
if cid != Undef {
|
||||
t.Fatal("Expected Undef CID")
|
||||
}
|
||||
if n != 0 {
|
||||
t.Fatal("Expected 0 data")
|
||||
}
|
||||
|
||||
// Read byte indicatiing more data to and check error is ErrInvalidCid.
|
||||
_, _, err = CidFromReader(bytes.NewReader([]byte{0x80}))
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatal("Expected ErrInvalidCid error")
|
||||
}
|
||||
// Check for expected wrapped error.
|
||||
if !errors.Is(err, io.ErrUnexpectedEOF) {
|
||||
t.Fatal("Expected error", io.ErrUnexpectedEOF)
|
||||
}
|
||||
}
|
||||
|
||||
func TestBadParse(t *testing.T) {
|
||||
hash, err := mh.Sum([]byte("foobar"), mh.SHA3_256, -1)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
_, err = Parse(hash)
|
||||
if err == nil {
|
||||
t.Fatal("expected to fail to parse an invalid CIDv1 CID")
|
||||
}
|
||||
if !errors.Is(err, ErrInvalidCid{}) {
|
||||
t.Fatal("error must be ErrInvalidCid")
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoggable(t *testing.T) {
|
||||
c, err := Decode("bafkreie5qrjvaw64n4tjm6hbnm7fnqvcssfed4whsjqxzslbd3jwhsk3mm")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
actual := c.Loggable()
|
||||
expected := make(map[string]interface{})
|
||||
expected["cid"] = c
|
||||
if !reflect.DeepEqual(actual, expected) {
|
||||
t.Fatalf("did not get expected loggable form (got %v)", actual)
|
||||
}
|
||||
}
|
||||
|
||||
func TestErrInvalidCidIs(t *testing.T) {
|
||||
for i, test := range []struct {
|
||||
err error
|
||||
target error
|
||||
}{
|
||||
{&ErrInvalidCid{}, ErrInvalidCid{}},
|
||||
{ErrInvalidCid{}, &ErrInvalidCid{}},
|
||||
{ErrInvalidCid{}, ErrInvalidCid{}},
|
||||
{&ErrInvalidCid{}, &ErrInvalidCid{}},
|
||||
} {
|
||||
if !errors.Is(test.err, test.target) {
|
||||
t.Fatalf("expected error to be ErrInvalidCid, case %d", i)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestErrInvalidCid(t *testing.T) {
|
||||
run := func(err error) {
|
||||
if err == nil {
|
||||
t.Fatal("expected error")
|
||||
}
|
||||
|
||||
if !strings.HasPrefix(err.Error(), "invalid cid: ") {
|
||||
t.Fatal(`expected error message to contain "invalid cid: "`)
|
||||
}
|
||||
|
||||
is := errors.Is(err, ErrInvalidCid{})
|
||||
if !is {
|
||||
t.Fatal("expected error to be ErrInvalidCid")
|
||||
}
|
||||
|
||||
if !errors.Is(err, &ErrInvalidCid{}) {
|
||||
t.Fatal("expected error to be &ErrInvalidCid")
|
||||
}
|
||||
}
|
||||
|
||||
_, err := Decode("")
|
||||
run(err)
|
||||
|
||||
_, err = Decode("not-a-cid")
|
||||
run(err)
|
||||
|
||||
_, err = Decode("bafyInvalid")
|
||||
run(err)
|
||||
|
||||
_, err = Decode("QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zIII")
|
||||
run(err)
|
||||
|
||||
_, err = Cast([]byte("invalid"))
|
||||
run(err)
|
||||
|
||||
_, err = Parse("not-a-cid")
|
||||
run(err)
|
||||
|
||||
_, err = Parse("bafyInvalid")
|
||||
run(err)
|
||||
|
||||
_, err = Parse("QmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zIII")
|
||||
run(err)
|
||||
|
||||
_, err = Parse(123)
|
||||
run(err)
|
||||
|
||||
_, _, err = CidFromBytes([]byte("invalid"))
|
||||
run(err)
|
||||
|
||||
_, err = Prefix{}.Sum([]byte("data"))
|
||||
run(err)
|
||||
|
||||
_, err = PrefixFromBytes([]byte{0x80})
|
||||
run(err)
|
||||
|
||||
_, err = ExtractEncoding("invalid ")
|
||||
run(err)
|
||||
|
||||
}
|
||||
|
||||
22
go.mod
22
go.mod
@@ -1,7 +1,21 @@
|
||||
module github.com/ipfs/go-cid
|
||||
module code.sonr.org/go/cid
|
||||
|
||||
require (
|
||||
github.com/multiformats/go-multibase v0.0.1
|
||||
github.com/multiformats/go-multihash v0.0.1
|
||||
github.com/whyrusleeping/cbor-gen v0.0.0-20190820011425-d5123893e85a
|
||||
github.com/multiformats/go-multibase v0.2.0
|
||||
github.com/multiformats/go-multihash v0.2.3
|
||||
github.com/multiformats/go-varint v0.1.0
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/klauspost/cpuid/v2 v2.0.9 // indirect
|
||||
github.com/minio/sha256-simd v1.0.0 // indirect
|
||||
github.com/mr-tron/base58 v1.2.0 // indirect
|
||||
github.com/multiformats/go-base32 v0.0.3 // indirect
|
||||
github.com/multiformats/go-base36 v0.1.0 // indirect
|
||||
github.com/spaolacci/murmur3 v1.1.0 // indirect
|
||||
golang.org/x/crypto v0.45.0 // indirect
|
||||
golang.org/x/sys v0.38.0 // indirect
|
||||
lukechampine.com/blake3 v1.1.6 // indirect
|
||||
)
|
||||
|
||||
go 1.24.0
|
||||
|
||||
60
go.sum
60
go.sum
@@ -1,39 +1,25 @@
|
||||
github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY=
|
||||
github.com/gxed/hashland/keccakpg v0.0.1 h1:wrk3uMNaMxbXiHibbPO4S0ymqJMm41WiudyFSs7UnsU=
|
||||
github.com/gxed/hashland/keccakpg v0.0.1/go.mod h1:kRzw3HkwxFU1mpmPP8v1WyQzwdGfmKFJ6tItnhQ67kU=
|
||||
github.com/gxed/hashland/murmur3 v0.0.1 h1:SheiaIt0sda5K+8FLz952/1iWS9zrnKsEJaOJu4ZbSc=
|
||||
github.com/gxed/hashland/murmur3 v0.0.1/go.mod h1:KjXop02n4/ckmZSnY2+HKcLud/tcmvhST0bie/0lS48=
|
||||
github.com/ipfs/go-block-format v0.0.2/go.mod h1:AWR46JfpcObNfg3ok2JHDUfdiHRgWhJgCQF+KIgOPJY=
|
||||
github.com/ipfs/go-cid v0.0.1/go.mod h1:GHWU/WuQdMPmIosc4Yn1bcCT7dSeX4lBafM7iqUPQvM=
|
||||
github.com/ipfs/go-cid v0.0.2/go.mod h1:GHWU/WuQdMPmIosc4Yn1bcCT7dSeX4lBafM7iqUPQvM=
|
||||
github.com/ipfs/go-cid v0.0.3/go.mod h1:GHWU/WuQdMPmIosc4Yn1bcCT7dSeX4lBafM7iqUPQvM=
|
||||
github.com/ipfs/go-ipfs-util v0.0.1/go.mod h1:spsl5z8KUnrve+73pOhSVZND1SIxPW5RyBCNzQxlJBc=
|
||||
github.com/ipfs/go-ipld-cbor v0.0.3/go.mod h1:wTBtrQZA3SoFKMVkp6cn6HMRteIB1VsmHA0AQFOn7Nc=
|
||||
github.com/ipfs/go-ipld-format v0.0.1/go.mod h1:kyJtbkDALmFHv3QR6et67i35QzO3S0dCDnkOJhcZkms=
|
||||
github.com/jtolds/gls v4.2.1+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU=
|
||||
github.com/minio/blake2b-simd v0.0.0-20160723061019-3f5f724cb5b1 h1:lYpkrQH5ajf0OXOcUbGjvZxxijuBwbbmlSxLiuofa+g=
|
||||
github.com/minio/blake2b-simd v0.0.0-20160723061019-3f5f724cb5b1/go.mod h1:pD8RvIylQ358TN4wwqatJ8rNavkEINozVn9DtGI3dfQ=
|
||||
github.com/minio/sha256-simd v0.0.0-20190131020904-2d45a736cd16 h1:5W7KhL8HVF3XCFOweFD3BNESdnO8ewyYTFT2R+/b8FQ=
|
||||
github.com/minio/sha256-simd v0.0.0-20190131020904-2d45a736cd16/go.mod h1:2FMWW+8GMoPweT6+pI63m9YE3Lmw4J71hV56Chs1E/U=
|
||||
github.com/mr-tron/base58 v1.1.0 h1:Y51FGVJ91WBqCEabAi5OPUz38eAx8DakuAm5svLcsfQ=
|
||||
github.com/mr-tron/base58 v1.1.0/go.mod h1:xcD2VGqlgYjBdcBLw+TuYLr8afG+Hj8g2eTVqeSzSU8=
|
||||
github.com/klauspost/cpuid/v2 v2.0.4/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg=
|
||||
github.com/klauspost/cpuid/v2 v2.0.9 h1:lgaqFMSdTdQYdZ04uHyN2d/eKdOMyi2YLSvlQIBFYa4=
|
||||
github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg=
|
||||
github.com/minio/sha256-simd v1.0.0 h1:v1ta+49hkWZyvaKwrQB8elexRqm6Y0aMLjCNsrYxo6g=
|
||||
github.com/minio/sha256-simd v1.0.0/go.mod h1:OuYzVNI5vcoYIAmbIvHPl3N3jUzVedXbKy5RFepssQM=
|
||||
github.com/mr-tron/base58 v1.2.0 h1:T/HDJBh4ZCPbU39/+c3rRvE0uKBQlU27+QI8LJ4t64o=
|
||||
github.com/mr-tron/base58 v1.2.0/go.mod h1:BinMc/sQntlIE1frQmRFPUoPA1Zkr8VRgBdjWI2mNwc=
|
||||
github.com/multiformats/go-base32 v0.0.3 h1:tw5+NhuwaOjJCC5Pp82QuXbrmLzWg7uxlMFp8Nq/kkI=
|
||||
github.com/multiformats/go-base32 v0.0.3/go.mod h1:pLiuGC8y0QR3Ue4Zug5UzK9LjgbkL8NSQj0zQ5Nz/AA=
|
||||
github.com/multiformats/go-multibase v0.0.1 h1:PN9/v21eLywrFWdFNsFKaU04kLJzuYzmrJR+ubhT9qA=
|
||||
github.com/multiformats/go-multibase v0.0.1/go.mod h1:bja2MqRZ3ggyXtZSEDKpl0uO/gviWFaSteVbWT51qgs=
|
||||
github.com/multiformats/go-multihash v0.0.1 h1:HHwN1K12I+XllBCrqKnhX949Orn4oawPkegHMu2vDqQ=
|
||||
github.com/multiformats/go-multihash v0.0.1/go.mod h1:w/5tugSrLEbWqlcgJabL3oHFKTwfvkofsjW2Qa1ct4U=
|
||||
github.com/polydawn/refmt v0.0.0-20190221155625-df39d6c2d992/go.mod h1:uIp+gprXxxrWSjjklXD+mN4wed/tMfjMMmN/9+JsA9o=
|
||||
github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc=
|
||||
github.com/smartystreets/goconvey v0.0.0-20190222223459-a17d461953aa/go.mod h1:2RVY1rIf+2J2o/IM9+vPq9RzmHDSseB7FoXiSNIUsoU=
|
||||
github.com/warpfork/go-wish v0.0.0-20180510122957-5ad1f5abf436/go.mod h1:x6AKhvSSexNrVSrViXSHUEbICjmGXhtgABaHIySUSGw=
|
||||
github.com/whyrusleeping/cbor-gen v0.0.0-20190818214716-81392149d1dd h1:Nj8P2Fg3mRVnBfkNnxZK+QhjwCxI3kLng2nfTTLIudk=
|
||||
github.com/whyrusleeping/cbor-gen v0.0.0-20190818214716-81392149d1dd/go.mod h1:ga0xb76iSIPvNNiuR+g3+c3Rnwy0oVuBGvqDwsEV6x4=
|
||||
github.com/whyrusleeping/cbor-gen v0.0.0-20190819235733-17c06ddc16cb h1:49o2mhJ/B2nsmSjV4fUsrFEoKGM9NLWQSnk+YrAKFLg=
|
||||
github.com/whyrusleeping/cbor-gen v0.0.0-20190819235733-17c06ddc16cb/go.mod h1:ga0xb76iSIPvNNiuR+g3+c3Rnwy0oVuBGvqDwsEV6x4=
|
||||
github.com/whyrusleeping/cbor-gen v0.0.0-20190820011425-d5123893e85a h1:MYglUpczqDD6LXsnSXk6NWzwf64fheAuA3eBjyYGD/8=
|
||||
github.com/whyrusleeping/cbor-gen v0.0.0-20190820011425-d5123893e85a/go.mod h1:38LwjsrZy8ga8AbyOueCsLUAtdc1BDj/I929R+LnJfI=
|
||||
golang.org/x/crypto v0.0.0-20190211182817-74369b46fc67 h1:ng3VDlRp5/DHpSWl02R4rM9I+8M2rhmsuLwAMmkLQWE=
|
||||
golang.org/x/crypto v0.0.0-20190211182817-74369b46fc67/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
|
||||
golang.org/x/sys v0.0.0-20190219092855-153ac476189d h1:Z0Ahzd7HltpJtjAHHxX8QFP3j1yYgiuvjbjRzDj/KH0=
|
||||
golang.org/x/sys v0.0.0-20190219092855-153ac476189d/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
github.com/multiformats/go-base36 v0.1.0 h1:JR6TyF7JjGd3m6FbLU2cOxhC0Li8z8dLNGQ89tUg4F4=
|
||||
github.com/multiformats/go-base36 v0.1.0/go.mod h1:kFGE83c6s80PklsHO9sRn2NCoffoRdUUOENyW/Vv6sM=
|
||||
github.com/multiformats/go-multibase v0.2.0 h1:isdYCVLvksgWlMW9OZRYJEa9pZETFivncJHmHnnd87g=
|
||||
github.com/multiformats/go-multibase v0.2.0/go.mod h1:bFBZX4lKCA/2lyOFSAoKH5SS6oPyjtnzK/XTFDPkNuk=
|
||||
github.com/multiformats/go-multihash v0.2.3 h1:7Lyc8XfX/IY2jWb/gI7JP+o7JEq9hOa7BFvVU9RSh+U=
|
||||
github.com/multiformats/go-multihash v0.2.3/go.mod h1:dXgKXCXjBzdscBLk9JkjINiEsCKRVch90MdaGiKsvSM=
|
||||
github.com/multiformats/go-varint v0.1.0 h1:i2wqFp4sdl3IcIxfAonHQV9qU5OsZ4Ts9IOoETFs5dI=
|
||||
github.com/multiformats/go-varint v0.1.0/go.mod h1:5KVAVXegtfmNQQm/lCY+ATvDzvJJhSkUlGQV9wgObdI=
|
||||
github.com/spaolacci/murmur3 v1.1.0 h1:7c1g84S4BPRrfL5Xrdp6fOJ206sU9y293DDHaoy0bLI=
|
||||
github.com/spaolacci/murmur3 v1.1.0/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA=
|
||||
golang.org/x/crypto v0.45.0 h1:jMBrvKuj23MTlT0bQEOBcAE0mjg8mK9RXFhRH6nyF3Q=
|
||||
golang.org/x/crypto v0.45.0/go.mod h1:XTGrrkGJve7CYK7J8PEww4aY7gM3qMCElcJQ8n8JdX4=
|
||||
golang.org/x/sys v0.38.0 h1:3yZWxaJjBmCWXqhN1qh02AkOnCQ1poK6oF+a7xWL6Gc=
|
||||
golang.org/x/sys v0.38.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
|
||||
lukechampine.com/blake3 v1.1.6 h1:H3cROdztr7RCfoaTpGZFQsrqvweFLrqS73j7L7cmR5c=
|
||||
lukechampine.com/blake3 v1.1.6/go.mod h1:tkKEOtDkNtklkXtLNEOGNq5tcV90tJiA1vAA12R78LA=
|
||||
|
||||
29
varint.go
29
varint.go
@@ -1,6 +1,10 @@
|
||||
package cid
|
||||
|
||||
// Version of varint function that work with a string rather than
|
||||
import (
|
||||
"github.com/multiformats/go-varint"
|
||||
)
|
||||
|
||||
// Version of varint function that works with a string rather than
|
||||
// []byte to avoid unnecessary allocation
|
||||
|
||||
// Copyright 2011 The Go Authors. All rights reserved.
|
||||
@@ -8,27 +12,26 @@ package cid
|
||||
// license as given at https://golang.org/LICENSE
|
||||
|
||||
// uvarint decodes a uint64 from buf and returns that value and the
|
||||
// number of characters read (> 0). If an error occurred, the value is 0
|
||||
// and the number of bytes n is <= 0 meaning:
|
||||
//
|
||||
// n == 0: buf too small
|
||||
// n < 0: value larger than 64 bits (overflow)
|
||||
// and -n is the number of bytes read
|
||||
//
|
||||
func uvarint(buf string) (uint64, int) {
|
||||
// number of bytes read (> 0). If an error occurred, then 0 is
|
||||
// returned for both the value and the number of bytes read, and an
|
||||
// error is returned.
|
||||
func uvarint(buf string) (uint64, int, error) {
|
||||
var x uint64
|
||||
var s uint
|
||||
// we have a binary string so we can't use a range loope
|
||||
// we have a binary string so we can't use a range loop
|
||||
for i := 0; i < len(buf); i++ {
|
||||
b := buf[i]
|
||||
if b < 0x80 {
|
||||
if i > 9 || i == 9 && b > 1 {
|
||||
return 0, -(i + 1) // overflow
|
||||
return 0, 0, varint.ErrOverflow
|
||||
}
|
||||
return x | uint64(b)<<s, i + 1
|
||||
if b == 0 && i > 0 {
|
||||
return 0, 0, varint.ErrNotMinimal
|
||||
}
|
||||
return x | uint64(b)<<s, i + 1, nil
|
||||
}
|
||||
x |= uint64(b&0x7f) << s
|
||||
s += 7
|
||||
}
|
||||
return 0, 0
|
||||
return 0, 0, varint.ErrUnderflow
|
||||
}
|
||||
|
||||
@@ -1,17 +1,25 @@
|
||||
package cid
|
||||
|
||||
import (
|
||||
"encoding/binary"
|
||||
"testing"
|
||||
|
||||
"github.com/multiformats/go-varint"
|
||||
)
|
||||
|
||||
func TestUvarintRoundTrip(t *testing.T) {
|
||||
testCases := []uint64{0, 1, 2, 127, 128, 129, 255, 256, 257, 1<<63 - 1}
|
||||
for _, tc := range testCases {
|
||||
t.Log("testing", tc)
|
||||
buf := make([]byte, 16)
|
||||
binary.PutUvarint(buf, tc)
|
||||
v, l1 := uvarint(string(buf))
|
||||
_, l2 := binary.Uvarint(buf)
|
||||
varint.PutUvarint(buf, tc)
|
||||
v, l1, err := uvarint(string(buf))
|
||||
if err != nil {
|
||||
t.Fatalf("%v: %s", buf, err)
|
||||
}
|
||||
_, l2, err := varint.FromUvarint(buf)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if tc != v {
|
||||
t.Errorf("roundtrip failed expected %d but got %d", tc, v)
|
||||
}
|
||||
@@ -20,3 +28,29 @@ func TestUvarintRoundTrip(t *testing.T) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestUvarintEdges(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
input []byte
|
||||
want error
|
||||
}{
|
||||
{"ErrNotMinimal", []byte{0x01 | 0x80, 0}, varint.ErrNotMinimal},
|
||||
{"ErrOverflow", []byte{0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x01}, varint.ErrOverflow},
|
||||
{"ErrUnderflow", []byte{0x80}, varint.ErrUnderflow},
|
||||
}
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
v, l1, err := uvarint(string(test.input))
|
||||
if err != test.want {
|
||||
t.Fatalf("error case (%v) should return varint.%s (got: %v)", test.input, test.name, err)
|
||||
}
|
||||
if v != 0 {
|
||||
t.Fatalf("error case (%v) should return 0 value (got %d)", test.input, v)
|
||||
}
|
||||
if l1 != 0 {
|
||||
t.Fatalf("error case (%v) should return 0 length (got %d)", test.input, l1)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
3
version.json
Normal file
3
version.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"version": "v0.6.0"
|
||||
}
|
||||
Reference in New Issue
Block a user