account

Documentation

Index

• Constants
• func ProtocolAddr() address.Address
• type DepositGas
• type Protocol
  • func FindProtocol(registry *protocol.Registry) *Protocol
  • func NewProtocol(depositGas DepositGas) *Protocol
  • func (p *Protocol) CreateGenesisStates(ctx context.Context, sm protocol.StateManager) error
  • func (p *Protocol) ForceRegister(r *protocol.Registry) error
  • func (p *Protocol) Handle(ctx context.Context, act action.Action, sm protocol.StateManager) (*action.Receipt, error)
  • func (p *Protocol) Name() string
  • func (p *Protocol) ReadState(context.Context, protocol.StateReader, []byte, ...[]byte) ([]byte, uint64, error)
  • func (p *Protocol) Register(r *protocol.Registry) error
  • func (p *Protocol) Validate(ctx context.Context, act action.Action, sr protocol.StateReader) error

Constants

const TransferSizeLimit = 32 * 1024

TransferSizeLimit is the maximum size of transfer allowed

Functions

func ProtocolAddr

func ProtocolAddr() address.Address

ProtocolAddr returns the address generated from protocol id

Types

type DepositGas

type DepositGas func(ctx context.Context, sm protocol.StateManager, amount *big.Int) (*action.TransactionLog, error)

DepositGas deposits gas to some pool

type Protocol

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

Protocol defines the protocol of handling account

func FindProtocol

func FindProtocol(registry *protocol.Registry) *Protocol

FindProtocol finds the registered protocol from registry

func NewProtocol

func NewProtocol(depositGas DepositGas) *Protocol

NewProtocol instantiates the protocol of account

func (*Protocol) CreateGenesisStates

func (p *Protocol) CreateGenesisStates(ctx context.Context, sm protocol.StateManager) error

CreateGenesisStates initializes the protocol by setting the initial balances to some addresses

func (*Protocol) ForceRegister

func (p *Protocol) ForceRegister(r *protocol.Registry) error

ForceRegister registers the protocol with a unique ID and force replacing the previous protocol if it exists

func (*Protocol) Handle

func (p *Protocol) Handle(ctx context.Context, act action.Action, sm protocol.StateManager) (*action.Receipt, error)

Handle handles an account

func (*Protocol) Name

func (p *Protocol) Name() string

Name returns the name of protocol

func (*Protocol) ReadState

func (p *Protocol) ReadState(context.Context, protocol.StateReader, []byte, ...[]byte) ([]byte, uint64, error)

ReadState read the state on blockchain via protocol

func (*Protocol) Register

func (p *Protocol) Register(r *protocol.Registry) error

Register registers the protocol with a unique ID

func (*Protocol) Validate

func (p *Protocol) Validate(ctx context.Context, act action.Action, sr protocol.StateReader) error

Validate validates an account action