README
¶
🤖 hyperdrive
A Byzantine fault tolerant consensus algorithm for secure multiparty computation protocols. For more information, checkout the Wiki.
Built with ❤ by Ren.
Documentation
¶
Overview ¶
Package hyperdrive a high-level package for running multiple instances of the Hyperdrive consensus algorithm for over multiple shards. The Hyperdrive interface is the main entry point for users.
Index ¶
- Variables
- type Block
- type BlockIterator
- type BlockPlan
- type BlockState
- type BlockStorage
- type BlockTxs
- type Blockchain
- type Blocks
- type Broadcaster
- type Hash
- type Hashes
- type Height
- type Hyperdrive
- type Message
- type Messages
- type Observer
- type Options
- type Process
- type ProcessState
- type ProcessStorage
- type Replica
- type Replicas
- type Round
- type Shard
- type Shards
- type Signatories
- type Signatory
- type Signature
- type Signatures
- type Timestamp
- type Validator
Constants ¶
This section is empty.
Variables ¶
var ( StandardBlockKind = block.Standard RebaseBlockKind = block.Rebase BaseBlockKind = block.Base NewBlock = block.New NewBlockHeader = block.NewHeader )
var ( // NewSignatory returns a Signatory from an ECDSA public key by serializing // the ECDSA public key into bytes and hashing it with SHA256. NewSignatory = id.NewSignatory )
Functions ¶
This section is empty.
Types ¶
type Block ¶ added in v0.2.0
A Block is an atomic unit of data upon which consensus is reached. Everything upon which consensus is needed should be put into a block, and consensus can only be reached on a block by block basis (there is no finer-grained way to express consensus).
type BlockIterator ¶ added in v0.2.0
type BlockIterator = replica.BlockIterator
type BlockPlan ¶ added in v0.3.0
A BlockPlan represents application-specific data that is needed to execute the transactions in a block. No assumptions are made about the format of this plan.
type BlockState ¶ added in v0.2.0
The BlockState represents application-specific state.
type BlockStorage ¶ added in v0.2.0
type BlockStorage = replica.BlockStorage
type BlockTxs ¶ added in v0.3.0
BlockTxs represent the application-specific transactions that are being proposed as part of a block. An application that wishes to achieve consensus on activity within the application should represent this activity as transactions, serialise them into bytes, and put them into a block. No assumptions are made about the format of these transactions.
type Blockchain ¶ added in v0.2.0
type Blockchain = process.Blockchain
type Broadcaster ¶ added in v0.2.0
type Broadcaster = replica.Broadcaster
type Hash ¶ added in v0.2.0
A Hash is the `[32]byte` output of a hashing function. Hyperdrive uses SHA256 for hashing.
type Hyperdrive ¶
type Hyperdrive interface {
Start()
Rebase(sigs Signatories)
HandleMessage(message Message)
}
Hyperdrive manages multiple `Replicas` from different `Shards`.
func New ¶
func New(options Options, pStorage ProcessStorage, blockStorage BlockStorage, blockIterator BlockIterator, validator Validator, observer Observer, broadcaster Broadcaster, shards Shards, privKey ecdsa.PrivateKey) Hyperdrive
New returns a new `Hyperdrive` instance that wraps multiple replica instances. One replica instance will be created per Shard, but all replica instances will use the same interfaces and private key. Replicas will not be created for shards for which the replica is not a signatory. This means that rebasing can shuffle Signatories, but it cannot introduce new ones or remove existing ones (this will be supported in future updates).
hyper := hyperdrive.New(
hyperdrive.Options{},
pStorage,
bStorage,
bIter,
validator,
observer,
broadcaster,
shards,
privKey,
)
hyper.Start()
for {
select {
case <-ctx.Done():
break
case message, ok := <-messagesFromNetwork:
if !ok {
break
}
hyper.HandleMessage(message)
}
}
type ProcessState ¶ added in v0.2.0
type ProcessStorage ¶ added in v0.2.0
type ProcessStorage = replica.ProcessStorage
type Round ¶ added in v0.2.0
The Round in a consensus algorithm at which a block was proposed/committed.
type Signatories ¶ added in v0.2.0
type Signatories = id.Signatories
Signatories is a wrapper around the `[]Signatory` type.
type Signatory ¶ added in v0.2.0
A Signatory is the `[32]byte` resulting from hashing an ECDSA public key. It represents the public identity of a content author and can be used to authenticate content that has been signed.
type Signature ¶ added in v0.2.0
A Signature is the `[65]byte` output of an ECDSA signing algorithm. Hyperdrive uses the secp256k1 curve for ECDSA signing.
type Signatures ¶ added in v0.2.0
type Signatures = id.Signatures
Signatures is a wrapper around the `[]Signature` type.
Source Files
Directories