Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: bech32 Address Hooks #10613

Merged
merged 4 commits into from
Dec 11, 2024
Merged

feat: bech32 Address Hooks #10613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dbad30b
feat(vats): first cut of Address Hooks in JS
michaelfig Dec 3, 2024
5014cf9
build(deps): regenerate `yarn.lock`s
michaelfig Dec 6, 2024
159098b
feat(vtransfer): port some `address-hooks.js` functions to Go
michaelfig Dec 8, 2024
c8ad417
docs(cosmic-proto): generate initial typedoc
michaelfig Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions a3p-integration/proposals/s:stake-bld/yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ __metadata:
dependencies:
"@endo/base64": "npm:^1.0.9"
"@endo/init": "npm:^1.1.7"
bech32: "npm:^2.0.0"
query-string: "npm:^9.1.1"
languageName: node
linkType: soft

Expand Down Expand Up @@ -1835,6 +1837,13 @@ __metadata:
languageName: node
linkType: hard

"bech32@npm:^2.0.0":
version: 2.0.0
resolution: "bech32@npm:2.0.0"
checksum: 10c0/45e7cc62758c9b26c05161b4483f40ea534437cf68ef785abadc5b62a2611319b878fef4f86ddc14854f183b645917a19addebc9573ab890e19194bc8f521942
languageName: node
linkType: hard

"better-sqlite3@npm:^9.1.1":
version: 9.4.3
resolution: "better-sqlite3@npm:9.4.3"
Expand Down Expand Up @@ -2362,6 +2371,13 @@ __metadata:
languageName: node
linkType: hard

"decode-uri-component@npm:^0.4.1":
version: 0.4.1
resolution: "decode-uri-component@npm:0.4.1"
checksum: 10c0/a180bbdb5398ec8270d236a3ac07cb988bbf6097428481780b85840f088951dc0318a8d8f9d56796e1a322b55b29859cea29982f22f9b03af0bc60974c54e591
languageName: node
linkType: hard

"decompress-response@npm:^6.0.0":
version: 6.0.0
resolution: "decompress-response@npm:6.0.0"
Expand Down Expand Up @@ -2777,6 +2793,13 @@ __metadata:
languageName: node
linkType: hard

"filter-obj@npm:^5.1.0":
version: 5.1.0
resolution: "filter-obj@npm:5.1.0"
checksum: 10c0/716e8ad2bc352e206556b3e5695b3cdff8aab80c53ea4b00c96315bbf467b987df3640575100aef8b84e812cf5ea4251db4cd672bbe33b1e78afea88400c67dd
languageName: node
linkType: hard

"find-up@npm:^6.0.0":
version: 6.3.0
resolution: "find-up@npm:6.3.0"
Expand Down Expand Up @@ -4425,6 +4448,17 @@ __metadata:
languageName: node
linkType: hard

"query-string@npm:^9.1.1":
version: 9.1.1
resolution: "query-string@npm:9.1.1"
dependencies:
decode-uri-component: "npm:^0.4.1"
filter-obj: "npm:^5.1.0"
split-on-first: "npm:^3.0.0"
checksum: 10c0/16481f17754f660aec3cae7abb838a70e383dfcf152414d184e0d0f81fae426acf112b4d51bf754f9c256eaf83ba4241241ba907c8d58b6ed9704425e1712e8c
languageName: node
linkType: hard

"queue-microtask@npm:^1.2.2":
version: 1.2.3
resolution: "queue-microtask@npm:1.2.3"
Expand Down Expand Up @@ -4818,6 +4852,13 @@ __metadata:
languageName: node
linkType: hard

"split-on-first@npm:^3.0.0":
version: 3.0.0
resolution: "split-on-first@npm:3.0.0"
checksum: 10c0/a1262eae12b68de235e1a08e011bf5b42c42621985ddf807e6221fb1e2b3304824913ae7019f18436b96b8fab8aef5f1ad80dedd2385317fdc51b521c3882cd0
languageName: node
linkType: hard

"sprintf-js@npm:~1.0.2":
version: 1.0.3
resolution: "sprintf-js@npm:1.0.3"
Expand Down
41 changes: 41 additions & 0 deletions a3p-integration/proposals/z:acceptance/yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ __metadata:
dependencies:
"@endo/base64": "npm:^1.0.9"
"@endo/init": "npm:^1.1.7"
bech32: "npm:^2.0.0"
query-string: "npm:^9.1.1"
languageName: node
linkType: soft

Expand Down Expand Up @@ -1989,6 +1991,13 @@ __metadata:
languageName: node
linkType: hard

"bech32@npm:^2.0.0":
version: 2.0.0
resolution: "bech32@npm:2.0.0"
checksum: 10c0/45e7cc62758c9b26c05161b4483f40ea534437cf68ef785abadc5b62a2611319b878fef4f86ddc14854f183b645917a19addebc9573ab890e19194bc8f521942
languageName: node
linkType: hard

"better-sqlite3@npm:^9.1.1, better-sqlite3@npm:^9.6.0":
version: 9.6.0
resolution: "better-sqlite3@npm:9.6.0"
Expand Down Expand Up @@ -2543,6 +2552,13 @@ __metadata:
languageName: node
linkType: hard

"decode-uri-component@npm:^0.4.1":
version: 0.4.1
resolution: "decode-uri-component@npm:0.4.1"
checksum: 10c0/a180bbdb5398ec8270d236a3ac07cb988bbf6097428481780b85840f088951dc0318a8d8f9d56796e1a322b55b29859cea29982f22f9b03af0bc60974c54e591
languageName: node
linkType: hard

"decompress-response@npm:^6.0.0":
version: 6.0.0
resolution: "decompress-response@npm:6.0.0"
Expand Down Expand Up @@ -3204,6 +3220,13 @@ __metadata:
languageName: node
linkType: hard

"filter-obj@npm:^5.1.0":
version: 5.1.0
resolution: "filter-obj@npm:5.1.0"
checksum: 10c0/716e8ad2bc352e206556b3e5695b3cdff8aab80c53ea4b00c96315bbf467b987df3640575100aef8b84e812cf5ea4251db4cd672bbe33b1e78afea88400c67dd
languageName: node
linkType: hard

"find-up-simple@npm:^1.0.0":
version: 1.0.0
resolution: "find-up-simple@npm:1.0.0"
Expand Down Expand Up @@ -5357,6 +5380,17 @@ __metadata:
languageName: node
linkType: hard

"query-string@npm:^9.1.1":
version: 9.1.1
resolution: "query-string@npm:9.1.1"
dependencies:
decode-uri-component: "npm:^0.4.1"
filter-obj: "npm:^5.1.0"
split-on-first: "npm:^3.0.0"
checksum: 10c0/16481f17754f660aec3cae7abb838a70e383dfcf152414d184e0d0f81fae426acf112b4d51bf754f9c256eaf83ba4241241ba907c8d58b6ed9704425e1712e8c
languageName: node
linkType: hard

"queue-microtask@npm:^1.2.2":
version: 1.2.3
resolution: "queue-microtask@npm:1.2.3"
Expand Down Expand Up @@ -5905,6 +5939,13 @@ __metadata:
languageName: node
linkType: hard

"split-on-first@npm:^3.0.0":
version: 3.0.0
resolution: "split-on-first@npm:3.0.0"
checksum: 10c0/a1262eae12b68de235e1a08e011bf5b42c42621985ddf807e6221fb1e2b3304824913ae7019f18436b96b8fab8aef5f1ad80dedd2385317fdc51b521c3882cd0
languageName: node
linkType: hard

"sprintf-js@npm:^1.1.3":
version: 1.1.3
resolution: "sprintf-js@npm:1.1.3"
Expand Down
105 changes: 77 additions & 28 deletions golang/cosmos/x/vtransfer/types/baseaddr.go → golang/cosmos/types/address_hooks.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
package types

import (
"bytes"
"fmt"
"net/url"
"strings"

"github.com/cosmos/cosmos-sdk/codec"
"github.com/cosmos/cosmos-sdk/types/bech32"

transfertypes "github.com/cosmos/ibc-go/v6/modules/apps/transfer/types"
clienttypes "github.com/cosmos/ibc-go/v6/modules/core/02-client/types"
Expand All @@ -18,48 +18,97 @@ type AddressRole string
const (
RoleSender AddressRole = "Sender"
RoleReceiver AddressRole = "Receiver"

AddressHookVersion = 0
BaseAddressLengthBytes = 2
)

func trimSlashPrefix(s string) string {
return strings.TrimPrefix(s, "/")
// AddressHookMagic is a magic byte prefix that identifies a hooked address.
// Chosen to make bech32 address hooks that look like "agoric10rch..."
var AddressHookMagic = []byte{0x78, 0xf1, 0x70 | AddressHookVersion}

func init() {
if AddressHookVersion&0x0f != AddressHookVersion {
panic(fmt.Sprintf("AddressHookVersion must be less than 0x10, got 0x%x", AddressHookVersion))
}
}

// ExtractBaseAddress extracts the base address from a parameterized address.
// It removes all subpath and query components from addr.
// ExtractBaseAddress extracts the base address from an Address Hook. It
// returns addr verbatim if it is not an Address Hook.
func ExtractBaseAddress(addr string) (string, error) {
parsed, err := url.Parse(addr)
baseAddr, _, err := SplitHookedAddress(addr)
if err != nil {
return "", err
}
return baseAddr, nil
}

// SplitHookedAddress splits a hooked address into its base address and hook data.
// For the JS implementation, look at @agoric/cosmic-proto/src/address-hooks.js.
func SplitHookedAddress(addr string) (string, []byte, error) {
prefix, payload, err := bech32.DecodeAndConvert(addr)
if err != nil {
return "", []byte{}, err
}

// Specify the fields and values we expect. Unspecified fields will only
// match if they are zero values in order to be robust against extensions to
// the url.URL struct.
//
// Remove leading slashes from the path fields so that only parsed relative
// paths match the expected test.
expected := url.URL{
Path: trimSlashPrefix(parsed.Path),
RawPath: trimSlashPrefix(parsed.RawPath),
RawQuery: parsed.RawQuery,
Fragment: parsed.Fragment,
RawFragment: parsed.RawFragment,
bz := bytes.TrimPrefix(payload, AddressHookMagic)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bz is mnemonic for something like "bytez", a play on "bytes"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it's a Golang convention I picked up from Golang json and protobuf codecs.

if len(bz) == len(payload) {
// Return an unhooked address.
return addr, []byte{}, nil
}
Comment on lines +54 to +58
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For forward compatibility, this should probably error upon encountering a hooked address with an unknown version.

Suggested change
bz := bytes.TrimPrefix(payload, AddressHookMagic)
if len(bz) == len(payload) {
// Return an unhooked address.
return addr, []byte{}, nil
}
bz := bytes.TrimPrefix(payload, AddressHookMagic[:2])
if len(bz) == len(payload) || len(bz) == 0 || bz[0] & 0x70 != 0x70 {
// Return an unhooked address.
return addr, []byte{}, nil
}
version := bz[0] & 0x0F
bz = bz[1:]
if version != AddressHookVersion {
return "", []byte{}, fmt.Errorf("unsupported version %d", version)
}

(and likewise in the JS version)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@turadg , @LuqiPan ,

I suppose this shows that my assumption that the design was agreed by all the relevant parties is not correct.


// Skip over parsing control flags.
ForceQuery: parsed.ForceQuery,
OmitHost: parsed.OmitHost,
if len(bz) < BaseAddressLengthBytes {
return "", []byte{}, fmt.Errorf("hooked address must have at least %d bytes", BaseAddressLengthBytes)
}

if *parsed != expected {
return "", fmt.Errorf("address must be relative path with optional query and fragment, got %s", addr)
b := 0
for i := BaseAddressLengthBytes - 1; i >= 0; i -= 1 {
byteVal := bz[len(bz)-1-i]
b <<= 8
b |= int(byteVal)
}

baseAddr, _, _ := strings.Cut(expected.Path, "/")
if baseAddr == "" {
return "", fmt.Errorf("base address cannot be empty")
payloadEnd := len(bz) - BaseAddressLengthBytes
if b > payloadEnd {
return "", []byte{}, fmt.Errorf("base address length 0x%x is longer than payload end 0x%x", b, payloadEnd)
}

return baseAddr, nil
baseAddressBuf := bz[0:b]
baseAddress, err := bech32.ConvertAndEncode(prefix, baseAddressBuf)
if err != nil {
return "", []byte{}, err
}

return baseAddress, bz[b:payloadEnd], nil
}

// JoinHookedAddress joins a base bech32 address with hook data to create a
// hooked bech32 address.
// For the JS implementation, look at @agoric/cosmic-proto/src/address-hooks.js
func JoinHookedAddress(baseAddr string, hookData []byte) (string, error) {
prefix, bz, err := bech32.DecodeAndConvert(baseAddr)
if err != nil {
return "", err
}

b := len(bz)
maxB := 1<<(8*BaseAddressLengthBytes-1) + 1
if b > maxB {
return "", fmt.Errorf("base address length 0x%x is longer than the maximum 0x%x", b, maxB)
}

payload := make([]byte, 0, len(AddressHookMagic)+b+len(hookData)+BaseAddressLengthBytes)
payload = append(payload, AddressHookMagic...)
payload = append(payload, bz...)
payload = append(payload, hookData...)
baLen := make([]byte, BaseAddressLengthBytes)
for i := BaseAddressLengthBytes - 1; i >= 0; i -= 1 {
baLen[i] = byte(b)
b >>= 8
}
payload = append(payload, baLen...)

return bech32.ConvertAndEncode(prefix, payload)
}

// extractBaseTransferData returns the base address from the transferData.Sender
Expand Down
Loading
Loading