126 lines
3.3 KiB
Markdown
126 lines
3.3 KiB
Markdown
go-cid
|
|
==================
|
|
|
|
[](http://ipn.io)
|
|
[](http://ipfs.io/)
|
|
[](http://webchat.freenode.net/?channels=%23ipfs)
|
|
[](https://github.com/RichardLitt/standard-readme)
|
|
[](https://godoc.org/github.com/ipfs/go-cid)
|
|
[](https://coveralls.io/github/ipfs/go-cid?branch=master)
|
|
[](https://travis-ci.org/ipfs/go-cid)
|
|
|
|
> A package to handle content IDs in Go.
|
|
|
|
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.
|
|
|
|
|
|
## Table of Contents
|
|
|
|
- [Install](#install)
|
|
- [Usage](#usage)
|
|
- [API](#api)
|
|
- [Contribute](#contribute)
|
|
- [License](#license)
|
|
|
|
## Install
|
|
|
|
`go-cid` is a standard Go module which can be installed with:
|
|
|
|
```sh
|
|
go get github.com/ipfs/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
|
|
|
|
### Using Gx and Gx-go
|
|
|
|
This module is packaged with [Gx](https://github.com/whyrusleeping/gx). In order to use it in your own project it is recommended that you:
|
|
|
|
```sh
|
|
go get -u github.com/whyrusleeping/gx
|
|
go get -u github.com/whyrusleeping/gx-go
|
|
cd <your-project-repository>
|
|
gx init
|
|
gx import github.com/ipfs/go-cid
|
|
gx install --global
|
|
gx-go --rewrite
|
|
```
|
|
|
|
Please check [Gx](https://github.com/whyrusleeping/gx) and [Gx-go](https://github.com/whyrusleeping/gx-go) documentation for more information.
|
|
|
|
### Running tests
|
|
|
|
Before running tests, please run:
|
|
|
|
```sh
|
|
make deps
|
|
```
|
|
|
|
This will make sure that dependencies are rewritten to known working versions.
|
|
|
|
### Examples
|
|
|
|
#### Parsing string input from users
|
|
|
|
```go
|
|
// Create a cid from a marshaled string
|
|
c, err := cid.Decode("bafzbeigai3eoy2ccc7ybwjfz5r3rdxqrinwi4rwytly24tdbh6yk7zslrm")
|
|
if err != nil {...}
|
|
|
|
fmt.Println("Got CID: ", c)
|
|
```
|
|
|
|
#### Creating a CID from scratch
|
|
|
|
```go
|
|
// Create a cid manually by specifying the 'prefix' parameters
|
|
pref := cid.Prefix{
|
|
Version: 1,
|
|
Codec: cid.Raw,
|
|
MhType: mh.SHA2_256,
|
|
MhLength: -1, // default length
|
|
}
|
|
|
|
// And then feed it some data
|
|
c, err := pref.Sum([]byte("Hello World!"))
|
|
if err != nil {...}
|
|
|
|
fmt.Println("Created CID: ", c)
|
|
```
|
|
|
|
#### Check if two CIDs match
|
|
|
|
```go
|
|
// To test if two cid's are equivalent, be sure to use the 'Equals' method:
|
|
if c1.Equals(c2) {
|
|
fmt.Println("These two refer to the same exact data!")
|
|
}
|
|
```
|
|
|
|
#### Check if some data matches a given CID
|
|
|
|
```go
|
|
// To check if some data matches a given cid,
|
|
// Get your CIDs prefix, and use that to sum the data in question:
|
|
other, err := c.Prefix().Sum(mydata)
|
|
if err != nil {...}
|
|
|
|
if !c.Equals(other) {
|
|
fmt.Println("This data is different.")
|
|
}
|
|
|
|
```
|
|
|
|
## Contribute
|
|
|
|
PRs are welcome!
|
|
|
|
Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
|
|
|
|
## License
|
|
|
|
MIT © Jeromy Johnson
|