ACP 118 reference implementation (#3218)

ava-labs · Jul 26, 2024 · 321e727 · 321e727
1 parent 553179e
commit 321e727
Show file tree

Hide file tree

Showing 6 changed files with 183 additions and 17 deletions.
diff --git a/network/p2p/handler.go b/network/p2p/handler.go
@@ -15,6 +15,14 @@ import (
 	"github.com/ava-labs/avalanchego/utils/logging"
 )
 
+// Standardized identifiers for application protocol handlers
+const (
+	TxGossipHandlerID = iota
+	AtomicTxGossipHandlerID
+	// SignatureRequestHandlerID is specified in ACP-118: https://github.com/avalanche-foundation/ACPs/tree/main/ACPs/118-warp-signature-request
+	SignatureRequestHandlerID
+)
+
 var (
 	_ Handler = (*NoOpHandler)(nil)
 	_ Handler = (*TestHandler)(nil)

diff --git a/proto/pb/sdk/sdk.pb.go b/proto/pb/sdk/sdk.pb.go
diff --git a/proto/sdk/sdk.proto b/proto/sdk/sdk.proto
@@ -16,3 +16,21 @@ message PullGossipResponse {
 message PushGossip {
   repeated bytes gossip = 1;
 }
+
+// SignatureRequest is an AppRequest message type for requesting
+// a BLS signature over a Warp message, as defined in ACP-118:
+// https://github.com/avalanche-foundation/ACPs/tree/main/ACPs/118-warp-signature-request
+message SignatureRequest {
+  // Warp message to be signed
+  bytes message = 1;
+  // Justification for the message
+  bytes justification = 2;
+}
+
+// SignatureRespnose is an AppResponse message type for providing
+// a requested BLS signature over a Warp message, as defined in ACP-118:
+// https://github.com/avalanche-foundation/ACPs/tree/main/ACPs/118-warp-signature-request
+message SignatureResponse {
+  // BLS signature over the Warp message
+  bytes signature = 1;
+}
diff --git a/vms/avm/network/network.go b/vms/avm/network/network.go
@@ -19,8 +19,6 @@ import (
 	"github.com/ava-labs/avalanchego/vms/avm/txs/mempool"
 )
 
-const txGossipHandlerID = 0
-
 var (
 	_ common.AppHandler    = (*Network)(nil)
 	_ validators.Connector = (*Network)(nil)
@@ -68,7 +66,7 @@ func New(
 		config.MaxValidatorSetStaleness,
 	)
 	txGossipClient := p2pNetwork.NewClient(
-		txGossipHandlerID,
+		p2p.TxGossipHandlerID,
 		p2p.WithValidatorSampling(validators),
 	)
 	txGossipMetrics, err := gossip.NewMetrics(registerer, "tx")
@@ -157,7 +155,7 @@ func New(
 		appRequestHandler: validatorHandler,
 	}
 
-	if err := p2pNetwork.AddHandler(txGossipHandlerID, txGossipHandler); err != nil {
+	if err := p2pNetwork.AddHandler(p2p.TxGossipHandlerID, txGossipHandler); err != nil {
 		return nil, err
 	}
 

diff --git a/vms/platformvm/network/network.go b/vms/platformvm/network/network.go
@@ -21,8 +21,6 @@ import (
 	"github.com/ava-labs/avalanchego/vms/platformvm/txs/mempool"
 )
 
-const TxGossipHandlerID = 0
-
 var errMempoolDisabledWithPartialSync = errors.New("mempool is disabled partial syncing")
 
 type Network struct {
@@ -66,7 +64,7 @@ func New(
 		config.MaxValidatorSetStaleness,
 	)
 	txGossipClient := p2pNetwork.NewClient(
-		TxGossipHandlerID,
+		p2p.TxGossipHandlerID,
 		p2p.WithValidatorSampling(validators),
 	)
 	txGossipMetrics, err := gossip.NewMetrics(registerer, "tx")
@@ -154,7 +152,7 @@ func New(
 		appRequestHandler: validatorHandler,
 	}
 
-	if err := p2pNetwork.AddHandler(TxGossipHandlerID, txGossipHandler); err != nil {
+	if err := p2pNetwork.AddHandler(p2p.TxGossipHandlerID, txGossipHandler); err != nil {
 		return nil, err
 	}
 

diff --git a/vms/platformvm/vm_regression_test.go b/vms/platformvm/vm_regression_test.go
@@ -37,7 +37,6 @@ import (
 	"github.com/ava-labs/avalanchego/vms/platformvm/block"
 	"github.com/ava-labs/avalanchego/vms/platformvm/config"
 	"github.com/ava-labs/avalanchego/vms/platformvm/metrics"
-	"github.com/ava-labs/avalanchego/vms/platformvm/network"
 	"github.com/ava-labs/avalanchego/vms/platformvm/reward"
 	"github.com/ava-labs/avalanchego/vms/platformvm/signer"
 	"github.com/ava-labs/avalanchego/vms/platformvm/state"
@@ -2441,7 +2440,7 @@ func TestValidatorSetRaceCondition(t *testing.T) {
 	require.NoError(err)
 
 	appRequestBytes := p2p.PrefixMessage(
-		p2p.ProtocolPrefix(network.TxGossipHandlerID),
+		p2p.ProtocolPrefix(p2p.TxGossipHandlerID),
 		protocolAppRequestBytest,
 	)