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

types: Replace expression-based SpendPolicy JSON marshalling #182

Merged
merged 1 commit into from
Jul 16, 2024
+109 −35
Merged

types: Replace expression-based SpendPolicy JSON marshalling #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
84 changes: 68 additions & 16 deletions types/policy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package types

import (
"bytes"
"crypto/sha256"
"encoding/hex"
"encoding/json"
Expand Down Expand Up @@ -56,8 +55,8 @@ func PolicyHash(h Hash256) SpendPolicy {

// PolicyTypeThreshold requires at least N sub-policies to be satisfied.
type PolicyTypeThreshold struct {
N uint8
Of []SpendPolicy
N uint8 `json:"n"`
Of []SpendPolicy `json:"of"`
}

// PolicyThreshold returns a policy that requires at least N sub-policies to be
Expand Down Expand Up @@ -416,25 +415,78 @@ func ParseSpendPolicy(s string) (SpendPolicy, error) {
return p, err
}

// MarshalText implements encoding.TextMarshaler.
func (p SpendPolicy) MarshalText() ([]byte, error) {
return []byte(p.String()), nil
}

// UnmarshalText implements encoding.TextUnmarshaler.
func (p *SpendPolicy) UnmarshalText(b []byte) (err error) {
*p, err = ParseSpendPolicy(string(b))
return
}

// MarshalJSON implements json.Marshaler.
func (p SpendPolicy) MarshalJSON() ([]byte, error) {
return []byte(`"` + p.String() + `"`), nil
var v struct {
Type string `json:"type"`
Policy interface{} `json:"policy"`
}
switch p := p.Type.(type) {
case PolicyTypeAbove:
v.Type = "above"
v.Policy = uint64(p)
case PolicyTypeAfter:
v.Type = "after"
v.Policy = time.Time(p).Unix()
case PolicyTypePublicKey:
v.Type = "pk"
v.Policy = PublicKey(p)
case PolicyTypeHash:
v.Type = "h"
v.Policy = Hash256(p)
case PolicyTypeThreshold:
v.Type = "thresh"
v.Policy = p
case PolicyTypeOpaque:
v.Type = "opaque"
v.Policy = Address(p)
case PolicyTypeUnlockConditions:
v.Type = "uc"
v.Policy = UnlockConditions(p)
}
return json.Marshal(v)
}

// UnmarshalJSON implements json.Unmarshaler.
func (p *SpendPolicy) UnmarshalJSON(b []byte) (err error) {
return p.UnmarshalText(bytes.Trim(b, `"`))
var v struct {
Type string `json:"type"`
Policy json.RawMessage `json:"policy"`
}
if err = json.Unmarshal(b, &v); err != nil {
return
}
switch v.Type {
case "above":
var pt PolicyTypeAbove
err = json.Unmarshal(v.Policy, (*uint64)(&pt))
p.Type = pt
case "after":
var pt int64
err = json.Unmarshal(v.Policy, &pt)
p.Type = PolicyTypeAfter(time.Unix(pt, 0))
case "pk":
var pt PolicyTypePublicKey
err = json.Unmarshal(v.Policy, (*PublicKey)(&pt))
p.Type = pt
case "h":
var pt PolicyTypeHash
err = json.Unmarshal(v.Policy, (*Hash256)(&pt))
p.Type = pt
case "thresh":
var pt PolicyTypeThreshold
err = json.Unmarshal(v.Policy, &pt)
p.Type = pt
case "opaque":
var pt PolicyTypeOpaque
err = json.Unmarshal(v.Policy, (*Address)(&pt))
p.Type = pt
case "uc":
var pt PolicyTypeUnlockConditions
err = json.Unmarshal(v.Policy, (*UnlockConditions)(&pt))
p.Type = pt
}
return
}

// A SatisfiedPolicy pairs a policy with the signatures and preimages that
Expand Down
60 changes: 41 additions & 19 deletions types/policy_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,14 @@ func roundtrip(from EncoderTo, to DecoderFrom) {
}
}

func jsonRoundtrip(from json.Marshaler, to json.Unmarshaler) {
if js, err := from.MarshalJSON(); err != nil {
panic(err)
} else if err := to.UnmarshalJSON(js); err != nil {
panic(err)
}
}

func TestPolicyVerify(t *testing.T) {
key := GeneratePrivateKey()
pk := key.PublicKey()
Expand Down Expand Up @@ -328,6 +336,7 @@ func TestPolicyRoundtrip(t *testing.T) {
} {
var p2 SpendPolicy
roundtrip(p, &p2)
jsonRoundtrip(p, &p2)
if p.Address() != p2.Address() {
t.Fatal("policy did not survive roundtrip")
}
Expand Down Expand Up @@ -358,6 +367,7 @@ func TestPolicyRoundtrip(t *testing.T) {
}
var sp2 SatisfiedPolicy
roundtrip(sp, &sp2)
jsonRoundtrip(sp, &sp2)
if fmt.Sprint(sp) != fmt.Sprint(sp2) {
t.Fatal("satisfied policy did not survive roundtrip:", sp, sp2)
}
Expand All @@ -373,30 +383,47 @@ func TestSpendPolicyMarshalJSON(t *testing.T) {
}{
{
sp: PolicyAbove(100),
exp: `"above(100)"`,
exp: `{"type":"above","policy":100}`,
},
{
sp: PolicyAfter(time.Unix(1234567890, 0)),
exp: `"after(1234567890)"`,
exp: `{"type":"after","policy":1234567890}`,
},
{
sp: PolicyPublicKey(publicKey),
exp: fmt.Sprintf(`"pk(0x%x)"`, publicKey[:]),
exp: fmt.Sprintf(`{"type":"pk","policy":"ed25519:%x"}`, publicKey[:]),
},
{
sp: PolicyHash(hash),
exp: fmt.Sprintf(`"h(0x%x)"`, hash[:]),
exp: fmt.Sprintf(`{"type":"h","policy":"h:%x"}`, hash[:]),
},
{
sp: PolicyThreshold(2, []SpendPolicy{
PolicyAbove(100),
PolicyPublicKey(publicKey),
PolicyThreshold(2, []SpendPolicy{
PolicyAbove(200),
PolicyPublicKey(publicKey),
}),
}),
exp: fmt.Sprintf(`{"type":"thresh","policy":{"n":2,"of":[{"type":"above","policy":100},{"type":"pk","policy":"ed25519:%x"},{"type":"thresh","policy":{"n":2,"of":[{"type":"above","policy":200},{"type":"pk","policy":"ed25519:%x"}]}}]}}`, publicKey[:], publicKey[:]),
},
{
sp: SpendPolicy{PolicyTypeUnlockConditions{
Timelock: 123,
PublicKeys: []UnlockKey{publicKey.UnlockKey()},
SignaturesRequired: 2,
}},
exp: fmt.Sprintf(`{"type":"uc","policy":{"timelock":123,"publicKeys":["ed25519:%x"],"signaturesRequired":2}}`, publicKey[:]),
},
}

for _, tt := range tests {
data, err := json.Marshal(tt.sp)
if err != nil {
t.Fatalf("Expected no error, but got %v", err)
}

if string(data) != tt.exp {
t.Fatalf("Expected %s, but got %s", tt.exp, string(data))
t.Errorf("Expected no error, but got %v", err)
} else if string(data) != tt.exp {
t.Errorf("Expected %s, but got %s", tt.exp, string(data))
}
}
}
Expand All @@ -415,39 +442,34 @@ func TestSatisfiedPolicyMarshalJSON(t *testing.T) {
preimages [][]byte
exp string
}{
{
name: "EmptyPolicy",
sp: SpendPolicy{},
exp: `{"policy":""}`,
},
{
name: "PolicyWithSignature",
sp: PolicyPublicKey(publicKey),
signatures: []Signature{signature},
exp: fmt.Sprintf(`{"policy":"pk(0x%x)","signatures":[%q]}`, publicKey[:], signature),
exp: fmt.Sprintf(`{"policy":{"type":"pk","policy":"ed25519:%x"},"signatures":[%q]}`, publicKey[:], signature),
},
{
name: "PolicyWithSignaturesAndPreimages",
sp: PolicyThreshold(1, []SpendPolicy{PolicyPublicKey(publicKey), PolicyHash(hash)}),
signatures: []Signature{signature},
preimages: [][]byte{{1, 2, 3}},
exp: fmt.Sprintf(`{"policy":"thresh(1,[pk(0x%x),h(0x%x)])","signatures":[%q],"preimages":["010203"]}`, publicKey[:], hash[:], signature),
exp: fmt.Sprintf(`{"policy":{"type":"thresh","policy":{"n":1,"of":[{"type":"pk","policy":"ed25519:%x"},{"type":"h","policy":"h:%x"}]}},"signatures":[%q],"preimages":["010203"]}`, publicKey[:], hash[:], signature),
},
{
name: "PolicyWithPreimagesOnly",
sp: PolicyHash(hash),
preimages: [][]byte{{4, 5, 6}},
exp: fmt.Sprintf(`{"policy":"h(0x%x)","preimages":["040506"]}`, hash[:]),
exp: fmt.Sprintf(`{"policy":{"type":"h","policy":"h:%x"},"preimages":["040506"]}`, hash[:]),
},
{
name: "PolicyWithEmptySignatures",
sp: PolicyPublicKey(publicKey),
exp: fmt.Sprintf(`{"policy":"pk(0x%x)"}`, publicKey[:]),
exp: fmt.Sprintf(`{"policy":{"type":"pk","policy":"ed25519:%x"}}`, publicKey[:]),
},
{
name: "PolicyWithEmptyPreimages",
sp: PolicyHash(hash),
exp: fmt.Sprintf(`{"policy":"h(0x%x)"}`, hash[:]),
exp: fmt.Sprintf(`{"policy":{"type":"h","policy":"h:%x"}}`, hash[:]),
},
}

Expand Down
Loading