github.com/mavryk-network/mvgo@v1.19.9/micheline/key_test.go

// Copyright (c) 2021 Blockwatch Data Inc.
// Author: alex@blockwatch.cc
//

package micheline

import (
	"bytes"
	"encoding/hex"
	"encoding/json"
	"testing"

	"github.com/mavryk-network/mvgo/mavryk"
)

type keyTest struct {
	Name   string
	Type   string
	Hash   mavryk.ExprHash
	Hex    string
	Value  json.RawMessage
	String string
	Prim   Prim
}

var keyInfo = []keyTest{
	// scalars
	//   int
	{
		Name:   "int",
		Type:   "int",
		Hash:   mavryk.MustParseExprHash("exprv6n4YrvfCD2N6JmSF9aZxtcrcDCDV5YAFpaJDhJU6bhmNHz3YK"),
		Hex:    "00a005",
		Value:  []byte(`"352"`),
		String: "352",
		Prim:   NewInt64(352),
	},
	//   nat
	{
		Name:   "nat",
		Type:   "nat",
		Hash:   mavryk.MustParseExprHash("expruE5MGe6oKRLTiog6iBZzpztj5kCGzMEYBfWzsVebPnhn43ndYa"),
		Hex:    "008eb818",
		Value:  []byte(`"200206"`),
		String: "200206",
		Prim:   NewInt64(200206),
	},
	//   mumav
	{
		Name:   "mumav",
		Type:   "mumav",
		Hash:   mavryk.MustParseExprHash("expruE5MGe6oKRLTiog6iBZzpztj5kCGzMEYBfWzsVebPnhn43ndYa"),
		Hex:    "008eb818",
		Value:  []byte(`"200206"`),
		String: "200206",
		Prim:   NewInt64(200206),
	},
	//   unit
	{
		Name:   "unit",
		Type:   "unit",
		Hash:   mavryk.MustParseExprHash("expruaDPoTWXcTR6fiQPy4KZSW72U6Swc1rVmMiP1KdwmCceeEpVjd"),
		Hex:    "030b",
		Value:  []byte(`null`),
		String: "Unit",
		Prim:   NewCode(D_UNIT),
	},
	//   string
	{
		Name:   "string",
		Type:   "string",
		Hash:   mavryk.MustParseExprHash("exprtiRSZkLKYRess9GZ3ryb4cVQD36WLo2oysZBFxKTZ2jXqcHWGj"),
		Hex:    "010000000947616d65206f6e6521",
		Value:  []byte(`"Game one!"`),
		String: "Game one!",
		Prim:   NewString("Game one!"),
	},
	//   bytes
	{
		Name:   "bytes",
		Type:   "bytes",
		Hash:   mavryk.MustParseExprHash("expruLUtQBGu3aw4onM4nA9A8UM7PrDh3pbcrqnrFpzAAuTd12Ggdv"),
		Hex:    "0a000000209e2dce28b861646c13c2b9cf4245e483a837525f2d1547a410293e29c3734d6e",
		Value:  []byte(`"9e2dce28b861646c13c2b9cf4245e483a837525f2d1547a410293e29c3734d6e"`),
		String: "9e2dce28b861646c13c2b9cf4245e483a837525f2d1547a410293e29c3734d6e",
		Prim:   NewBytes([]byte{0x9e, 0x2d, 0xce, 0x28, 0xb8, 0x61, 0x64, 0x6c, 0x13, 0xc2, 0xb9, 0xcf, 0x42, 0x45, 0xe4, 0x83, 0xa8, 0x37, 0x52, 0x5f, 0x2d, 0x15, 0x47, 0xa4, 0x10, 0x29, 0x3e, 0x29, 0xc3, 0x73, 0x4d, 0x6e}),
	},
	//   key_hash
	{
		Name:   "mv1 key_hash",
		Type:   "key_hash",
		Hash:   mavryk.MustParseExprHash("exprtqoHg7oQtzkxaJGFMnGCZGTS1sYmzWGBiBq8678wgzzAAapd21"),
		Hex:    "0a000000150026f32c59c5240691c60ce20ec52cc2afaa47cf62",
		Value:  []byte(`"mv1BZSyyRgGX7QogeDCanY1Mr3VD9UwBJGFM"`),
		String: "mv1BZSyyRgGX7QogeDCanY1Mr3VD9UwBJGFM",
		Prim:   NewBytes(mavryk.MustParseAddress("mv1BZSyyRgGX7QogeDCanY1Mr3VD9UwBJGFM").Encode()),
	},
	//   address
	{
		Name:   "mv1 address",
		Type:   "address",
		Hash:   mavryk.MustParseExprHash("expruUXWZpQ8CbM2KQR3zZLcvfbs75J247Bac2yrQHNaTrcboWdptW"),
		Hex:    "0a000000160000449cf979e666c4706a26c8176f930e35d5b42493",
		Value:  []byte(`"mv1EGHzY37ttLfXHRxxZJNQ9aVWQJe95voSo"`),
		String: "mv1EGHzY37ttLfXHRxxZJNQ9aVWQJe95voSo",
		Prim:   NewBytes(mavryk.MustParseAddress("mv1EGHzY37ttLfXHRxxZJNQ9aVWQJe95voSo").EncodePadded()),
	},
	{
		Name:   "KT1 address",
		Type:   "address",
		Hash:   mavryk.MustParseExprHash("exprvAHu1SyoiSzyh9w7GPfifvyrNiMb442y7Q2MA8tcPCGPajxRH6"),
		Hex:    "0a0000001601a3d0f58d8964bd1b37fb0a0c197b38cf46608d4900",
		Value:  []byte(`"KT1PWx2mnDueood7fEmfbBDKx1D9BAnnXitn"`),
		String: "KT1PWx2mnDueood7fEmfbBDKx1D9BAnnXitn",
		Prim:   NewBytes(mavryk.MustParseAddress("KT1PWx2mnDueood7fEmfbBDKx1D9BAnnXitn").EncodePadded()),
	},

	//   timestamp as string
	//   timestamp as unix seconds
	//   timestamp with out-of-range year
	//   key
	{
		Name:   "key",
		Type:   "key",
		Hash:   mavryk.MustParseExprHash("exprv1Vjr2jWEzSALFrHaoubi3jELpXvnMtGNG4ZJPDMRHxrQtyBDW"),
		Hex:    "0a000000210078149c2d111816aaef9e329970c344fc32375dd5eff99eeeed3b37a9d51beacd",
		Value:  []byte(`"edpkuZ7ERiU5B8knLqQsVMH86j9RLMUyHyL665oCXDkPQxF7HGqSeJ"`),
		String: "edpkuZ7ERiU5B8knLqQsVMH86j9RLMUyHyL665oCXDkPQxF7HGqSeJ",
		Prim:   NewBytes(mavryk.MustParseKey("edpkuZ7ERiU5B8knLqQsVMH86j9RLMUyHyL665oCXDkPQxF7HGqSeJ").Bytes()),
	},
	//   signature
	//   bool

	// composites
	//   pair
	{
		Name:   "Pair(address,nat)",
		Type:   "pair",
		Hash:   mavryk.MustParseExprHash("exprvD1v8DxXvrsCqbx7BA2ZqxYuUk9jXE1QrXuL46i3MWG6o1szUq"),
		Hex:    "07070a0000001600005db799bf9b0dc319ba1cf21ab01461a9639043ca009902",
		Value:  []byte(`{"0":"mv1GZ2nLrBcdGpecDeTqTCXMVdZuoTUecDks","1":"153"}`),
		String: "mv1GZ2nLrBcdGpecDeTqTCXMVdZuoTUecDks,153",
		Prim: NewPair(
			NewBytes(mavryk.MustParseAddress("mv1GZ2nLrBcdGpecDeTqTCXMVdZuoTUecDks").EncodePadded()),
			NewInt64(153),
		),
	},
	{
		Name:   "Pair(address,string)",
		Type:   "pair",
		Hash:   mavryk.MustParseExprHash("expruCp21FBR8PnYGy2QQnAA684LTQJhUVvM1GCVP8CyY3WeLJSzWh"),
		Hex:    "07070a0000001600002ca7bca83fa8cfbb594c013d611d08eae48a9f3b01000000094449435245524a3238",
		Value:  []byte(`{"0":"mv1C5cfidAuDUVZgZjjuGgAskjxPftLrShLx","1":"DICRERJ28"}`),
		String: "mv1C5cfidAuDUVZgZjjuGgAskjxPftLrShLx,DICRERJ28",
		Prim: NewPair(
			NewBytes(mavryk.MustParseAddress("mv1C5cfidAuDUVZgZjjuGgAskjxPftLrShLx").EncodePadded()),
			NewString("DICRERJ28"),
		),
	},
	{
		Name:   "Pair(address,address,nat)",
		Type:   "pair",
		Hash:   mavryk.MustParseExprHash("expruV4TWZLF1QLgBT2sLehF5LLUTgrQZRjrJcBFiTcyHACyCfejLc"),
		Hex:    "07070a0000001600009b671169734f0ba7c9853d03b5512cfbe404fe0f07070a0000001601c953466e6cf9295ecad052acc742247dd0e3c91900008f01",
		Value:  []byte(`{"0":"mv1NBCCjdZe99TYysW3JCcEJzKrcVwf29bdX","1":"KT1SwH9P1Tx8a58Mm6qBExQFTcy2rwZyZiXS","2":"79"}`),
		String: "mv1NBCCjdZe99TYysW3JCcEJzKrcVwf29bdX,KT1SwH9P1Tx8a58Mm6qBExQFTcy2rwZyZiXS,79",
		Prim: NewPair(
			NewBytes(mavryk.MustParseAddress("mv1NBCCjdZe99TYysW3JCcEJzKrcVwf29bdX").EncodePadded()),
			NewPair(
				NewBytes(mavryk.MustParseAddress("KT1SwH9P1Tx8a58Mm6qBExQFTcy2rwZyZiXS").EncodePadded()),
				NewInt64(79),
			),
		),
	},
	//   option
	//   or / union

	// specials
	//   packed key

}

func TestKeyParser(t *testing.T) {
	for _, test := range keyInfo {
		t.Run(test.Name, func(T *testing.T) {
			typ, err := ParseKeyType(test.Type)
			if err != nil {
				T.Errorf("key type error: %v", err)
				T.FailNow()
			}
			key, err := ParseKey(typ, test.String)
			if err != nil {
				T.Errorf("key parse error: %v", err)
				T.FailNow()
			}

			// encode and check against bytes
			buf := key.Bytes()
			hx, _ := hex.DecodeString(test.Hex)
			if !bytes.Equal(buf, hx) {
				T.Errorf("binary encoding mismatch:\n    want: %x\n    got:  %x", hx, buf)
			}

			// check against prim
			prim := key.Prim()
			if !prim.IsEqual(test.Prim) {
				T.Errorf("prim mismatch:\n    want: %s\n    got:  %s", test.Prim.Dump(), prim.Dump())
			}

			// generate hash and compare
			hs := key.Hash()
			if !hs.Equal(test.Hash) {
				T.Errorf("hash mismatch:\n    want: %s\n    got:  %s", test.Hash, hs)
			}
		})
	}
}

func TestKeyRendering(t *testing.T) {
	for _, test := range keyInfo {
		t.Run(test.Name, func(T *testing.T) {
			typ, err := ParseKeyType(test.Type)
			if err != nil {
				T.Errorf("key type error: %v", err)
				T.FailNow()
			}
			key, err := NewKey(NewType(NewPrim(typ)), test.Prim)
			if err != nil {
				T.Errorf("new key error: %v", err)
				T.FailNow()
			}

			// marshal string
			if want, have := test.String, key.String(); want != have {
				T.Errorf("string mismatch:\n    want: %s\n    got:  %s", want, have)
			}

			// encode and check against bytes
			buf := key.Bytes()
			hx, _ := hex.DecodeString(test.Hex)
			if !bytes.Equal(buf, hx) {
				T.Errorf("binary encoding mismatch:\n    want: %x\n    got:  %x", hx, buf)
			}

			// marshal JSON
			have, err := key.MarshalJSON()
			if err != nil {
				T.Errorf("marshal error: %v", err)
			}
			if !jsonDiff(T, have, []byte(test.Value)) {
				T.Error("render mismatch, see log for details")
				t.FailNow()
			}

			// generate hash and compare
			hs := key.Hash()
			if !hs.Equal(test.Hash) {
				T.Errorf("hash mismatch:\n    want: %s\n    got:  %s", test.Hash, hs)
			}
		})
	}
}