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.

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

Support byron address #1

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
79 changes: 43 additions & 36 deletions address.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,39 +9,46 @@ import (
"golang.org/x/crypto/blake2b"
)

type AddressType byte
type ShelleyAddressType byte

// refer to pg.120 in https://hydra.iohk.io/build/7918420/download/1/ledger-spec.pdf
const (
Base AddressType = 0x00
Ptr AddressType = 0x04
Enterprise AddressType = 0x06
Stake AddressType = 0x0E
Base ShelleyAddressType = 0x00
Ptr ShelleyAddressType = 0x04
Enterprise ShelleyAddressType = 0x06
Stake ShelleyAddressType = 0x0E
)

// Address represents a Cardano address.
type Address struct {
type Address interface {
Bech32() string
MarshalCBOR() ([]byte, error)
UnmarshalCBOR(data []byte) error
Bytes() []byte
}

// ShelleyAddress represents a Cardano address.
type ShelleyAddress struct {
Network Network
Type AddressType
Type ShelleyAddressType
Pointer Pointer

Payment StakeCredential
Stake StakeCredential
}

// NewAddress creates an Address from a bech32 encoded string.
func NewAddress(bech string) (Address, error) {
// NewShelleyAddress creates an ShelleyAddress from a bech32 encoded string.
func NewAddress(bech string) (ShelleyAddress, error) {
_, bytes, err := bech32.DecodeToBase256(bech)
if err != nil {
return Address{}, err
return ShelleyAddress{}, err
}
return NewAddressFromBytes(bytes)
}

// NewAddressFromBytes creates an Address from bytes.
func NewAddressFromBytes(bytes []byte) (Address, error) {
addr := Address{
Type: AddressType(bytes[0] >> 4),
// NewAddressFromBytes creates an ShelleyAddress from bytes.
func NewAddressFromBytes(bytes []byte) (ShelleyAddress, error) {
addr := ShelleyAddress{
Type: ShelleyAddressType(bytes[0] >> 4),
Network: Network(bytes[0] & 0x01),
}

Expand Down Expand Up @@ -184,13 +191,13 @@ func NewAddressFromBytes(bytes []byte) (Address, error) {
}

// MarshalCBOR implements cbor.Marshaler.
func (addr *Address) MarshalCBOR() ([]byte, error) {
func (addr *ShelleyAddress) MarshalCBOR() ([]byte, error) {
em, _ := cbor.CanonicalEncOptions().EncMode()
return em.Marshal(addr.Bytes())
}

// UnmarshalCBOR implements cbor.Unmarshaler.
func (addr *Address) UnmarshalCBOR(data []byte) error {
func (addr *ShelleyAddress) UnmarshalCBOR(data []byte) error {
bytes := []byte{}
if err := cborDec.Unmarshal(data, &bytes); err != nil {
return nil
Expand All @@ -209,8 +216,8 @@ func (addr *Address) UnmarshalCBOR(data []byte) error {
return nil
}

// Bytes returns the CBOR encoding of the Address as bytes.
func (addr *Address) Bytes() []byte {
// Bytes returns the CBOR encoding of the ShelleyAddress as bytes.
func (addr *ShelleyAddress) Bytes() []byte {
var networkByte uint8
switch addr.Network {
case Testnet, Preprod:
Expand Down Expand Up @@ -238,22 +245,22 @@ func (addr *Address) Bytes() []byte {
return addrBytes
}

// Bech32 returns the Address encoded as bech32.
func (addr *Address) Bech32() string {
// Bech32 returns the ShelleyAddress encoded as bech32.
func (addr *ShelleyAddress) Bech32() string {
addrStr, err := bech32.EncodeFromBase256(getHrp(addr.Network, addr.Type), addr.Bytes())
if err != nil {
panic(err)
}
return addrStr
}

// String returns the Address encoded as bech32.
func (addr Address) String() string {
// String returns the ShelleyAddress encoded as bech32.
func (addr ShelleyAddress) String() string {
return addr.Bech32()
}

// NewBaseAddress returns a new Base Address.
func NewBaseAddress(network Network, payment StakeCredential, stake StakeCredential) (Address, error) {
// NewBaseShelleyAddress returns a new Base Address.
func NewBaseAddress(network Network, payment StakeCredential, stake StakeCredential) (ShelleyAddress, error) {
addrType := Base
if payment.Type == ScriptCredential && stake.Type == KeyCredential {
addrType = Base + 1
Expand All @@ -262,7 +269,7 @@ func NewBaseAddress(network Network, payment StakeCredential, stake StakeCredent
} else if payment.Type == ScriptCredential && stake.Type == ScriptCredential {
addrType = Base + 3
}
return Address{Type: addrType, Network: network, Payment: payment, Stake: stake}, nil
return ShelleyAddress{Type: addrType, Network: network, Payment: payment, Stake: stake}, nil
}

// Pointer is the location of the Stake Registration Certificate in the blockchain.
Expand All @@ -272,31 +279,31 @@ type Pointer struct {
CertIndex uint64
}

// NewPointerAddress returns a new Pointer Address.
func NewPointerAddress(network Network, payment StakeCredential, ptr Pointer) (Address, error) {
// NewPointerShelleyAddress returns a new Pointer Address.
func NewPointerAddress(network Network, payment StakeCredential, ptr Pointer) (ShelleyAddress, error) {
addrType := Ptr
if payment.Type == ScriptCredential {
addrType = Ptr + 1
}
return Address{Type: addrType, Network: network, Payment: payment, Pointer: ptr}, nil
return ShelleyAddress{Type: addrType, Network: network, Payment: payment, Pointer: ptr}, nil
}

// NewEnterpriseAddress returns a new Enterprise Address.
func NewEnterpriseAddress(network Network, payment StakeCredential) (Address, error) {
// NewEnterpriseShelleyAddress returns a new Enterprise Address.
func NewEnterpriseAddress(network Network, payment StakeCredential) (ShelleyAddress, error) {
addrType := Enterprise
if payment.Type == ScriptCredential {
addrType = Enterprise + 1
}
return Address{Type: addrType, Network: network, Payment: payment}, nil
return ShelleyAddress{Type: addrType, Network: network, Payment: payment}, nil
}

// NewStakeAddress returns a new Stake Address.
func NewStakeAddress(network Network, stake StakeCredential) (Address, error) {
// NewStakeShelleyAddress returns a new Stake Address.
func NewStakeAddress(network Network, stake StakeCredential) (ShelleyAddress, error) {
addrType := Stake
if stake.Type == ScriptCredential {
addrType = Stake + 1
}
return Address{Type: addrType, Network: network, Stake: stake}, nil
return ShelleyAddress{Type: addrType, Network: network, Stake: stake}, nil
}

func decodeFromNat(data []byte) (uint64, uint, error) {
Expand Down Expand Up @@ -345,7 +352,7 @@ func Blake224Hash(b []byte) ([]byte, error) {
return hash.Sum(nil), err
}

func getHrp(network Network, addrType AddressType) string {
func getHrp(network Network, addrType ShelleyAddressType) string {
hrp := "addr"
if addrType == Stake || addrType == Stake+1 {
hrp = "stake"
Expand Down
22 changes: 22 additions & 0 deletions byron_address.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package cardano

import (
"github.com/Bitrue-exchange/libada-go"
"github.com/cosmos/btcutil/base58"
)

type ByronAddress struct {
libada.LegacyAddress
}

func NewByronAddress(b58 string) (*ByronAddress, error) {
ba := &ByronAddress{}
err := ba.UnmarshalCBOR(base58.Decode(b58))
if err != nil {
return nil, err
}
return ba, nil
}
func (ba *ByronAddress) Bech32() string {
return ""
}
4 changes: 4 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ go 1.18

require (
filippo.io/edwards25519 v1.0.0
github.com/Bitrue-exchange/libada-go v0.0.1-rc
github.com/blockfrost/blockfrost-go v0.1.0
github.com/cosmos/btcutil v1.0.5
github.com/dgraph-io/badger/v3 v3.2103.2
github.com/echovl/ed25519 v0.2.0
github.com/matoous/go-nanoid/v2 v2.0.0
Expand All @@ -23,6 +25,7 @@ require (
github.com/dgraph-io/ristretto v0.1.0 // indirect
github.com/dustin/go-humanize v1.0.0 // indirect
github.com/fsnotify/fsnotify v1.5.4 // indirect
github.com/fxamacker/cbor/v2 v2.3.0 // indirect
github.com/gogo/protobuf v1.3.2 // indirect
github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b // indirect
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
Expand All @@ -33,6 +36,7 @@ require (
github.com/hashicorp/go-retryablehttp v0.7.0 // indirect
github.com/hashicorp/hcl v1.0.0 // indirect
github.com/inconshreveable/mousetrap v1.0.0 // indirect
github.com/islishude/base58 v1.0.1 // indirect
github.com/klauspost/compress v1.12.3 // indirect
github.com/magiconair/properties v1.8.6 // indirect
github.com/mitchellh/mapstructure v1.5.0 // indirect
Expand Down
11 changes: 11 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ cloud.google.com/go/storage v1.14.0/go.mod h1:GrKmX003DSIwi9o29oFT7YDnHYwZoctc3f
dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU=
filippo.io/edwards25519 v1.0.0 h1:0wAIcmJUqRdI8IJ/3eGi5/HwXZWPujYXXlkrQogz0Ek=
filippo.io/edwards25519 v1.0.0/go.mod h1:N1IkdkCkiLB6tki+MYJoSx2JTY9NUlxZE7eHn5EwJns=
github.com/Bitrue-exchange/libada-go v0.0.1-rc h1:duA44UKnJvDDit+6/EKWbPYMV6bzfpA/ldwb3eqd+0Q=
github.com/Bitrue-exchange/libada-go v0.0.1-rc/go.mod h1:dDA2Sx73XOqa1z7DZ32sgcJY5oAJGtFHwV++9HLpkNM=
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo=
github.com/OneOfOne/xxhash v1.2.2 h1:KMrpdQIwFcEqXDklaen+P1axHaj9BSKzvpUUfnHldSE=
Expand All @@ -60,6 +62,8 @@ github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnht
github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE=
github.com/coreos/go-etcd v2.0.0+incompatible/go.mod h1:Jez6KQU2B/sWsbdaef3ED8NzMklzPG4d5KIOhIy30Tk=
github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
github.com/cosmos/btcutil v1.0.5 h1:t+ZFcX77LpKtDBhjucvnOH8C2l2ioGsBNEQ3jef8xFk=
github.com/cosmos/btcutil v1.0.5/go.mod h1:IyB7iuqZMJlthe2tkIFL33xPyzbFYP0XVdS8P5lUPis=
github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE=
github.com/cpuguy83/go-md2man/v2 v2.0.1/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
Expand All @@ -86,6 +90,8 @@ github.com/frankban/quicktest v1.14.3 h1:FJKSZTDHjyhriyC81FLQ0LY93eSai0ZyR/ZIkd3
github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
github.com/fsnotify/fsnotify v1.5.4 h1:jRbGcIw6P2Meqdwuo0H1p6JVLbL5DHKAKlYndzMwVZI=
github.com/fsnotify/fsnotify v1.5.4/go.mod h1:OVB6XrOHzAwXMpEM7uPOzcehqUV2UqJxmVXmkdnm1bU=
github.com/fxamacker/cbor/v2 v2.3.0 h1:aM45YGMctNakddNNAezPxDUpv38j44Abh+hifNuqXik=
github.com/fxamacker/cbor/v2 v2.3.0/go.mod h1:TA1xS00nchWmaBnEIxPSE5oHLuJBAVvqrtAnWBwBCVo=
github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1/go.mod h1:vR7hzQXu2zJy9AVAgeJqvqgH9Q5CA+iKCZ2gyEVpxRU=
github.com/go-gl/glfw/v3.3/glfw v0.0.0-20191125211704-12ad95a8df72/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8=
github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8=
Expand Down Expand Up @@ -173,6 +179,10 @@ github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:
github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
github.com/islishude/base58 v1.0.1 h1:oY9rmolPWkTfNA31gFHA1D7f5zoueyajgv3qWlhFDEQ=
github.com/islishude/base58 v1.0.1/go.mod h1:YaFmRvjG56e35g5kjLwvU0pmHPdB2eoeoE9xBILnaRo=
github.com/islishude/bip32 v1.0.2 h1:pZ/OnlCePDeMsVZtGEXimCLc8ZVHrIRkZHx7Sp7ZdAc=
github.com/islishude/bip32 v1.0.2/go.mod h1:QVwq9Zrte7nf6N3kiWXSMj1xJnPfQe/Z26AI5WBh/bo=
github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU=
github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/XSXhF0NWZEnDohbsk=
github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8=
Expand Down Expand Up @@ -268,6 +278,7 @@ golang.org/x/crypto v0.0.0-20190605123033-f99c8df09eb5/go.mod h1:yigFU9vqHzYiE8U
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/crypto v0.0.0-20210421170649-83a5a9bb288b/go.mod h1:T9bdIzuCu7OtxOm1hfPfRQxPLYneinmdGuTeoZ9dtd4=
golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
golang.org/x/crypto v0.0.0-20211108221036-ceb1ce70b4fa/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
golang.org/x/crypto v0.0.0-20220525230936-793ad666bf5e h1:T8NU3HyQ8ClP4SEE+KbFlg6n0NhuTsN4MyznaarGsZM=
golang.org/x/crypto v0.0.0-20220525230936-793ad666bf5e/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
Expand Down
2 changes: 0 additions & 2 deletions internal/cbor/decode.go
Original file line number Diff line number Diff line change
Expand Up @@ -728,8 +728,6 @@ func (d *decoder) parseToValue(v reflect.Value, tInfo *typeInfo) error { //nolin
}
v.Set(reflect.ValueOf(NewByteString(rb.Bytes())))
return nil
} else {
return fillByteString(t, b, v)
}
return fillByteString(t, b, v)
case cborTypeTextString:
Expand Down
24 changes: 12 additions & 12 deletions tx_builder_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ func TestSimpleTx(t *testing.T) {
t.Fatal(err)
}
txIn := NewTxInput(txHashIn, 0, NewValue(tc.input))
txOut := NewTxOutput(addrOut, NewValue(tc.output))
txOut := NewTxOutput(&addrOut, NewValue(tc.output))

txBuilder := NewTxBuilder(alonzoProtocol)

Expand Down Expand Up @@ -227,15 +227,15 @@ func TestMintingAssets(t *testing.T) {
NewTxInput(txHash, 0, NewValue(inputAmount)),
)
txBuilder.AddOutputs(
NewTxOutput(addr, NewValueWithAssets(transferAmount, newAsset.MultiAsset())),
NewTxOutput(&addr, NewValueWithAssets(transferAmount, newAsset.MultiAsset())),
)

txBuilder.Mint(newAsset)
txBuilder.AddNativeScript(policyScript)
txBuilder.SetTTL(100000)
txBuilder.Sign(paymentKey.PrvKey())
txBuilder.Sign(policyKey.PrvKey())
txBuilder.AddChangeIfNeeded(addr)
txBuilder.AddChangeIfNeeded(&addr)
tx, err := txBuilder.Build()
if err != nil {
t.Fatal(err)
Expand Down Expand Up @@ -354,7 +354,7 @@ func TestSendingMultiAssets(t *testing.T) {
NewTxInput(txHash, 0, tc.txInputAmount),
)
txBuilder.AddOutputs(
NewTxOutput(addr, tc.txOutputAmount),
NewTxOutput(&addr, tc.txOutputAmount),
)
txBuilder.SetTTL(100000)
txBuilder.Sign(paymentKey.PrvKey())
Expand All @@ -367,7 +367,7 @@ func TestSendingMultiAssets(t *testing.T) {
},
})

txBuilder.AddChangeIfNeeded(addr)
txBuilder.AddChangeIfNeeded(&addr)
tx, err := txBuilder.Build()
if err != nil {
if tc.wantErr {
Expand Down Expand Up @@ -438,7 +438,7 @@ func TestAddChangeIfNeeded(t *testing.T) {
},
outputs: []*TxOutput{
{
Address: receiver,
Address: &receiver,
Amount: NewValue(200000),
},
},
Expand All @@ -458,7 +458,7 @@ func TestAddChangeIfNeeded(t *testing.T) {
},
outputs: []*TxOutput{
{
Address: receiver,
Address: &receiver,
Amount: NewValue(txBuilder.MinCoinsForTxOut(emptyTxOut)),
},
},
Expand All @@ -477,7 +477,7 @@ func TestAddChangeIfNeeded(t *testing.T) {
},
outputs: []*TxOutput{
{
Address: receiver,
Address: &receiver,
Amount: NewValue(txBuilder.MinCoinsForTxOut(emptyTxOut)),
},
},
Expand All @@ -496,7 +496,7 @@ func TestAddChangeIfNeeded(t *testing.T) {
},
outputs: []*TxOutput{
{
Address: receiver,
Address: &receiver,
Amount: NewValue(txBuilder.MinCoinsForTxOut(emptyTxOut)),
},
},
Expand All @@ -515,7 +515,7 @@ func TestAddChangeIfNeeded(t *testing.T) {
},
outputs: []*TxOutput{
{
Address: receiver,
Address: &receiver,
Amount: NewValue(txBuilder.MinCoinsForTxOut(emptyTxOut)),
},
},
Expand All @@ -535,7 +535,7 @@ func TestAddChangeIfNeeded(t *testing.T) {
},
outputs: []*TxOutput{
{
Address: receiver,
Address: &receiver,
Amount: NewValue(txBuilder.MinCoinsForTxOut(emptyTxOut)),
},
},
Expand All @@ -560,7 +560,7 @@ func TestAddChangeIfNeeded(t *testing.T) {
txBuilder.AddOutputs(tc.fields.outputs...)
txBuilder.SetTTL(tc.fields.ttl)
txBuilder.Sign(key.PrvKey())
txBuilder.AddChangeIfNeeded(changeAddr)
txBuilder.AddChangeIfNeeded(&changeAddr)
tx, err := txBuilder.Build()
if err != nil {
if tc.wantErr {
Expand Down
Loading