*: move all implementation-specific packages under internal directory

Noone needs them, they are used only for tests and as examples. Signed-off-by: Anna Shaleva <[email protected]>
nspcc-dev · Mar 1, 2024 · 4c215e7 · 4c215e7
1 parent f4029fc
commit 4c215e7
Show file tree

Hide file tree

Showing 26 changed files with 104 additions and 95 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -42,5 +42,5 @@ jobs:
 
       - name: Run simulation
         run: |
-          cd ./simulation
+          cd ./internal/simulation
           go run main.go
diff --git a/dbft_test.go b/dbft_test.go
@@ -7,9 +7,9 @@ import (
 	"time"
 
 	"github.com/nspcc-dev/dbft"
-	"github.com/nspcc-dev/dbft/block"
-	"github.com/nspcc-dev/dbft/crypto"
-	"github.com/nspcc-dev/dbft/payload"
+	"github.com/nspcc-dev/dbft/internal/block"
+	"github.com/nspcc-dev/dbft/internal/crypto"
+	"github.com/nspcc-dev/dbft/internal/payload"
 	"github.com/nspcc-dev/dbft/timer"
 	"github.com/stretchr/testify/require"
 	"go.uber.org/zap"

diff --git a/helpers_test.go b/helpers_test.go
@@ -4,8 +4,8 @@ import (
 	"testing"
 
 	"github.com/nspcc-dev/dbft"
-	"github.com/nspcc-dev/dbft/crypto"
-	"github.com/nspcc-dev/dbft/payload"
+	"github.com/nspcc-dev/dbft/internal/crypto"
+	"github.com/nspcc-dev/dbft/internal/payload"
 	"github.com/stretchr/testify/require"
 )
 

diff --git a/block/block.go → internal/block/block.go b/block/block.go → internal/block/block.go
@@ -3,10 +3,10 @@ package block
 import (
 	"bytes"
 	"encoding/gob"
-	"github.com/nspcc-dev/dbft"
 
-	"github.com/nspcc-dev/dbft/crypto"
-	"github.com/nspcc-dev/dbft/merkle"
+	"github.com/nspcc-dev/dbft"
+	"github.com/nspcc-dev/dbft/internal/crypto"
+	"github.com/nspcc-dev/dbft/internal/merkle"
 )
 
 type (

diff --git a/block/block_test.go → internal/block/block_test.go b/block/block_test.go → internal/block/block_test.go
@@ -6,20 +6,21 @@ import (
 	"encoding/binary"
 	"encoding/gob"
 	"errors"
-	"github.com/nspcc-dev/dbft"
 	"testing"
 
-	"github.com/nspcc-dev/dbft/crypto"
+	"github.com/nspcc-dev/dbft"
+	crypto2 "github.com/nspcc-dev/dbft/internal/crypto"
+
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
 func TestNeoBlock_Setters(t *testing.T) {
 	b := new(neoBlock)
 
-	require.Equal(t, crypto.Uint256{}, b.Hash())
+	require.Equal(t, crypto2.Uint256{}, b.Hash())
 
-	txs := []dbft.Transaction[crypto.Uint256]{testTx(1), testTx(2)}
+	txs := []dbft.Transaction[crypto2.Uint256]{testTx(1), testTx(2)}
 	b.SetTransactions(txs)
 	assert.Equal(t, txs, b.Transactions())
 
@@ -29,14 +30,14 @@ func TestNeoBlock_Setters(t *testing.T) {
 	b.base.Version = 42
 	assert.EqualValues(t, 42, b.Version())
 
-	b.base.NextConsensus = crypto.Uint160{1}
-	assert.Equal(t, crypto.Uint160{1}, b.NextConsensus())
+	b.base.NextConsensus = crypto2.Uint160{1}
+	assert.Equal(t, crypto2.Uint160{1}, b.NextConsensus())
 
-	b.base.PrevHash = crypto.Uint256{3, 7}
-	assert.Equal(t, crypto.Uint256{3, 7}, b.PrevHash())
+	b.base.PrevHash = crypto2.Uint256{3, 7}
+	assert.Equal(t, crypto2.Uint256{3, 7}, b.PrevHash())
 
-	b.base.MerkleRoot = crypto.Uint256{13}
-	assert.Equal(t, crypto.Uint256{13}, b.MerkleRoot())
+	b.base.MerkleRoot = crypto2.Uint256{13}
+	assert.Equal(t, crypto2.Uint256{13}, b.MerkleRoot())
 
 	b.base.Timestamp = 1234
 	// 1234s -> 1234000000000ns
@@ -59,7 +60,7 @@ func TestNeoBlock_Setters(t *testing.T) {
 	})
 
 	t.Run("hash does not change after signature", func(t *testing.T) {
-		priv, pub := crypto.Generate(rand.Reader)
+		priv, pub := crypto2.Generate(rand.Reader)
 		require.NotNil(t, priv)
 		require.NotNil(t, pub)
 
@@ -85,7 +86,7 @@ func (t testKey) Sign([]byte) ([]byte, error) {
 
 type testTx uint64
 
-func (tx testTx) Hash() (h crypto.Uint256) {
+func (tx testTx) Hash() (h crypto2.Uint256) {
 	binary.LittleEndian.PutUint64(h[:], uint64(tx))
 	return
 }
diff --git a/crypto/crypto.go → internal/crypto/crypto.go b/crypto/crypto.go → internal/crypto/crypto.go
@@ -1,8 +1,9 @@
 package crypto
 
 import (
-	"github.com/nspcc-dev/dbft"
 	"io"
+
+	"github.com/nspcc-dev/dbft"
 )
 
 type suiteType byte

diff --git a/crypto/crypto_test.go → internal/crypto/crypto_test.go b/crypto/crypto_test.go → internal/crypto/crypto_test.go
diff --git a/crypto/ecdsa.go → internal/crypto/ecdsa.go b/crypto/ecdsa.go → internal/crypto/ecdsa.go
@@ -5,10 +5,11 @@ import (
 	"crypto/elliptic"
 	"crypto/sha256"
 	"errors"
-	"github.com/nspcc-dev/dbft"
 	"io"
 	"math/big"
 
+	"github.com/nspcc-dev/dbft"
+
 	"github.com/nspcc-dev/rfc6979"
 )
 

diff --git a/crypto/ecdsa_test.go → internal/crypto/ecdsa_test.go b/crypto/ecdsa_test.go → internal/crypto/ecdsa_test.go
diff --git a/crypto/hash.go → internal/crypto/hash.go b/crypto/hash.go → internal/crypto/hash.go
diff --git a/crypto/hash_test.go → internal/crypto/hash_test.go b/crypto/hash_test.go → internal/crypto/hash_test.go
diff --git a/merkle/merkle_tree.go → internal/merkle/merkle_tree.go b/merkle/merkle_tree.go → internal/merkle/merkle_tree.go
@@ -1,7 +1,7 @@
 package merkle
 
 import (
-	"github.com/nspcc-dev/dbft/crypto"
+	"github.com/nspcc-dev/dbft/internal/crypto"
 )
 
 type (

diff --git a/merkle/merkle_tree_test.go → internal/merkle/merkle_tree_test.go b/merkle/merkle_tree_test.go → internal/merkle/merkle_tree_test.go
@@ -5,7 +5,7 @@ import (
 	"encoding/hex"
 	"testing"
 
-	"github.com/nspcc-dev/dbft/crypto"
+	"github.com/nspcc-dev/dbft/internal/crypto"
 	"github.com/stretchr/testify/require"
 )
 

diff --git a/payload/change_view.go → internal/payload/change_view.go b/payload/change_view.go → internal/payload/change_view.go
@@ -2,6 +2,7 @@ package payload
 
 import (
 	"encoding/gob"
+
 	"github.com/nspcc-dev/dbft"
 )
 

diff --git a/payload/commit.go → internal/payload/commit.go b/payload/commit.go → internal/payload/commit.go
@@ -2,6 +2,7 @@ package payload
 
 import (
 	"encoding/gob"
+
 	"github.com/nspcc-dev/dbft"
 )
 

diff --git a/payload/compact.go → internal/payload/compact.go b/payload/compact.go → internal/payload/compact.go
diff --git a/payload/consensus_message.go → internal/payload/consensus_message.go b/payload/consensus_message.go → internal/payload/consensus_message.go
@@ -3,9 +3,10 @@ package payload
 import (
 	"bytes"
 	"encoding/gob"
+
 	"github.com/nspcc-dev/dbft"
+	"github.com/nspcc-dev/dbft/internal/crypto"
 
-	"github.com/nspcc-dev/dbft/crypto"
 	"github.com/pkg/errors"
 )
 

diff --git a/payload/constructors.go → internal/payload/constructors.go b/payload/constructors.go → internal/payload/constructors.go
@@ -2,7 +2,7 @@ package payload
 
 import (
 	"github.com/nspcc-dev/dbft"
-	"github.com/nspcc-dev/dbft/crypto"
+	"github.com/nspcc-dev/dbft/internal/crypto"
 )
 
 // NewConsensusPayload returns minimal ConsensusPayload implementation.

diff --git a/payload/helpers.go → internal/payload/helpers.go b/payload/helpers.go → internal/payload/helpers.go
diff --git a/payload/message.go → internal/payload/message.go b/payload/message.go → internal/payload/message.go
@@ -3,9 +3,9 @@ package payload
 import (
 	"bytes"
 	"encoding/gob"
-	"github.com/nspcc-dev/dbft"
 
-	"github.com/nspcc-dev/dbft/crypto"
+	"github.com/nspcc-dev/dbft"
+	"github.com/nspcc-dev/dbft/internal/crypto"
 )
 
 type (

diff --git a/payload/message_test.go → internal/payload/message_test.go b/payload/message_test.go → internal/payload/message_test.go
@@ -4,10 +4,11 @@ import (
 	"bytes"
 	"crypto/rand"
 	"encoding/gob"
-	"github.com/nspcc-dev/dbft"
 	"testing"
 
-	"github.com/nspcc-dev/dbft/crypto"
+	"github.com/nspcc-dev/dbft"
+	crypto2 "github.com/nspcc-dev/dbft/internal/crypto"
+
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -16,7 +17,7 @@ func TestPayload_EncodeDecode(t *testing.T) {
 	m := NewConsensusPayload().(*Payload)
 	m.SetValidatorIndex(10)
 	m.SetHeight(77)
-	m.SetPrevHash(crypto.Uint256{1})
+	m.SetPrevHash(crypto2.Uint256{1})
 	m.SetVersion(8)
 	m.SetViewNumber(3)
 
@@ -25,7 +26,7 @@ func TestPayload_EncodeDecode(t *testing.T) {
 		m.SetPayload(&prepareRequest{
 			nonce:     123,
 			timestamp: 345,
-			transactionHashes: []crypto.Uint256{
+			transactionHashes: []crypto2.Uint256{
 				{1, 2, 3},
 				{5, 6, 7},
 			},
@@ -38,7 +39,7 @@ func TestPayload_EncodeDecode(t *testing.T) {
 	t.Run("PrepareResponse", func(t *testing.T) {
 		m.SetType(dbft.PrepareResponseType)
 		m.SetPayload(&prepareResponse{
-			preparationHash: crypto.Uint256{3},
+			preparationHash: crypto2.Uint256{3},
 		})
 
 		testEncodeDecode(t, m, new(Payload))
@@ -85,7 +86,7 @@ func TestPayload_EncodeDecode(t *testing.T) {
 			prepareRequest: &prepareRequest{
 				nonce:     123,
 				timestamp: 345,
-				transactionHashes: []crypto.Uint256{
+				transactionHashes: []crypto2.Uint256{
 					{1, 2, 3},
 					{5, 6, 7},
 				},
@@ -111,22 +112,22 @@ func TestRecoveryMessage_NoPayloads(t *testing.T) {
 	m := NewConsensusPayload().(*Payload)
 	m.SetValidatorIndex(0)
 	m.SetHeight(77)
-	m.SetPrevHash(crypto.Uint256{1})
+	m.SetPrevHash(crypto2.Uint256{1})
 	m.SetVersion(8)
 	m.SetViewNumber(3)
 	m.SetPayload(&recoveryMessage{})
 
 	validators := make([]dbft.PublicKey, 1)
-	_, validators[0] = crypto.Generate(rand.Reader)
+	_, validators[0] = crypto2.Generate(rand.Reader)
 
 	rec := m.GetRecoveryMessage()
 	require.NotNil(t, rec)
 
-	var p dbft.ConsensusPayload[crypto.Uint256, crypto.Uint160]
+	var p dbft.ConsensusPayload[crypto2.Uint256, crypto2.Uint160]
 	require.NotPanics(t, func() { p = rec.GetPrepareRequest(p, validators, 0) })
 	require.Nil(t, p)
 
-	var ps []dbft.ConsensusPayload[crypto.Uint256, crypto.Uint160]
+	var ps []dbft.ConsensusPayload[crypto2.Uint256, crypto2.Uint160]
 	require.NotPanics(t, func() { ps = rec.GetPrepareResponses(p, validators) })
 	require.Len(t, ps, 0)
 
@@ -188,8 +189,8 @@ func TestPayload_Setters(t *testing.T) {
 	t.Run("RecoveryMessage", func(t *testing.T) {
 		r := NewRecoveryMessage()
 
-		r.SetPreparationHash(&crypto.Uint256{1, 2, 3})
-		require.Equal(t, &crypto.Uint256{1, 2, 3}, r.PreparationHash())
+		r.SetPreparationHash(&crypto2.Uint256{1, 2, 3})
+		require.Equal(t, &crypto2.Uint256{1, 2, 3}, r.PreparationHash())
 	})
 }
 

diff --git a/payload/prepare_request.go → internal/payload/prepare_request.go b/payload/prepare_request.go → internal/payload/prepare_request.go
@@ -2,9 +2,9 @@ package payload
 
 import (
 	"encoding/gob"
-	"github.com/nspcc-dev/dbft"
 
-	"github.com/nspcc-dev/dbft/crypto"
+	"github.com/nspcc-dev/dbft"
+	"github.com/nspcc-dev/dbft/internal/crypto"
 )
 
 type (

diff --git a/payload/prepare_response.go → internal/payload/prepare_response.go b/payload/prepare_response.go → internal/payload/prepare_response.go
@@ -2,9 +2,9 @@ package payload
 
 import (
 	"encoding/gob"
-	"github.com/nspcc-dev/dbft"
 
-	"github.com/nspcc-dev/dbft/crypto"
+	"github.com/nspcc-dev/dbft"
+	"github.com/nspcc-dev/dbft/internal/crypto"
 )
 
 type (

diff --git a/payload/recovery_message.go → internal/payload/recovery_message.go b/payload/recovery_message.go → internal/payload/recovery_message.go
@@ -3,9 +3,9 @@ package payload
 import (
 	"encoding/gob"
 	"errors"
-	"github.com/nspcc-dev/dbft"
 
-	"github.com/nspcc-dev/dbft/crypto"
+	"github.com/nspcc-dev/dbft"
+	"github.com/nspcc-dev/dbft/internal/crypto"
 )
 
 type (

diff --git a/payload/recovery_request.go → internal/payload/recovery_request.go b/payload/recovery_request.go → internal/payload/recovery_request.go
@@ -2,6 +2,7 @@ package payload
 
 import (
 	"encoding/gob"
+
 	"github.com/nspcc-dev/dbft"
 )