-
Notifications
You must be signed in to change notification settings - Fork 324
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[staking] patch for staking protocol
- Loading branch information
Showing
6 changed files
with
286 additions
and
2 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| // Copyright (c) 2020 IoTeX Foundation | ||
| // This is an alpha (internal) release and is not suitable for production. This source code is provided 'as is' and no | ||
| // warranties are given as to title or non-infringement, merchantability or fitness for purpose and, to the extent | ||
| // permitted by law, all liability for your use of the code is disclaimed. This source code is governed by Apache | ||
| // License 2.0 that can be found in the LICENSE file. | ||
|
|
||
| package staking | ||
|
|
||
| import ( | ||
| "encoding/csv" | ||
| "encoding/hex" | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| const ( | ||
| _name = "name" | ||
| _operator = "operator" | ||
| ) | ||
|
|
||
| // PatchStore is the patch store of staking protocol | ||
| type PatchStore struct { | ||
| dir string | ||
| } | ||
|
|
||
| // NewPatchStore creates a new staking patch store | ||
| func NewPatchStore(dir string) *PatchStore { | ||
| return &PatchStore{dir: dir} | ||
| } | ||
|
|
||
| func (store *PatchStore) pathOf(height uint64) string { | ||
| return filepath.Join(store.dir, fmt.Sprintf("%d.patch", height)) | ||
| } | ||
|
|
||
| func (store *PatchStore) read(reader *csv.Reader) (CandidateList, error) { | ||
| record, err := reader.Read() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if len(record) != 1 { | ||
| return nil, errors.Errorf("invalid record %+v", record) | ||
| } | ||
| data, err := hex.DecodeString(record[0]) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| var list CandidateList | ||
| if err := list.Deserialize(data); err != nil { | ||
| return nil, err | ||
| } | ||
| return list, nil | ||
| } | ||
|
|
||
| // Read reads CandidateList by name and CandidateList by operator of given height | ||
| func (store *PatchStore) Read(height uint64) (CandidateList, CandidateList, CandidateList, error) { | ||
| file, err := os.Open(store.pathOf(height)) | ||
| if err != nil { | ||
| return nil, nil, nil, err | ||
| } | ||
| reader := csv.NewReader(file) | ||
| reader.FieldsPerRecord = -1 | ||
| listByName, err := store.read(reader) | ||
| if err != nil { | ||
| return nil, nil, nil, err | ||
| } | ||
| listByOperator, err := store.read(reader) | ||
| if err != nil { | ||
| return nil, nil, nil, err | ||
| } | ||
| listByOwner, err := store.read(reader) | ||
| if err != nil { | ||
| return nil, nil, nil, err | ||
| } | ||
| return listByName, listByOperator, listByOwner, nil | ||
| } | ||
|
|
||
| // Write writes CandidateList by name and CandidateList by operator into store | ||
| func (store *PatchStore) Write( | ||
| height uint64, | ||
| listByName, listByOperator, listByOwner CandidateList, | ||
| ) (err error) { | ||
| if len(listByName) == 0 || len(listByOperator) == 0 || len(listByOwner) == 0 { | ||
| return errors.Wrap(ErrNilParameters, "empty candidate list") | ||
| } | ||
| bytesByName, err := listByName.Serialize() | ||
| if err != nil { | ||
| return errors.Wrap(err, "failed to serialize candidate list by name") | ||
| } | ||
| bytesByOperator, err := listByOperator.Serialize() | ||
| if err != nil { | ||
| return errors.Wrap(err, "failed to serialize candidate list by operator") | ||
| } | ||
| bytesByOwner, err := listByOwner.Serialize() | ||
| if err != nil { | ||
| return errors.Wrap(err, "failed to serialize candidate list by owner") | ||
| } | ||
| records := [][]string{ | ||
| {hex.EncodeToString(bytesByName)}, | ||
| {hex.EncodeToString(bytesByOperator)}, | ||
| {hex.EncodeToString(bytesByOwner)}, | ||
| } | ||
| file, err := os.Create(store.pathOf(height)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer func() { | ||
| fileCloseErr := file.Close() | ||
| if fileCloseErr != nil && err == nil { | ||
| err = fileCloseErr | ||
| } | ||
| }() | ||
|
|
||
| return csv.NewWriter(file).WriteAll(records) | ||
| } |
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,128 @@ | ||
| // Copyright (c) 2019 IoTeX Foundation | ||
| // This is an alpha (internal) release and is not suitable for production. This source code is provided 'as is' and no | ||
| // warranties are given as to title or non-infringement, merchantability or fitness for purpose and, to the extent | ||
| // permitted by law, all liability for your use of the code is disclaimed. This source code is governed by Apache | ||
| // License 2.0 that can be found in the LICENSE file. | ||
|
|
||
| package staking | ||
|
|
||
| import ( | ||
| "math/big" | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/iotexproject/iotex-core/pkg/unit" | ||
| "github.com/iotexproject/iotex-core/test/identityset" | ||
| ) | ||
|
|
||
| func TestInvalidDirectory(t *testing.T) { | ||
| require := require.New(t) | ||
| dir := filepath.Join(t.TempDir(), "invalid") | ||
| _, err := os.Create(dir) | ||
| require.NoError(err) | ||
| _, _, _, err = NewPatchStore(dir).Read(0) | ||
| require.ErrorContains(err, "not a directory") | ||
| } | ||
|
|
||
| func TestInvalidDirectory2(t *testing.T) { | ||
| require := require.New(t) | ||
| dir := t.TempDir() | ||
| require.NoError(os.Remove(dir)) | ||
| _, err := os.Stat(dir) | ||
| require.ErrorIs(err, os.ErrNotExist) | ||
| _, _, _, err = NewPatchStore(dir).Read(0) | ||
| require.ErrorContains(err, "no such file or directory") | ||
| } | ||
|
|
||
| func TestCorruptedData(t *testing.T) { | ||
| // TODO: add test for corrupted data | ||
| } | ||
|
|
||
| func TestWriteAndRead(t *testing.T) { | ||
| require := require.New(t) | ||
| dir := t.TempDir() | ||
| patch := NewPatchStore(dir) | ||
| listByName := CandidateList{ | ||
| &Candidate{ | ||
| Owner: identityset.Address(1), | ||
| Operator: identityset.Address(7), | ||
| Reward: identityset.Address(1), | ||
| Name: "name0", | ||
| Votes: big.NewInt(1), | ||
| SelfStakeBucketIdx: 2, | ||
| SelfStake: unit.ConvertIotxToRau(1200000), | ||
| }, | ||
| &Candidate{ | ||
| Owner: identityset.Address(3), | ||
| Operator: identityset.Address(5), | ||
| Reward: identityset.Address(9), | ||
| Name: "name1", | ||
| Votes: big.NewInt(2), | ||
| SelfStakeBucketIdx: 3, | ||
| SelfStake: unit.ConvertIotxToRau(200000), | ||
| }, | ||
| } | ||
| listByOperator := CandidateList{ | ||
| &Candidate{ | ||
| Owner: identityset.Address(8), | ||
| Operator: identityset.Address(6), | ||
| Reward: identityset.Address(2), | ||
| Name: "operator", | ||
| Votes: big.NewInt(3), | ||
| SelfStakeBucketIdx: 5, | ||
| SelfStake: unit.ConvertIotxToRau(1200000), | ||
| }, | ||
| &Candidate{ | ||
| Owner: identityset.Address(3), | ||
| Operator: identityset.Address(4), | ||
| Reward: identityset.Address(5), | ||
| Name: "operator1", | ||
| Votes: big.NewInt(4), | ||
| SelfStakeBucketIdx: 6, | ||
| SelfStake: unit.ConvertIotxToRau(1800000), | ||
| }, | ||
| } | ||
| listByOwner := CandidateList{ | ||
| &Candidate{ | ||
| Owner: identityset.Address(2), | ||
| Operator: identityset.Address(8), | ||
| Reward: identityset.Address(6), | ||
| Name: "owner", | ||
| Votes: big.NewInt(6), | ||
| SelfStakeBucketIdx: 9, | ||
| SelfStake: unit.ConvertIotxToRau(1100000), | ||
| }, | ||
| &Candidate{ | ||
| Owner: identityset.Address(3), | ||
| Operator: identityset.Address(9), | ||
| Reward: identityset.Address(7), | ||
| Name: "owner1", | ||
| Votes: big.NewInt(7), | ||
| SelfStakeBucketIdx: 10, | ||
| SelfStake: unit.ConvertIotxToRau(2400000), | ||
| }, | ||
| &Candidate{ | ||
| Owner: identityset.Address(7), | ||
| Operator: identityset.Address(3), | ||
| Reward: identityset.Address(1), | ||
| Name: "owner2", | ||
| Votes: big.NewInt(8), | ||
| SelfStakeBucketIdx: 5, | ||
| SelfStake: unit.ConvertIotxToRau(1200000), | ||
| }, | ||
| } | ||
| require.ErrorIs(patch.Write(2, nil, nil, nil), ErrNilParameters) | ||
| require.ErrorIs(patch.Write(2, nil, listByOperator, nil), ErrNilParameters) | ||
| require.ErrorIs(patch.Write(2, nil, nil, listByOwner), ErrNilParameters) | ||
| require.NoError(patch.Write(2, listByName, listByOperator, listByOwner)) | ||
| listByNameCopy, listByOperatorCopy, listByOwnerCopy, err := patch.Read(1) | ||
| require.ErrorIs(err, os.ErrNotExist) | ||
| listByNameCopy, listByOperatorCopy, listByOwnerCopy, err = patch.Read(2) | ||
| require.NoError(err) | ||
| require.Equal(listByName, listByNameCopy) | ||
| require.Equal(listByOperator, listByOperatorCopy) | ||
| require.Equal(listByOwner, listByOwnerCopy) | ||
| } |
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