Implement strkey functions for liquidity pools and claimable balance ids (#5640)

Author: tamirms

ingest/processors/token_transfer/helpers.go

@@ -3,7 +3,9 @@ package token_transfer
 import (
 	"crypto/sha256"
 	"fmt"
+
 	"github.com/stellar/go/ingest"
+	"github.com/stellar/go/strkey"
 	"github.com/stellar/go/xdr"
 )
 
@@ -59,14 +61,12 @@ func protoAddressFromAccount(account xdr.MuxedAccount) string {
 	return account.ToAccountId().Address()
 }
 
-// TODO convert to strkey for LpId
 func lpIdToStrkey(lpId xdr.PoolId) string {
-	return xdr.Hash(lpId).HexString()
+	return strkey.MustEncode(strkey.VersionByteLiquidityPool, lpId[:])
 }
 
-// TODO convert to strkey for CbId
 func cbIdToStrkey(cbId xdr.ClaimableBalanceId) string {
-	return cbId.MustV0().HexString()
+	return cbId.MustEncodeToStrkey()
 }
 
 // This operation is used to only find CB entries that are either created or deleted, not updated

strkey/decode_test.go

@@ -99,6 +99,31 @@ func TestDecode(t *testing.T) {
 			},
 			Address: "CA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJUWDA",
 		},
+		{
+			Name:                "Liquidity Pool",
+			ExpectedVersionByte: VersionByteLiquidityPool,
+			ExpectedPayload: []byte{
+				0x3f, 0x0c, 0x34, 0xbf, 0x93, 0xad, 0x0d, 0x99,
+				0x71, 0xd0, 0x4c, 0xcc, 0x90, 0xf7, 0x05, 0x51,
+				0x1c, 0x83, 0x8a, 0xad, 0x97, 0x34, 0xa4, 0xa2,
+				0xfb, 0x0d, 0x7a, 0x03, 0xfc, 0x7f, 0xe8, 0x9a,
+			},
+			Address: "LA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJUPJN",
+		},
+		{
+			Name:                "Claimable Balance",
+			ExpectedVersionByte: VersionByteClaimableBalance,
+			ExpectedPayload: []byte{
+				// first byte represents ClaimableBalanceIDType (in this case it's V0)
+				0x00,
+				// the remaining 32 bytes are the contents of the claimable balance hash
+				0x3f, 0x0c, 0x34, 0xbf, 0x93, 0xad, 0x0d, 0x99,
+				0x71, 0xd0, 0x4c, 0xcc, 0x90, 0xf7, 0x05, 0x51,
+				0x1c, 0x83, 0x8a, 0xad, 0x97, 0x34, 0xa4, 0xa2,
+				0xfb, 0x0d, 0x7a, 0x03, 0xfc, 0x7f, 0xe8, 0x9a,
+			},
+			Address: "BAAD6DBUX6J22DMZOHIEZTEQ64CVCHEDRKWZONFEUL5Q26QD7R76RGR4TU",
+		},
 	}
 
 	for _, kase := range cases {

strkey/encode_test.go

@@ -100,6 +100,31 @@ func TestEncode(t *testing.T) {
 			},
 			Expected: "CA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJUWDA",
 		},
+		{
+			Name:        "Liquidity Pool",
+			VersionByte: VersionByteLiquidityPool,
+			Payload: []byte{
+				0x3f, 0x0c, 0x34, 0xbf, 0x93, 0xad, 0x0d, 0x99,
+				0x71, 0xd0, 0x4c, 0xcc, 0x90, 0xf7, 0x05, 0x51,
+				0x1c, 0x83, 0x8a, 0xad, 0x97, 0x34, 0xa4, 0xa2,
+				0xfb, 0x0d, 0x7a, 0x03, 0xfc, 0x7f, 0xe8, 0x9a,
+			},
+			Expected: "LA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJUPJN",
+		},
+		{
+			Name:        "Claimable Balance",
+			VersionByte: VersionByteClaimableBalance,
+			Payload: []byte{
+				// first byte represents ClaimableBalanceIDType (in this case it's V0)
+				0x00,
+				// the remaining 32 bytes are the contents of the claimable balance hash
+				0x3f, 0x0c, 0x34, 0xbf, 0x93, 0xad, 0x0d, 0x99,
+				0x71, 0xd0, 0x4c, 0xcc, 0x90, 0xf7, 0x05, 0x51,
+				0x1c, 0x83, 0x8a, 0xad, 0x97, 0x34, 0xa4, 0xa2,
+				0xfb, 0x0d, 0x7a, 0x03, 0xfc, 0x7f, 0xe8, 0x9a,
+			},
+			Expected: "BAAD6DBUX6J22DMZOHIEZTEQ64CVCHEDRKWZONFEUL5Q26QD7R76RGR4TU",
+		},
 	}
 
 	for _, kase := range cases {

strkey/main.go

@@ -41,6 +41,12 @@ const (
 
 	//VersionByteContract is the version byte used for encoded stellar contracts
 	VersionByteContract = 2 << 3 // Base-32 encodes to 'C'
+
+	//VersionByteLiquidityPool is the version byte used for encoded stellar liquidity pools
+	VersionByteLiquidityPool = 11 << 3
+
+	//VersionByteClaimableBalance is the version byte used for encoded stellar claimable balances
+	VersionByteClaimableBalance = 1 << 3
 )
 
 // maxPayloadSize is the maximum length of the payload for all versions. The
@@ -191,7 +197,9 @@ func Version(src string) (VersionByte, error) {
 // is not one of the defined valid version byte constants.
 func checkValidVersionByte(version VersionByte) error {
 	switch version {
-	case VersionByteAccountID, VersionByteMuxedAccount, VersionByteSeed, VersionByteHashTx, VersionByteHashX, VersionByteSignedPayload, VersionByteContract:
+	case VersionByteAccountID, VersionByteMuxedAccount, VersionByteSeed,
+		VersionByteHashTx, VersionByteHashX, VersionByteSignedPayload,
+		VersionByteContract, VersionByteLiquidityPool, VersionByteClaimableBalance:
 		return nil
 	default:
 		return ErrInvalidVersionByte

strkey/main_test.go

@@ -51,6 +51,16 @@ func TestVersion(t *testing.T) {
 			Address:             "CA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJUWDA",
 			ExpectedVersionByte: VersionByteContract,
 		},
+		{
+			Name:                "Liquidity Pool",
+			Address:             "LA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJUPJN",
+			ExpectedVersionByte: VersionByteLiquidityPool,
+		},
+		{
+			Name:                "Claimable Balance",
+			Address:             "BAAD6DBUX6J22DMZOHIEZTEQ64CVCHEDRKWZONFEUL5Q26QD7R76RGR4TU",
+			ExpectedVersionByte: VersionByteClaimableBalance,
+		},
 	}
 
 	for _, kase := range cases {

xdr/claimable_balance_id.go

@@ -1,5 +1,11 @@
 package xdr
 
+import (
+	"fmt"
+
+	"github.com/stellar/go/strkey"
+)
+
 func (e *EncodingBuffer) claimableBalanceCompressEncodeTo(cb ClaimableBalanceId) error {
 	if err := e.xdrEncoderBuf.WriteByte(byte(cb.Type)); err != nil {
 		return err
@@ -12,3 +18,49 @@ func (e *EncodingBuffer) claimableBalanceCompressEncodeTo(cb ClaimableBalanceId)
 		panic("Unknown type")
 	}
 }
+
+// EncodeToStrkey returns the strkey encoding of the given claimable balance id
+// See SEP-23: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0023.md
+func (c ClaimableBalanceId) EncodeToStrkey() (string, error) {
+
+	switch c.Type {
+	case ClaimableBalanceIdTypeClaimableBalanceIdTypeV0:
+		hash := c.MustV0()
+		payload := make([]byte, 0, len(hash)+1)
+		payload = append(payload, byte(c.Type))
+		payload = append(payload, hash[:]...)
+		return strkey.Encode(strkey.VersionByteClaimableBalance, payload)
+	default:
+		return "", fmt.Errorf("unknown claimable balance id type: %v", c.Type)
+	}
+}
+
+// MustEncodeToStrkey returns the strkey encoding of the given claimable balance id
+// See SEP-23: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0023.md
+func (c ClaimableBalanceId) MustEncodeToStrkey() string {
+	address, err := c.EncodeToStrkey()
+	if err != nil {
+		panic(err)
+	}
+	return address
+}
+
+// DecodeFromStrkey parses a strkey encoded address into the given claimable balance id
+// See SEP-23: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0023.md
+func (c *ClaimableBalanceId) DecodeFromStrkey(address string) error {
+	payload, err := strkey.Decode(strkey.VersionByteClaimableBalance, address)
+	if err != nil {
+		return err
+	}
+	expectedLen := len(Hash{}) + 1
+	if len(payload) != expectedLen {
+		return fmt.Errorf("invalid payload length, expected %v but got %v", expectedLen, len(payload))
+	}
+	if ClaimableBalanceIdType(payload[0]) != ClaimableBalanceIdTypeClaimableBalanceIdTypeV0 {
+		return fmt.Errorf("invalid claimable balance id type: %v", payload[0])
+	}
+	c.Type = ClaimableBalanceIdTypeClaimableBalanceIdTypeV0
+	c.V0 = &Hash{}
+	copy(c.V0[:], payload[1:])
+	return nil
+}

xdr/claimable_balance_id_test.go

@@ -0,0 +1,62 @@
+package xdr
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/stellar/go/gxdr"
+	"github.com/stellar/go/randxdr"
+	"github.com/stellar/go/strkey"
+)
+
+func TestClaimableBalanceIdStrKey(t *testing.T) {
+	gen := randxdr.NewGenerator()
+	// generate 10,000 random claimable balance ids and ensure that the strkey
+	// encoding / decoding round trips successfully
+	for i := 0; i < 10000; i++ {
+		id := &ClaimableBalanceId{}
+		shape := &gxdr.ClaimableBalanceID{}
+		gen.Next(
+			shape,
+			[]randxdr.Preset{},
+		)
+		assert.NoError(t, gxdr.Convert(shape, id))
+
+		encoded, err := id.EncodeToStrkey()
+		assert.NoError(t, err)
+
+		var decoded ClaimableBalanceId
+		assert.NoError(t, decoded.DecodeFromStrkey(encoded))
+
+		serializedBytes, err := id.MarshalBinary()
+		assert.NoError(t, err)
+		serializedDecoded, err := decoded.MarshalBinary()
+		assert.NoError(t, err)
+		assert.Equal(t, serializedBytes, serializedDecoded)
+	}
+}
+
+func TestClaimableBalanceIdDecodeErrors(t *testing.T) {
+	var decoded ClaimableBalanceId
+	payload := []byte{
+		// first byte represents ClaimableBalanceIDType (in this case it's V0)
+		0x00,
+		// the remaining 32 bytes are the contents of the claimable balance hash
+		0x3f, 0x0c, 0x34, 0xbf, 0x93, 0xad, 0x0d, 0x99,
+		0x71, 0xd0, 0x4c, 0xcc, 0x90, 0xf7, 0x05, 0x51,
+		0x1c, 0x83, 0x8a, 0xad, 0x97, 0x34, 0xa4, 0xa2,
+		0xfb, 0x0d, 0x7a, 0x03, 0xfc, 0x7f, 0xe8, 0x9a,
+	}
+	address := "BAAD6DBUX6J22DMZOHIEZTEQ64CVCHEDRKWZONFEUL5Q26QD7R76RGR4TU"
+	assert.Equal(t, address, strkey.MustEncode(strkey.VersionByteClaimableBalance, payload))
+
+	payload[0] = 1
+	invalidIdTypeAddress := strkey.MustEncode(strkey.VersionByteClaimableBalance, payload)
+	assert.EqualError(t, decoded.DecodeFromStrkey(invalidIdTypeAddress), "invalid claimable balance id type: 1")
+
+	payload[0] = 0
+	payload = append(payload, 0)
+	invalidLengthAddress := strkey.MustEncode(strkey.VersionByteClaimableBalance, payload)
+	assert.EqualError(t, decoded.DecodeFromStrkey(invalidLengthAddress), "invalid payload length, expected 33 but got 34")
+}