multisig

package
v0.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 6, 2019 License: Apache-2.0 Imports: 11 Imported by: 13

README

How multisig work in action

A brief summary with code links to the client and server side:

  1. Create a multisig condition: https://github.com/iov-one/weave/blob/master/cmd/bnsd/scenarios/main_test.go#L56

  2. Configure the multisig in the genesis: https://github.com/iov-one/weave/blob/master/cmd/bnsd/scenarios/main_test.go#L169

  3. Submit the multisig contract ID by the client: https://github.com/iov-one/weave/blob/master/cmd/bnsd/scenarios/main_test.go#L169

  4. The contract is loaded on the server side: https://github.com/iov-one/weave/blob/master/x/multisig/decorator.go#L45

  5. Signatures are validated and threshold compared: https://github.com/iov-one/weave/blob/master/x/multisig/decorator.go#L69

    5b. https://github.com/iov-one/weave/blob/master/x/auth.go#L86

  6. Added to the request context: https://github.com/iov-one/weave/blob/master/x/multisig/context.go#L24

  7. Verified by a handler: https://github.com/iov-one/weave/blob/master/x/validators/handler.go#L14

    7c. In the multisig authenticator: https://github.com/iov-one/weave/blob/master/x/multisig/context.go#L51

    7b. Setup at app level: https://github.com/iov-one/weave/blob/master/cmd/bnsd/app/app.go#L37

Documentation

Overview

> Multisignature (multi-signature) is a digital signature scheme which allows a group of users to sign a single document. https://en.wikipedia.org/wiki/Multisignature

Thi multisig package contains a mutable contract model where multiple signatures can be stored together with a threshold for activation.

A `Decorator` is designed as middleware to load and validate the signatures of a transaction for a given contract ID. When the threshold is reached a `MultiSigCondition` is stored into the request context. This condition can be resolved to an address by the multisig `Authenticator` when authenticating the request in a handler.

An `Initializer` can be instrumented to define multisig contracts in the Genesis file and load them on startup. The transaction `Handlers` provide functionality for persistent updates and new contracts.

Index

Constants

View Source 
const (
	// BucketName is where we store the contracts
	BucketName = "contracts"
	// SequenceName is an auto-increment ID counter for contracts
	SequenceName = "id"
)

Variables

View Source 
var (
	ErrInvalidLengthCodec = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowCodec   = fmt.Errorf("proto: integer overflow")
)

Functions

func MultiSigCondition 

func MultiSigCondition(id []byte) weave.Condition

MultiSigCondition returns condition for a contract ID

func RegisterQuery 

func RegisterQuery(qr weave.QueryRouter)

RegisterQuery register queries from buckets in this package

func RegisterRoutes 

func RegisterRoutes(r weave.Registry, auth x.Authenticator)

RegisterRoutes will instantiate and register all handlers in this package

Types

type Authenticate 

type Authenticate struct {
}

Authenticate gets/sets permissions on the given context key

func (Authenticate) GetConditions 

func (a Authenticate) GetConditions(ctx weave.Context) []weave.Condition

GetConditions returns permissions previously set on this context

func (Authenticate) HasAddress 

func (a Authenticate) HasAddress(ctx weave.Context, addr weave.Address) bool

HasAddress returns true iff this address is in GetConditions

type Contract 

type Contract struct {
	Metadata *weave.Metadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Participants defines a list of all signatures that are allowed to sign the
	// contract.
	Participants []*Participant `protobuf:"bytes,2,rep,name=participants,proto3" json:"participants,omitempty"`
	// Activation threshold defines the minimal weight value that must be
	// provided from participants in order to activate the contract. Weight is
	// computed as the sum of weights of all participating signatures.
	ActivationThreshold Weight `` /* 135-byte string literal not displayed */
	// Admin threshold defines the minimal weight value that must be provided
	// from participants in order to administrate the contract. Weight is
	// computed as the sum of weights of all participating signatures.
	AdminThreshold Weight `protobuf:"varint,4,opt,name=admin_threshold,json=adminThreshold,proto3,casttype=Weight" json:"admin_threshold,omitempty"`
}

func (*Contract) Copy 

func (c *Contract) Copy() orm.CloneableData

func (*Contract) Descriptor 

func (*Contract) Descriptor() ([]byte, []int)

func (*Contract) GetActivationThreshold 

func (m *Contract) GetActivationThreshold() Weight

func (*Contract) GetAdminThreshold 

func (m *Contract) GetAdminThreshold() Weight

func (*Contract) GetMetadata added in v0.15.0 

func (m *Contract) GetMetadata() *weave.Metadata

func (*Contract) GetParticipants added in v0.13.0 

func (m *Contract) GetParticipants() []*Participant

func (*Contract) Marshal 

func (m *Contract) Marshal() (dAtA []byte, err error)

func (*Contract) MarshalTo 

func (m *Contract) MarshalTo(dAtA []byte) (int, error)

func (*Contract) ProtoMessage 

func (*Contract) ProtoMessage()

func (*Contract) Reset 

func (m *Contract) Reset()

func (*Contract) Size 

func (m *Contract) Size() (n int)

func (*Contract) String 

func (m *Contract) String() string

func (*Contract) Unmarshal 

func (m *Contract) Unmarshal(dAtA []byte) error

func (*Contract) Validate 

func (c *Contract) Validate() error

func (*Contract) XXX_DiscardUnknown added in v0.12.0 

func (m *Contract) XXX_DiscardUnknown()

func (*Contract) XXX_Marshal added in v0.12.0 

func (m *Contract) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Contract) XXX_Merge added in v0.12.0 

func (m *Contract) XXX_Merge(src proto.Message)

func (*Contract) XXX_Size added in v0.12.0 

func (m *Contract) XXX_Size() int

func (*Contract) XXX_Unmarshal added in v0.12.0 

func (m *Contract) XXX_Unmarshal(b []byte) error

type ContractBucket 

type ContractBucket struct {
	orm.Bucket
	// contains filtered or unexported fields
}

ContractBucket is a type-safe wrapper around orm.Bucket

func NewContractBucket 

func NewContractBucket() ContractBucket

NewContractBucket initializes a ContractBucket with default name

inherit Get and Save from orm.Bucket add run-time check on Save

func (ContractBucket) Build added in v0.10.0 

func (b ContractBucket) Build(db weave.KVStore, c *Contract) (orm.Object, error)

Build assigns an ID to given contract instance and returns it as an orm Object. It does not persist the escrow in the store.

func (ContractBucket) GetContract added in v0.13.0 

func (b ContractBucket) GetContract(store weave.KVStore, contractID []byte) (*Contract, error)

GetContract returns a contract with given ID.

func (ContractBucket) Save 

func (b ContractBucket) Save(db weave.KVStore, obj orm.Object) error

Save enforces the proper type

type CreateContractMsg 

type CreateContractMsg struct {
	Metadata            *weave.Metadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	Participants        []*Participant  `protobuf:"bytes,2,rep,name=participants,proto3" json:"participants,omitempty"`
	ActivationThreshold Weight          `` /* 135-byte string literal not displayed */
	AdminThreshold      Weight          `protobuf:"varint,4,opt,name=admin_threshold,json=adminThreshold,proto3,casttype=Weight" json:"admin_threshold,omitempty"`
}

func (*CreateContractMsg) Descriptor 

func (*CreateContractMsg) Descriptor() ([]byte, []int)

func (*CreateContractMsg) GetActivationThreshold 

func (m *CreateContractMsg) GetActivationThreshold() Weight

func (*CreateContractMsg) GetAdminThreshold 

func (m *CreateContractMsg) GetAdminThreshold() Weight

func (*CreateContractMsg) GetMetadata added in v0.15.0 

func (m *CreateContractMsg) GetMetadata() *weave.Metadata

func (*CreateContractMsg) GetParticipants added in v0.13.0 

func (m *CreateContractMsg) GetParticipants() []*Participant

func (*CreateContractMsg) Marshal 

func (m *CreateContractMsg) Marshal() (dAtA []byte, err error)

func (*CreateContractMsg) MarshalTo 

func (m *CreateContractMsg) MarshalTo(dAtA []byte) (int, error)

func (CreateContractMsg) Path 

func (CreateContractMsg) Path() string

Path fulfills weave.Msg interface to allow routing

func (*CreateContractMsg) ProtoMessage 

func (*CreateContractMsg) ProtoMessage()

func (*CreateContractMsg) Reset 

func (m *CreateContractMsg) Reset()

func (*CreateContractMsg) Size 

func (m *CreateContractMsg) Size() (n int)

func (*CreateContractMsg) String 

func (m *CreateContractMsg) String() string

func (*CreateContractMsg) Unmarshal 

func (m *CreateContractMsg) Unmarshal(dAtA []byte) error

func (*CreateContractMsg) Validate 

func (c *CreateContractMsg) Validate() error

Validate enforces sigs and threshold boundaries

func (*CreateContractMsg) XXX_DiscardUnknown added in v0.12.0 

func (m *CreateContractMsg) XXX_DiscardUnknown()

func (*CreateContractMsg) XXX_Marshal added in v0.12.0 

func (m *CreateContractMsg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateContractMsg) XXX_Merge added in v0.12.0 

func (m *CreateContractMsg) XXX_Merge(src proto.Message)

func (*CreateContractMsg) XXX_Size added in v0.12.0 

func (m *CreateContractMsg) XXX_Size() int

func (*CreateContractMsg) XXX_Unmarshal added in v0.12.0 

func (m *CreateContractMsg) XXX_Unmarshal(b []byte) error

type CreateContractMsgHandler 

type CreateContractMsgHandler struct {
	// contains filtered or unexported fields
}

func (CreateContractMsgHandler) Check 

func (h CreateContractMsgHandler) Check(ctx weave.Context, db weave.KVStore, tx weave.Tx) (*weave.CheckResult, error)

func (CreateContractMsgHandler) Deliver 

func (h CreateContractMsgHandler) Deliver(ctx weave.Context, db weave.KVStore, tx weave.Tx) (*weave.DeliverResult, error)

type Decorator 

type Decorator struct {
	// contains filtered or unexported fields
}

Decorator checks multisig contract if available

func NewDecorator 

func NewDecorator(auth x.Authenticator) Decorator

NewDecorator returns a default multisig decorator

func (Decorator) Check 

func (d Decorator) Check(ctx weave.Context, store weave.KVStore, tx weave.Tx, next weave.Checker) (*weave.CheckResult, error)

Check enforce multisig contract before calling down the stack

func (Decorator) Deliver 

func (d Decorator) Deliver(ctx weave.Context, store weave.KVStore, tx weave.Tx, next weave.Deliverer) (*weave.DeliverResult, error)

Deliver enforces multisig contract before calling down the stack

type Initializer added in v0.10.0 

type Initializer struct{}

Initializer fulfils the Initializer interface to load data from the genesis file

func (*Initializer) FromGenesis added in v0.10.0 

func (*Initializer) FromGenesis(opts weave.Options, db weave.KVStore) error

FromGenesis will parse initial account info from genesis and save it in the database.

type MultiSigTx 

type MultiSigTx interface {
	GetMultisig() [][]byte
}

MultiSigTx is an optional interface for a Tx that allows it to support multisig contract. Multisig authentication can be done only for transactions that do support this interface.

type Participant added in v0.13.0 

type Participant struct {
	Signature github_com_iov_one_weave.Address `protobuf:"bytes,1,opt,name=signature,proto3,casttype=github.com/iov-one/weave.Address" json:"signature,omitempty"`
	Weight    Weight                           `protobuf:"varint,2,opt,name=weight,proto3,casttype=Weight" json:"weight,omitempty"`
}

Participant clubs together a signature with a weight. The greater the weight the greater the power of a signature.

func (*Participant) Descriptor added in v0.13.0 

func (*Participant) Descriptor() ([]byte, []int)

func (*Participant) GetSignature added in v0.13.0 

func (m *Participant) GetSignature() github_com_iov_one_weave.Address

func (*Participant) GetWeight added in v0.15.0 

func (m *Participant) GetWeight() Weight

func (*Participant) Marshal added in v0.13.0 

func (m *Participant) Marshal() (dAtA []byte, err error)

func (*Participant) MarshalTo added in v0.13.0 

func (m *Participant) MarshalTo(dAtA []byte) (int, error)

func (*Participant) ProtoMessage added in v0.13.0 

func (*Participant) ProtoMessage()

func (*Participant) Reset added in v0.13.0 

func (m *Participant) Reset()

func (*Participant) Size added in v0.13.0 

func (m *Participant) Size() (n int)

func (*Participant) String added in v0.13.0 

func (m *Participant) String() string

func (*Participant) Unmarshal added in v0.13.0 

func (m *Participant) Unmarshal(dAtA []byte) error

func (*Participant) XXX_DiscardUnknown added in v0.13.0 

func (m *Participant) XXX_DiscardUnknown()

func (*Participant) XXX_Marshal added in v0.13.0 

func (m *Participant) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Participant) XXX_Merge added in v0.13.0 

func (m *Participant) XXX_Merge(src proto.Message)

func (*Participant) XXX_Size added in v0.13.0 

func (m *Participant) XXX_Size() int

func (*Participant) XXX_Unmarshal added in v0.13.0 

func (m *Participant) XXX_Unmarshal(b []byte) error

type UpdateContractMsg 

type UpdateContractMsg struct {
	Metadata            *weave.Metadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	ContractID          []byte          `protobuf:"bytes,2,opt,name=contract_id,json=contractId,proto3" json:"contract_id,omitempty"`
	Participants        []*Participant  `protobuf:"bytes,3,rep,name=participants,proto3" json:"participants,omitempty"`
	ActivationThreshold Weight          `` /* 135-byte string literal not displayed */
	AdminThreshold      Weight          `protobuf:"varint,5,opt,name=admin_threshold,json=adminThreshold,proto3,casttype=Weight" json:"admin_threshold,omitempty"`
}

func (*UpdateContractMsg) Descriptor 

func (*UpdateContractMsg) Descriptor() ([]byte, []int)

func (*UpdateContractMsg) GetActivationThreshold 

func (m *UpdateContractMsg) GetActivationThreshold() Weight

func (*UpdateContractMsg) GetAdminThreshold 

func (m *UpdateContractMsg) GetAdminThreshold() Weight

func (*UpdateContractMsg) GetContractID added in v0.13.0 

func (m *UpdateContractMsg) GetContractID() []byte

func (*UpdateContractMsg) GetMetadata added in v0.15.0 

func (m *UpdateContractMsg) GetMetadata() *weave.Metadata

func (*UpdateContractMsg) GetParticipants added in v0.13.0 

func (m *UpdateContractMsg) GetParticipants() []*Participant

func (*UpdateContractMsg) Marshal 

func (m *UpdateContractMsg) Marshal() (dAtA []byte, err error)

func (*UpdateContractMsg) MarshalTo 

func (m *UpdateContractMsg) MarshalTo(dAtA []byte) (int, error)

func (UpdateContractMsg) Path 

func (UpdateContractMsg) Path() string

Path fulfills weave.Msg interface to allow routing

func (*UpdateContractMsg) ProtoMessage 

func (*UpdateContractMsg) ProtoMessage()

func (*UpdateContractMsg) Reset 

func (m *UpdateContractMsg) Reset()

func (*UpdateContractMsg) Size 

func (m *UpdateContractMsg) Size() (n int)

func (*UpdateContractMsg) String 

func (m *UpdateContractMsg) String() string

func (*UpdateContractMsg) Unmarshal 

func (m *UpdateContractMsg) Unmarshal(dAtA []byte) error

func (*UpdateContractMsg) Validate 

func (c *UpdateContractMsg) Validate() error

Validate enforces sigs and threshold boundaries

func (*UpdateContractMsg) XXX_DiscardUnknown added in v0.12.0 

func (m *UpdateContractMsg) XXX_DiscardUnknown()

func (*UpdateContractMsg) XXX_Marshal added in v0.12.0 

func (m *UpdateContractMsg) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UpdateContractMsg) XXX_Merge added in v0.12.0 

func (m *UpdateContractMsg) XXX_Merge(src proto.Message)

func (*UpdateContractMsg) XXX_Size added in v0.12.0 

func (m *UpdateContractMsg) XXX_Size() int

func (*UpdateContractMsg) XXX_Unmarshal added in v0.12.0 

func (m *UpdateContractMsg) XXX_Unmarshal(b []byte) error

type UpdateContractMsgHandler 

type UpdateContractMsgHandler struct {
	// contains filtered or unexported fields
}

func (UpdateContractMsgHandler) Check 

func (h UpdateContractMsgHandler) Check(ctx weave.Context, db weave.KVStore, tx weave.Tx) (*weave.CheckResult, error)

func (UpdateContractMsgHandler) Deliver 

func (h UpdateContractMsgHandler) Deliver(ctx weave.Context, db weave.KVStore, tx weave.Tx) (*weave.DeliverResult, error)

type Weight added in v0.13.0 

type Weight int32

Weight represents the strength of a signature.

func (Weight) Validate added in v0.13.0 

func (w Weight) Validate() error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.