portal/cid/cid.go

package cid

import (
	"bytes"
	"encoding/binary"
	"encoding/hex"
	"errors"
	"github.com/multiformats/go-multibase"
)

var MAGIC_BYTES = []byte{0x26, 0x1f}

var (
	ErrMissingEmptySize = errors.New("Missing or empty size")
	ErrInvalidCIDMagic  = errors.New("CID magic bytes missing or invalid")
)

type CID struct {
	Hash [32]byte
	Size uint64
}

func (c CID) StringHash() string {
	return hex.EncodeToString(c.Hash[:])
}

func Encode(hash []byte, size uint64) (string, error) {
	var hashBytes [32]byte
	copy(hashBytes[:], hash)

	return EncodeFixed(hashBytes, size)
}

func EncodeFixed(hash [32]byte, size uint64) (string, error) {
	sizeBytes := make([]byte, 8)
	binary.LittleEndian.PutUint64(sizeBytes, size)

	prefixedHash := append(MAGIC_BYTES, hash[:]...)
	prefixedHash = append(prefixedHash, sizeBytes...)

	return multibase.Encode(multibase.Base58BTC, prefixedHash)
}

func EncodeString(hash string, size uint64) (string, error) {
	hashBytes, err := hex.DecodeString(hash)
	if err != nil {
		return "", err
	}

	return Encode(hashBytes, size)
}

func Valid(cid string) (bool, error) {
	_, err := maybeDecode(cid)
	if err != nil {
		return false, err
	}

	return true, nil

}

func Decode(cid string) (*CID, error) {
	data, err := maybeDecode(cid)
	if err != nil {
		return &CID{}, err
	}

	data = data[len(MAGIC_BYTES):]
	var hash [32]byte
	copy(hash[:], data[:])
	size := binary.LittleEndian.Uint64(data[32:])

	return &CID{Hash: hash, Size: size}, nil
}

func maybeDecode(cid string) ([]byte, error) {
	_, data, err := multibase.Decode(cid)
	if err != nil {
		return nil, err
	}

	if bytes.Compare(data[0:len(MAGIC_BYTES)], MAGIC_BYTES) != 0 {
		return nil, ErrInvalidCIDMagic
	}

	sizeBytes := data[len(MAGIC_BYTES)+32:]

	if len(sizeBytes) == 0 {
		return nil, ErrMissingEmptySize
	}

	size := binary.LittleEndian.Uint64(sizeBytes)

	if size == 0 {
		return nil, ErrMissingEmptySize
	}

	return data, nil
}