signing

Documentation

Index

• type Builder
  • func (s *Builder) AddDelegator(delegator *url.URL) *Builder
  • func (s *Builder) ClearTimestamp() *Builder
  • func (s *Builder) Copy() *Builder
  • func (s *Builder) Import(sig protocol.Signature) (*Builder, error)
  • func (s *Builder) Initiate(txn *protocol.Transaction) (protocol.Signature, error)
  • func (s *Builder) InitiateSynthetic(txn *protocol.Transaction, dest *url.URL) (*protocol.PartitionSignature, error)
  • func (s *Builder) SetKeyPageUrl(bookUrl *url.URL, pageIndex uint64) *Builder
  • func (s *Builder) SetPrivateKey(privKey []byte) *Builder
  • func (s *Builder) SetSigner(signer Signer) *Builder
  • func (s *Builder) SetTimestamp(timestamp uint64) *Builder
  • func (s *Builder) SetTimestampToNow() *Builder
  • func (s *Builder) SetTimestampWithVar(timestamp *uint64) *Builder
  • func (s *Builder) SetType(typ protocol.SignatureType) *Builder
  • func (s *Builder) SetUrl(u *url.URL) *Builder
  • func (s *Builder) SetVersion(version uint64) *Builder
  • func (s *Builder) Sign(message []byte) (protocol.Signature, error)
  • func (s *Builder) UseFaucet() *Builder
  • func (s *Builder) UseMerkleHash() *Builder
  • func (s *Builder) UseSimpleHash() *Builder
• type InitHashMode
• type PrivateKey
  • func (k PrivateKey) SetPublicKey(sig protocol.Signature) error
  • func (k PrivateKey) Sign(sig protocol.Signature, sigMdHash, message []byte) error
• type Signer
• type Timestamp
• type TimestampFromValue
  • func (t TimestampFromValue) Get() (uint64, error)
• type TimestampFromVariable
  • func (t *TimestampFromVariable) Get() (uint64, error)

Types

type Builder

type Builder struct {
	InitMode   InitHashMode
	Type       protocol.SignatureType
	Url        *url.URL
	Delegators []*url.URL
	Signer     Signer
	Version    uint64
	Vote       protocol.VoteType
	Timestamp  Timestamp
	Memo       string
	Data       []byte

	// Ignore64Byte (when set) stops the signature builder from automatically
	// correcting a transaction header or body that marshals to 64 bytes.
	Ignore64Byte bool
}

func (*Builder) AddDelegator

func (s *Builder) AddDelegator(delegator *url.URL) *Builder

func (*Builder) ClearTimestamp

func (s *Builder) ClearTimestamp() *Builder

func (*Builder) Copy

func (s *Builder) Copy() *Builder

func (*Builder) Import

func (s *Builder) Import(sig protocol.Signature) (*Builder, error)

func (*Builder) Initiate

func (s *Builder) Initiate(txn *protocol.Transaction) (protocol.Signature, error)

func (*Builder) InitiateSynthetic

func (s *Builder) InitiateSynthetic(txn *protocol.Transaction, dest *url.URL) (*protocol.PartitionSignature, error)

func (*Builder) SetKeyPageUrl

func (s *Builder) SetKeyPageUrl(bookUrl *url.URL, pageIndex uint64) *Builder

func (*Builder) SetPrivateKey

func (s *Builder) SetPrivateKey(privKey []byte) *Builder

func (*Builder) SetSigner

func (s *Builder) SetSigner(signer Signer) *Builder

func (*Builder) SetTimestamp

func (s *Builder) SetTimestamp(timestamp uint64) *Builder

func (*Builder) SetTimestampToNow

func (s *Builder) SetTimestampToNow() *Builder

func (*Builder) SetTimestampWithVar

func (s *Builder) SetTimestampWithVar(timestamp *uint64) *Builder

func (*Builder) SetType

func (s *Builder) SetType(typ protocol.SignatureType) *Builder

func (*Builder) SetUrl

func (s *Builder) SetUrl(u *url.URL) *Builder

func (*Builder) SetVersion

func (s *Builder) SetVersion(version uint64) *Builder

func (*Builder) Sign

func (s *Builder) Sign(message []byte) (protocol.Signature, error)

func (*Builder) UseFaucet

func (s *Builder) UseFaucet() *Builder

func (*Builder) UseMerkleHash

func (s *Builder) UseMerkleHash() *Builder

UseMerkleHash initiate with a Merkle hash.

Deprecated: Use Builder.UseSimpleHash.

func (*Builder) UseSimpleHash

func (s *Builder) UseSimpleHash() *Builder

UseSimpleHash initiate with a simple hash.

type InitHashMode

type InitHashMode int

const (
	// Initiate with a Merkle hash.
	//
	// Deprecated: Use [InitWithSimpleHash].
	InitWithMerkleHash InitHashMode = iota

	// Initiate with a simple hash.
	InitWithSimpleHash
)

type PrivateKey

type PrivateKey []byte

func (PrivateKey) SetPublicKey

func (k PrivateKey) SetPublicKey(sig protocol.Signature) error

func (PrivateKey) Sign

func (k PrivateKey) Sign(sig protocol.Signature, sigMdHash, message []byte) error

type Signer

type Signer interface {
	SetPublicKey(protocol.Signature) error
	Sign(protocol.Signature, []byte, []byte) error
}

type Timestamp

type Timestamp interface {
	Get() (uint64, error)
}

type TimestampFromValue

type TimestampFromValue uint64

func (TimestampFromValue) Get

func (t TimestampFromValue) Get() (uint64, error)

type TimestampFromVariable

type TimestampFromVariable uint64

func (*TimestampFromVariable) Get

func (t *TimestampFromVariable) Get() (uint64, error)