-
Notifications
You must be signed in to change notification settings - Fork 305
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat!: increase share size to 512 bytes (#850)
Closes #825 This is ready for review but we may not merge it b/c we haven't made a final decision on what the share size should be Co-authored-by: evan-forbes <[email protected]>
- Loading branch information
1 parent
ded7346
commit ecc9423
Showing
14 changed files
with
261 additions
and
122 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| package shares | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/binary" | ||
| "fmt" | ||
|
|
||
| "github.com/celestiaorg/celestia-app/pkg/appconsts" | ||
| ) | ||
|
|
||
| // NewReservedBytes returns a byte slice of length | ||
| // appconsts.CompactShareReservedBytes that contains a varint of the byteIndex | ||
| // of the first unit that starts in a compact share. If no unit starts in the | ||
| // compact share, ReservedBytes is [0, 0]. | ||
| func NewReservedBytes(byteIndex uint64) ([]byte, error) { | ||
| if byteIndex >= appconsts.ShareSize { | ||
| return []byte{}, fmt.Errorf("byte index %d must be less than share size %d", byteIndex, appconsts.ShareSize) | ||
| } | ||
| reservedBytes := make([]byte, appconsts.CompactShareReservedBytes) | ||
| binary.PutUvarint(reservedBytes, byteIndex) | ||
| return reservedBytes, nil | ||
| } | ||
|
|
||
| // ParseReservedBytes parses a byte slice of length | ||
| // appconsts.CompactShareReservedBytes into a byteIndex. | ||
| func ParseReservedBytes(reservedBytes []byte) (uint64, error) { | ||
| if len(reservedBytes) != appconsts.CompactShareReservedBytes { | ||
| return 0, fmt.Errorf("reserved bytes must be of length %d", appconsts.CompactShareReservedBytes) | ||
| } | ||
| reader := bytes.NewReader(reservedBytes) | ||
| byteIndex, err := binary.ReadUvarint(reader) | ||
| if err != nil { | ||
| return 0, err | ||
| } | ||
| if byteIndex >= appconsts.ShareSize { | ||
| return 0, fmt.Errorf("reserved bytes varint %d must be less than share size %d", byteIndex, appconsts.ShareSize) | ||
| } | ||
| return byteIndex, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| package shares | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestParseReservedBytes(t *testing.T) { | ||
| type testCase struct { | ||
| name string | ||
| input []byte | ||
| want uint64 | ||
| expectErr bool | ||
| } | ||
| testCases := []testCase{ | ||
| {"byte index of 0", []byte{0, 0}, 0, false}, | ||
| {"byte index of 2", []byte{2, 0}, 2, false}, | ||
| {"byte index of 4", []byte{4, 0}, 4, false}, | ||
| {"byte index of 8", []byte{8, 0}, 8, false}, | ||
| {"byte index of 16", []byte{16, 0}, 16, false}, | ||
| {"byte index of 32", []byte{32, 0}, 32, false}, | ||
| {"byte index of 64", []byte{64, 0}, 64, false}, | ||
| {"byte index of 128", []byte{128, 1}, 128, false}, | ||
| {"byte index of 256", []byte{128, 2}, 256, false}, | ||
| {"byte index of 511", []byte{255, 3}, 511, false}, | ||
|
|
||
| // error cases | ||
| {"empty", []byte{}, 0, true}, | ||
| {"too few reserved bytes", []byte{1}, 0, true}, | ||
| {"too many reserved bytes", []byte{3, 3, 3}, 0, true}, | ||
| {"byte index of 512 is equal to share size", []byte{128, 4}, 0, true}, | ||
| {"byte index of 1000 is greater than share size", []byte{232, 7}, 0, true}, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| got, err := ParseReservedBytes(tc.input) | ||
| if tc.expectErr { | ||
| assert.Error(t, err) | ||
| return | ||
| } | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, tc.want, got) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestNewReservedBytes(t *testing.T) { | ||
| type testCase struct { | ||
| name string | ||
| input uint64 | ||
| want []byte | ||
| expectErr bool | ||
| } | ||
| testCases := []testCase{ | ||
| {"byte index of 0", 0, []byte{0, 0}, false}, | ||
| {"byte index of 2", 2, []byte{2, 0}, false}, | ||
| {"byte index of 4", 4, []byte{4, 0}, false}, | ||
| {"byte index of 8", 8, []byte{8, 0}, false}, | ||
| {"byte index of 16", 16, []byte{16, 0}, false}, | ||
| {"byte index of 32", 32, []byte{32, 0}, false}, | ||
| {"byte index of 64", 64, []byte{64, 0}, false}, | ||
| {"byte index of 128", 128, []byte{128, 1}, false}, | ||
| {"byte index of 256", 256, []byte{128, 2}, false}, | ||
| {"byte index of 511", 511, []byte{255, 3}, false}, | ||
|
|
||
| // error cases | ||
| {"byte index of 512 is equal to share size", 512, []byte{}, true}, | ||
| {"byte index of 1000 is greater than share size", 1000, []byte{}, true}, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| got, err := NewReservedBytes(tc.input) | ||
| if tc.expectErr { | ||
| assert.Error(t, err) | ||
| return | ||
| } | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, tc.want, got) | ||
| }) | ||
| } | ||
| } |
Oops, something went wrong.