aboutsummaryrefslogtreecommitdiffstats
path: root/contracts/ens/cid.go
blob: fae9bfd0a1338c0a5dea85996afbee9d4d9bfe40 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// Copyright 2016 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package ens

import (
    "encoding/binary"
    "errors"
    "fmt"

    "github.com/ethereum/go-ethereum/common"
)

const (
    cidv1 = 0x1

    nsIpfs  = 0xe3
    nsSwarm = 0xe4

    swarmTypecode = 0xfa //swarm manifest, see https://github.com/multiformats/multicodec/blob/master/table.csv
    swarmHashtype = 0xd6 // BMT, see https://github.com/multiformats/multicodec/blob/master/table.csv

    hashLength = 32
)

// deocodeEIP1577ContentHash decodes a chain-stored content hash from an ENS record according to EIP-1577
// a successful decode will result the different parts of the content hash in accordance to the CID spec
// Note: only CIDv1 is supported
func decodeEIP1577ContentHash(buf []byte) (storageNs, contentType, hashType, hashLength uint64, hash []byte, err error) {
    if len(buf) < 10 {
        return 0, 0, 0, 0, nil, errors.New("buffer too short")
    }

    storageNs, n := binary.Uvarint(buf)

    buf = buf[n:]
    vers, n := binary.Uvarint(buf)

    if vers != 1 {
        return 0, 0, 0, 0, nil, fmt.Errorf("expected cid v1, got: %d", vers)
    }
    buf = buf[n:]
    contentType, n = binary.Uvarint(buf)

    buf = buf[n:]
    hashType, n = binary.Uvarint(buf)

    buf = buf[n:]
    hashLength, n = binary.Uvarint(buf)

    hash = buf[n:]

    if len(hash) != int(hashLength) {
        return 0, 0, 0, 0, nil, errors.New("hash length mismatch")
    }
    return storageNs, contentType, hashType, hashLength, hash, nil
}

func extractContentHash(buf []byte) (common.Hash, error) {
    storageNs, _ /*contentType*/, _ /* hashType*/, decodedHashLength, hashBytes, err := decodeEIP1577ContentHash(buf)

    if err != nil {
        return common.Hash{}, err
    }

    if storageNs != nsSwarm {
        return common.Hash{}, errors.New("unknown storage system")
    }

    //todo: for the time being we implement loose enforcement for the EIP rules until ENS manager is updated
    /*if contentType != swarmTypecode {
        return common.Hash{}, errors.New("unknown content type")
    }

    if hashType != swarmHashtype {
        return common.Hash{}, errors.New("unknown multihash type")
    }*/

    if decodedHashLength != hashLength {
        return common.Hash{}, errors.New("odd hash length, swarm expects 32 bytes")
    }

    if len(hashBytes) != int(hashLength) {
        return common.Hash{}, errors.New("hash length mismatch")
    }

    return common.BytesToHash(buf), nil
}

func EncodeSwarmHash(hash common.Hash) ([]byte, error) {
    var cidBytes []byte
    var headerBytes = []byte{
        nsSwarm,       //swarm namespace
        cidv1,         // CIDv1
        swarmTypecode, // swarm hash
        swarmHashtype, // swarm bmt hash
        hashLength,    //hash length. 32 bytes
    }

    varintbuf := make([]byte, binary.MaxVarintLen64)
    for _, v := range headerBytes {
        n := binary.PutUvarint(varintbuf, uint64(v))
        cidBytes = append(cidBytes, varintbuf[:n]...)
    }

    cidBytes = append(cidBytes, hash[:]...)
    return cidBytes, nil
}