Skip to content

Commit

Permalink
feat: add addr(bytes32) ethereum address resolver
Browse files Browse the repository at this point in the history
  • Loading branch information
kamikazechaser committed Dec 13, 2024
1 parent 6c704b1 commit e530f9b
Show file tree
Hide file tree
Showing 5 changed files with 285 additions and 28 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.env
README.md
LICENSE
LICENSE
.vscode
6 changes: 3 additions & 3 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ go 1.23.3

require (
github.com/VictoriaMetrics/metrics v1.35.1
github.com/ethereum/go-ethereum v1.14.8
github.com/golang-jwt/jwt/v5 v5.2.1
github.com/kamikazechaser/common v1.0.1-0.20241102071235-b1d359b0e63b
github.com/knadh/koanf/parsers/toml v0.1.0
Expand All @@ -13,6 +14,8 @@ require (
github.com/lmittmann/w3 v0.17.1
github.com/uptrace/bunrouter v1.0.22
github.com/uptrace/bunrouter/extra/reqlog v1.0.22
golang.org/x/crypto v0.22.0
golang.org/x/net v0.24.0
)

require (
Expand All @@ -26,7 +29,6 @@ require (
github.com/deckarep/golang-set/v2 v2.6.0 // indirect
github.com/decred/dcrd/dcrec/secp256k1/v4 v4.0.1 // indirect
github.com/ethereum/c-kzg-4844 v1.0.0 // indirect
github.com/ethereum/go-ethereum v1.14.8 // indirect
github.com/fatih/color v1.17.0 // indirect
github.com/felixge/httpsnoop v1.0.4 // indirect
github.com/fsnotify/fsnotify v1.7.0 // indirect
Expand Down Expand Up @@ -55,9 +57,7 @@ require (
github.com/valyala/histogram v1.2.0 // indirect
go.opentelemetry.io/otel v1.30.0 // indirect
go.opentelemetry.io/otel/trace v1.30.0 // indirect
golang.org/x/crypto v0.22.0 // indirect
golang.org/x/exp v0.0.0-20231110203233-9a3e6036ecaa // indirect
golang.org/x/net v0.24.0 // indirect
golang.org/x/sync v0.7.0 // indirect
golang.org/x/sys v0.25.0 // indirect
golang.org/x/text v0.14.0 // indirect
Expand Down
77 changes: 53 additions & 24 deletions internal/api/ccip.go
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
package api

import (
"bytes"
"errors"
"fmt"
"net/http"
"strings"

"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/common/hexutil"
namehash "github.com/grassrootseconomics/resolver/pkg"
"github.com/kamikazechaser/common/httputil"
"github.com/lmittmann/w3"
"github.com/uptrace/bunrouter"
Expand All @@ -15,13 +20,14 @@ type CCIPParams struct {
Data string
}

const testResolvedAddress = "0xDeaDbeefdEAdbeefdEadbEEFdeadbeEFdEaDbeeF"

var (
resolveFunc = w3.MustNewFunc("resolve(bytes,bytes)", "")
ErrUnsupportedFunction = errors.New("unsupported function")
ErrNameValidation = errors.New("could not validate encoded name in inner data")

addrFunc = w3.MustNewFunc("addr(bytes32)", "")
addrMulticoinFunc = w3.MustNewFunc("addr(bytes32,uint256)", "")
textFunc = w3.MustNewFunc("text(bytes32,string)", "")
contentHashFunc = w3.MustNewFunc("contentHash(bytes32)", "")
resolveFunc = w3.MustNewFunc("resolve(bytes,bytes)", "")
addrFunc = w3.MustNewFunc("addr(bytes32)", "address")
)

func (a *API) ccipHandler(w http.ResponseWriter, req bunrouter.Request) error {
Expand All @@ -32,21 +38,44 @@ func (a *API) ccipHandler(w http.ResponseWriter, req bunrouter.Request) error {

var (
encodedName []byte
data []byte
innerData []byte
)

if err := resolveFunc.DecodeArgs(w3.B(r.Data), &encodedName, &data); err != nil {
if err := resolveFunc.DecodeArgs(w3.B(r.Data), &encodedName, &innerData); err != nil {
return err
}

result, err := decodeInnerData(hexutil.Encode(innerData))
if err != nil {
return err
}

encodedNameHash, err := namehash.NameHash(decodeENSName(encodedName))
if err != nil {
return err
}

if !bytes.Equal(encodedNameHash[:], result.Bytes()) {
return ErrNameValidation
}

// TODO: Offchain lookup is performed here
// test.eth -> 0xDeaDbeefdEAdbeefdEadbEEFdeadbeEFdEaDbeeF
// For now we stub it with a test address
encodedResult := w3.A(testResolvedAddress)

// EIP-191 signature here

return httputil.JSON(w, http.StatusOK, OKResponse{
Ok: true,
Description: "CCIP Data",
Result: map[string]any{
"decodedName": decodeENSName(encodedName),
"nestedData": hexutil.Encode(data),
"sender": r.Sender,
"data": r.Data,
"decodedName": decodeENSName(encodedName),
"nestedData": hexutil.Encode(innerData),
"encodedResulthex": encodedResult.Hex(),
"result": result,
"sender": r.Sender,
"data": r.Data,
},
})
}
Expand Down Expand Up @@ -76,21 +105,21 @@ func decodeENSName(hexBytes []byte) string {
return strings.Join(decodedParts, ".")
}

func matchSignatureWithFunc(nestedDatHex string) *w3.Func {
if len(nestedDatHex) < 8 {
return nil
// For now, we will only support the addr(bytes32) function i.e. Ethereum address only
func decodeInnerData(nestedDatHex string) (*common.Hash, error) {
if len(nestedDatHex) < 10 {
return nil, fmt.Errorf("invalid nested data hex")
}

switch nestedDatHex[:8] {
case "0x3b3b57de":
return addrFunc
case "0xf1cb7e06":
return addrMulticoinFunc
case "0x59d1d43c":
return textFunc
case "0xbc1c58d1":
return contentHashFunc
if nestedDatHex[:10] == "0x3b3b57de" {
var result common.Hash

if err := addrFunc.DecodeArgs(w3.B(nestedDatHex), &result); err != nil {
return nil, err
}

return &result, nil
}

return nil
return nil, ErrUnsupportedFunction
}
106 changes: 106 additions & 0 deletions pkg/namehash.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
// Copyright 2017 - 2023 Weald Technology Trading.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package namehash provides functions to hash ENS names.
// Minor modifications to error returns have been made to fit the context of this project.

package namehash

import (
"fmt"
"strings"

"golang.org/x/crypto/sha3"
"golang.org/x/net/idna"
)

var (
p = idna.New(idna.MapForLookup(), idna.ValidateLabels(false), idna.CheckHyphens(false), idna.StrictDomainName(false), idna.Transitional(false))
pStrict = idna.New(idna.MapForLookup(), idna.ValidateLabels(false), idna.CheckHyphens(false), idna.StrictDomainName(true), idna.Transitional(false))
)

// Normalize normalizes a name according to the ENS rules.
func Normalize(input string) (string, error) {
output, err := p.ToUnicode(input)
if err != nil {
return "", fmt.Errorf("failed to convert to standard unicode: %v", err)
}
// If the name started with a period then ToUnicode() removes it, but we want to keep it.
if strings.HasPrefix(input, ".") && !strings.HasPrefix(output, ".") {
output = "." + output
}

return output, nil
}

// LabelHash generates a simple hash for a piece of a name.
func LabelHash(label string) ([32]byte, error) {
var hash [32]byte

normalizedLabel, err := Normalize(label)
if err != nil {
return [32]byte{}, err
}

sha := sha3.NewLegacyKeccak256()
if _, err = sha.Write([]byte(normalizedLabel)); err != nil {
return [32]byte{}, fmt.Errorf("failed to write hash: %v", err)
}
sha.Sum(hash[:0])

return hash, nil
}

// NameHash generates a hash from a name that can be used to
// look up the name in ENS.
func NameHash(name string) ([32]byte, error) {
var hash [32]byte

if name == "" {
return hash, nil
}

normalizedName, err := Normalize(name)
if err != nil {
return [32]byte{}, err
}
parts := strings.Split(normalizedName, ".")
for i := len(parts) - 1; i >= 0; i-- {
if hash, err = nameHashPart(hash, parts[i]); err != nil {
return [32]byte{}, err
}
}

return hash, nil
}

func nameHashPart(currentHash [32]byte, name string) ([32]byte, error) {
var hash [32]byte

sha := sha3.NewLegacyKeccak256()
if _, err := sha.Write(currentHash[:]); err != nil {
return [32]byte{}, fmt.Errorf("failed to write hash: %v", err)
}
nameSha := sha3.NewLegacyKeccak256()
if _, err := nameSha.Write([]byte(name)); err != nil {
return [32]byte{}, fmt.Errorf("failed to write hash: %v", err)
}
nameHash := nameSha.Sum(nil)
if _, err := sha.Write(nameHash); err != nil {
return [32]byte{}, fmt.Errorf("failed to write hash: %v", err)
}
sha.Sum(hash[:0])

return hash, nil
}
121 changes: 121 additions & 0 deletions pkg/namehash_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
// Copyright 2017 Weald Technology Trading
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package namehash provides functions to hash ENS names.
// Minor modifications to error returns have been made to fit the context of this project.

package namehash

import (
"encoding/hex"
"testing"
)

func TestNameHash(t *testing.T) {
tests := []struct {
input string
output string
err error
}{
{"", "0000000000000000000000000000000000000000000000000000000000000000", nil},
{"eth", "93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae", nil},
{"Eth", "93cdeb708b7545dc668eb9280176169d1c33cfd8ed6f04690a0bcc88a93fc4ae", nil},
{".eth", "8cc9f31a5e7af6381efc751d98d289e3f3589f1b6f19b9b989ace1788b939cf7", nil},
{"resolver.eth", "fdd5d5de6dd63db72bbc2d487944ba13bf775b50a80805fe6fcaba9b0fba88f5", nil},
{"foo.eth", "de9b09fd7c5f901e23a3f19fecc54828e9c848539801e86591bd9801b019f84f", nil},
{"Foo.eth", "de9b09fd7c5f901e23a3f19fecc54828e9c848539801e86591bd9801b019f84f", nil},
{"foo..eth", "4143a5b2f547838d3b49982e3f2ec6a26415274e5b9c3ffeb21971bbfdfaa052", nil},
{"bar.foo.eth", "275ae88e7263cdce5ab6cf296cdd6253f5e385353fe39cfff2dd4a2b14551cf3", nil},
{"Bar.foo.eth", "275ae88e7263cdce5ab6cf296cdd6253f5e385353fe39cfff2dd4a2b14551cf3", nil},
{"addr.reverse", "91d1777781884d03a6757a803996e38de2a42967fb37eeaca72729271025a9e2", nil},
{"🚣‍♂️.eth", "37f681401d88093779de0c910da1f9437759c2181f61b5dbc9e3ef0d9f192513", nil},
{"vitalik.eth", "ee6c4522aab0003e8d14cd40a6af439055fd2577951148c14b6cea9a53475835", nil},
{"nIcK.eTh", "05a67c0ee82964c4f7394cdd47fee7f4d9503a23c09c38341779ea012afe6e00", nil},
{"brantly.cash", "3cb8d24c572869f7ec5ec5e882243b4790de146ac11267f58fd856d290b593db", nil},
{"🏴‍☠.art", "4696ec532b8c8bb20dcfa6ae6da710422611ea03fc77aebc0284d0f12c93f768", nil},
{"öbb.eth", "2774094517aaa884fc7183cf681150529b9acc7c9e7b71cf3a470200135a20b4", nil},
{"Öbb.eth", "2774094517aaa884fc7183cf681150529b9acc7c9e7b71cf3a470200135a20b4", nil},
{"💷pound.eth", "2df37f43de8b5ab870370770e78e4503ea1199e46c16db7a4a9320732dbb42bc", nil},
{"firstwrappedname.eth", "c44eec7fb870ae46d4ef4392d33fbbbdc164e7817a86289a1fe30e5f4d98ae85", nil},
{"A.™️.Ю", "f48b2941db0e23087a8922f81c0b7dd1b83fa06657080fd28986f9a19752a093", nil},
{"Ⅷ.eth", "a468899f828f5d80c85c0e538018ba6516713a06aa6d92e8482ee91886630ae9", nil},
{"⨌.eth", "f0b6090714f4ab523b1c574077018fe49dc934f9334d092e412b3802898b2cee", nil},
{"-test.test-.t-e--s---t", "0d26fe02b1eb3fdcd7db77a432c60b20d2d8c4ef9012ef06ad3ae7bf12adb225", nil},
{"te--st.eth", "bea7eca33545aacbf3d6f1512c119aa7f04506d61354001e7af31ba73374b2c3", nil},
{"__ab.eth", "b3edf1f0b8dc6168b65d034c76b5670813514ac8867115e63b51eb496f3791a0", nil},
{"a_b.eth", "b99946eaeb8a557bc6329faf95d1b885ba608393109cb9609440acc8e6761c4f", nil},
{"ß.eth", "86262f2349fb651f652e87141e6db5856cd6e40f92d0b9dc486aaf8f9c509cff", nil},
{"💩💩💩.eth", "a74feb0e5fa5606d3e650275e3bb3873b006a10d558389d3ce2abbe681fcfc8e", nil},
{"آٍَ.ऩँं", "a1e3d72c39aec7ebcf62906994da7adc76b8a3ffa27e52b838abb24569610146", nil},
{"פעילותהבינאום.eth", "7900040d82be5a569289b0f7b30266d796e1ded13293557ed061b39367357a62", nil},
{"ஶ்ரீ.ஸ்ரீ", "ef5f28b8adff4b9b86b67c40792ef314ecd92a2123a72185b1411835cce5c110", nil},
{"🇸🇦سلمان.eth", "3484f75c4dbf69503310126dbfc02eec224eab46851de2288092d58785670808", nil},
{"0a〇.黑a8", "d7bc21f0cb86cafe27ebafe8e788b1c63b736467c65611110575f385a4d01e1f", nil},
{"apple.дррӏе.аррӏе.aррӏе", "a5428a7fc57a099d7926ac7fa30169933df167acf3d8fba6f5830e6cf7442b31", nil},
{"۰۱۲۳۷۸۹.eth", "430bc5e65fd3122d45c00dbce4e8e1b51be675794e548f92558dc4cecafd6418", nil},
{"𓀀𓀁𓀂.eth", "36f75325f4013011b96014606224f03c77366d89caf480a1060d7453edaf5c98", nil},
{"𓆏➡🐸️.eth", "f2663423c7aadf794d6f84addcfee1f877458d86c20740954482094a20985228", nil},
{"ⒶⒷⒸⒹⒺⒻⒼⒽⒾⒿⓀⓁⓂⓃⓄⓅⓆⓇⓈⓉⓊⓋⓌⓍⓎⓏ.eth", "254a068876bdac64ad35425816bf444fbe9a26ec19287f47e663f928727ff69c", nil},
}

for _, tt := range tests {
result, err := NameHash(tt.input)
if tt.err == nil {
if err != nil {
t.Fatalf("unexpected error %v", err)
}
if tt.output != hex.EncodeToString(result[:]) {
t.Errorf("Failure: %v => %v (expected %v)\n", tt.input, hex.EncodeToString(result[:]), tt.output)
}
} else {
if err == nil {
t.Fatalf("missing expected error")
}
if tt.err.Error() != err.Error() {
t.Errorf("unexpected error value %v", err)
}
}
}
}

func TestLabelHash(t *testing.T) {
tests := []struct {
input string
output string
err error
}{
{"", "c5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470", nil},
{"eth", "4f5b812789fc606be1b3b16908db13fc7a9adf7ca72641f84d75b47069d3d7f0", nil},
{"foo", "41b1a0649752af1b28b3dc29a1556eee781e4a4c3a1f7f53f90fa834de098c4d", nil},
}

for _, tt := range tests {
output, err := LabelHash(tt.input)
if tt.err == nil {
if err != nil {
t.Fatalf("unexpected error %v", err)
}
if tt.output != hex.EncodeToString(output[:]) {
t.Errorf("Failure: %v => %v (expected %v)\n", tt.input, hex.EncodeToString(output[:]), tt.output)
}
} else {
if err == nil {
t.Fatalf("missing expected error")
}
if tt.err.Error() != err.Error() {
t.Errorf("unexpected error value %v", err)
}
}
}
}

0 comments on commit e530f9b

Please sign in to comment.