README
¶
Signature-aggregator SDK
Usage example
// Copyright (C) 2025, Lux Industries, Inc. All rights reserved
// See the file LICENSE for licensing terms.
package main
import (
"fmt"
"os"
"github.com/luxfi/lux-cli/sdk/network"
"github.com/luxfi/lux-cli/sdk/warp"
"github.com/luxfi/luxd/ids"
"github.com/luxfi/luxd/utils/logging"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
func main() {
network := network.TestnetNetwork()
aggregator, err := warp.NewSignatureAggregator(
network,
logging.NewLogger(
"aggregator_test",
logging.NewWrappedCore(
logging.Error,
os.Stdout,
zapcore.NewConsoleEncoder(
zap.NewProductionEncoderConfig(),
),
),
),
logging.Error,
ids.Empty,
warp.DefaultQuorumPercentage,
)
if err != nil {
panic(err)
}
msgHexString := "0x000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000002cc0000000000057fc93d85c6d62c5b2ac0b519c87010ea5294012d1e407030d6acd0021cac10d5000002a200000000000100000014253b2784c75e510dd0ff1da844684a1ac0aa5fcf000002800000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000049d0000000000000000000000009297e09b81db7ae921fb69dc745dc0d37ec4ab6ddd30039ae180ccb3b132f5c67f299b83749f1f0a12f7d69878c6b696598fd0c50000000000000000000000006839ebb9c7b7df12a2147790f6aaa19ac1bf76eb000000000000000000000000000000000000000000000000000000000001117000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000120000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000600000000000000000000000014c3ae49cb46c965e6c9aca4a121c8f8481d44b900000000000000000000000000000000000000000000000000000000000000c00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000040000000000000000000000000f7571ae49399c8a1b4c8c8eb8cc328bc5f817590000000000000000000000000000000000000000000000000016345785d8a00000000000000000000000000000000000000000000"
justificationHexString := hex.EncodeToString([]byte("test"))
reply, err := aggregator.AggregateSignatures(msgHexString, justificationHexString)
if err != nil {
panic(err)
}
fmt.Println(reply)
}
❯ go run example.go
0000000000057fc93d85c6d62c5b2ac0b519c87010ea5294012d1e407030d6acd0021cac10d5000002a200000000000100000014253b2784c75e510dd0ff1da844684a1ac0aa5fcf000002800000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000049d0000000000000000000000009297e09b81db7ae921fb69dc745dc0d37ec4ab6ddd30039ae180ccb3b132f5c67f299b83749f1f0a12f7d69878c6b696598fd0c50000000000000000000000006839ebb9c7b7df12a2147790f6aaa19ac1bf76eb000000000000000000000000000000000000000000000000000000000001117000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000120000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000600000000000000000000000014c3ae49cb46c965e6c9aca4a121c8f8481d44b900000000000000000000000000000000000000000000000000000000000000c00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000040000000000000000000000000f7571ae49399c8a1b4c8c8eb8cc328bc5f817590000000000000000000000000000000000000000000000000016345785d8a00000000000000000036210300000084000102000a10100100000402000000001204000020000000000000000030100040000400130444001000084011042040aa495650029c5a7106a75623ab55ab9e895795f79d12a5f5b62ce1f55c71989f3bc70a7ddbfdf520953c0d9cfe1329b60e6e931a9f548da3101d435773bdb5756cbdb1a8cc25c08f7dba367642a6c35cfbb3d817d93fb7948e8038d0cb06414f
Documentation
¶
Overview ¶
Package warp provides warp message signing and aggregation utilities.
Index ¶
Constants ¶
View Source
const ( SignatureAggregatorRequestTimeout = 30 * time.Second DefaultQuorumPercentage = 67 MaxRetries = 3 InitialBackoff = 1 * time.Second )
Variables ¶
This section is empty.
Functions ¶
func SignMessage ¶
func SignMessage(logger luxlog.Logger, signatureAggregatorEndpoint string, message, justification, signingChainID string, quorumPercentage uint64) (*warp.Message, error)
SignMessage sends a request to the signature aggregator to sign a message. It returns the signed warp message or an error if the operation fails.
Types ¶
type AggregateSignatureRequest ¶
type AggregateSignatureRequest struct {
Message string
SigningChainID string
QuorumPercentage uint64
Justification string
}
AggregateSignatureRequest defines the request structure for signature aggregation
type AggregateSignatureResponse ¶
type AggregateSignatureResponse struct {
SignedMessage string
}
AggregateSignatureResponse defines the response structure for signature aggregation
type Client
deprecated
added in
v1.16.45
type Client interface {
// PublishBlockchain requests the node to begin publishing consensus and decision events
PublishBlockchain(ctx context.Context, chainID string, options ...rpc.Option) (*apiwarp.PublishBlockchainReply, error)
// UnpublishBlockchain requests the node to stop publishing consensus and decision events
UnpublishBlockchain(ctx context.Context, chainID string, options ...rpc.Option) error
// GetPublishedBlockchains requests the node to get blockchains being published
GetPublishedBlockchains(ctx context.Context, options ...rpc.Option) ([]ids.ID, error)
}
Client interface for interacting with the IPCS endpoint
Deprecated: The IPCs API is deprecated. The Index API should be used instead.
Source Files
Click to show internal directories.
Click to hide internal directories.