cerc-io/lotus
16
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 27 Wiki Activity

refactor: switch to base64 encoding for binary data (#233)

Browse Source
This commit is contained in:
Alan Shaw 2020-08-14 18:05:29 +01:00 committed by GitHub
parent 99f466e35e
commit 9ba87d4613
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
tvx/schema/schema.go
View File

@ -1,7 +1,7 @@
package schema package schema
import ( import (
"encoding/hex" "encoding/base64"
"encoding/json" "encoding/json"
"fmt" "fmt"
@ -47,10 +47,8 @@ type StateTree struct {
RootCID cid.Cid `json:"root_cid"` RootCID cid.Cid `json:"root_cid"`
} }
// HexEncodedBytes is a hex-encoded binary value. // Base64EncodedBytes is a base64-encoded binary value.
// type Base64EncodedBytes []byte
// TODO may switch to base64 or base85 for efficiency.
type HexEncodedBytes []byte
// Preconditions contain a representation of VM state at the beginning of the test // Preconditions contain a representation of VM state at the beginning of the test
type Preconditions struct { type Preconditions struct {
@ -60,9 +58,9 @@ type Preconditions struct {
// Receipt represents a receipt to match against. // Receipt represents a receipt to match against.
type Receipt struct { type Receipt struct {
ExitCode exitcode.ExitCode `json:"exit_code"` ExitCode exitcode.ExitCode `json:"exit_code"`
ReturnValue HexEncodedBytes `json:"return"` ReturnValue Base64EncodedBytes `json:"return"`
GasUsed int64 `json:"gas_used"` GasUsed int64 `json:"gas_used"`
} }
// Postconditions contain a representation of VM state at th end of the test // Postconditions contain a representation of VM state at th end of the test
@ -71,23 +69,23 @@ type Postconditions struct {
Receipts []*Receipt `json:"receipts"` Receipts []*Receipt `json:"receipts"`
} }
// MarshalJSON implements json.Marshal for HexEncodedBytes // MarshalJSON implements json.Marshal for Base64EncodedBytes
func (heb HexEncodedBytes) MarshalJSON() ([]byte, error) { func (beb Base64EncodedBytes) MarshalJSON() ([]byte, error) {
return json.Marshal(hex.EncodeToString(heb)) return json.Marshal(base64.StdEncoding.EncodeToString(beb))
} }
// UnmarshalJSON implements json.Unmarshal for HexEncodedBytes // UnmarshalJSON implements json.Unmarshal for Base64EncodedBytes
func (heb *HexEncodedBytes) UnmarshalJSON(v []byte) error { func (beb *Base64EncodedBytes) UnmarshalJSON(v []byte) error {
var s string var s string
if err := json.Unmarshal(v, &s); err != nil { if err := json.Unmarshal(v, &s); err != nil {
return err return err
} }
bytes, err := hex.DecodeString(s) bytes, err := base64.StdEncoding.DecodeString(s)
if err != nil { if err != nil {
return err return err
} }
*heb = bytes *beb = bytes
return nil return nil
} }
@ -100,7 +98,7 @@ type TestVector struct {
// CAR binary data to be loaded into the test environment, usually a CAR // CAR binary data to be loaded into the test environment, usually a CAR
// containing multiple state trees, addressed by root CID from the relevant // containing multiple state trees, addressed by root CID from the relevant
// objects. // objects.
CAR HexEncodedBytes `json:"car_hex"` CAR Base64EncodedBytes `json:"car"`
Pre *Preconditions `json:"preconditions"` Pre *Preconditions `json:"preconditions"`
ApplyMessages []Message `json:"apply_messages"` ApplyMessages []Message `json:"apply_messages"`
@ -108,8 +106,8 @@ type TestVector struct {
} }
type Message struct { type Message struct {
Bytes HexEncodedBytes `json:"bytes"` Bytes Base64EncodedBytes `json:"bytes"`
Epoch *abi.ChainEpoch `json:"epoch,omitempty"` Epoch *abi.ChainEpoch `json:"epoch,omitempty"`
} }
// Validate validates this test vector against the JSON schema, and applies // Validate validates this test vector against the JSON schema, and applies