smartcontract

Documentation

Index

• func CreateMultiSigRedeemScript(m int, publicKeys keys.PublicKeys) ([]byte, error)
• func GetDeploymentPrice(props PropertyState) util.Fixed8
• type ContractDetails
• type ParamType
  • func ParseParamType(typ string) (ParamType, error)
  • func (pt *ParamType) DecodeBinary(r *io.BinReader)
  • func (pt ParamType) EncodeBinary(w *io.BinWriter)
  • func (pt ParamType) MarshalJSON() ([]byte, error)
  • func (pt ParamType) MarshalYAML() (interface{}, error)
  • func (pt ParamType) String() string
  • func (pt *ParamType) UnmarshalJSON(data []byte) error
  • func (pt *ParamType) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Parameter
  • func NewParameter(t ParamType) Parameter
  • func NewParameterFromString(in string) (*Parameter, error)
  • func (p *Parameter) DecodeBinary(r *io.BinReader)
  • func (p *Parameter) EncodeBinary(w *io.BinWriter)
  • func (p *Parameter) MarshalJSON() ([]byte, error)
  • func (p Parameter) TryParse(dest interface{}) error
  • func (p *Parameter) UnmarshalJSON(data []byte) (err error)
• type ParameterPair
  • func (p *ParameterPair) DecodeBinary(r *io.BinReader)
  • func (p *ParameterPair) EncodeBinary(w *io.BinWriter)
• type Params
  • func (p Params) TryParseArray(vals ...interface{}) error
• type PropertyState

Functions

func CreateMultiSigRedeemScript

func CreateMultiSigRedeemScript(m int, publicKeys keys.PublicKeys) ([]byte, error)

CreateMultiSigRedeemScript creates a script runnable by the VM.

func GetDeploymentPrice

func GetDeploymentPrice(props PropertyState) util.Fixed8

GetDeploymentPrice returns contract deployment price based on its properties.

Types

type ContractDetails

type ContractDetails struct {
	Author               string
	Email                string
	Version              string
	ProjectName          string `yaml:"name"`
	Description          string
	HasStorage           bool
	HasDynamicInvocation bool
	IsPayable            bool
	ReturnType           ParamType
	Parameters           []ParamType
}

ContractDetails contains contract metadata.

type ParamType

type ParamType int

ParamType represents the Type of the smart contract parameter.

const (
	UnknownType          ParamType = -1
	SignatureType        ParamType = 0x00
	BoolType             ParamType = 0x01
	IntegerType          ParamType = 0x02
	Hash160Type          ParamType = 0x03
	Hash256Type          ParamType = 0x04
	ByteArrayType        ParamType = 0x05
	PublicKeyType        ParamType = 0x06
	StringType           ParamType = 0x07
	ArrayType            ParamType = 0x10
	MapType              ParamType = 0x12
	InteropInterfaceType ParamType = 0xf0
	VoidType             ParamType = 0xff
)

A list of supported smart contract parameter types.

func ParseParamType

func ParseParamType(typ string) (ParamType, error)

ParseParamType is a user-friendly string to ParamType converter, it's case-insensitive and makes the following conversions:

signature -> SignatureType
bool, boolean -> BoolType
int, integer -> IntegerType
hash160 -> Hash160Type
hash256 -> Hash256Type
bytes, bytearray -> ByteArrayType
key, publickey -> PublicKeyType
string -> StringType
array, struct -> ArrayType
map -> MapType
interopinterface -> InteropInterfaceType
void -> VoidType

anything else generates an error.

func (*ParamType) DecodeBinary

func (pt *ParamType) DecodeBinary(r *io.BinReader)

DecodeBinary implements io.Serializable interface.

func (ParamType) EncodeBinary

func (pt ParamType) EncodeBinary(w *io.BinWriter)

EncodeBinary implements io.Serializable interface.

func (ParamType) MarshalJSON

func (pt ParamType) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (ParamType) MarshalYAML

func (pt ParamType) MarshalYAML() (interface{}, error)

MarshalYAML implements the YAML Marshaler interface.

func (ParamType) String

func (pt ParamType) String() string

String implements the stringer interface.

func (*ParamType) UnmarshalJSON

func (pt *ParamType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface.

func (*ParamType) UnmarshalYAML

func (pt *ParamType) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the YAML Unmarshaler interface.

type Parameter

type Parameter struct {
	// Type of the parameter.
	Type ParamType `json:"type"`
	// The actual value of the parameter.
	Value interface{} `json:"value"`
}

Parameter represents a smart contract parameter.

func NewParameter

func NewParameter(t ParamType) Parameter

NewParameter returns a Parameter with proper initialized Value of the given ParamType.

func NewParameterFromString

func NewParameterFromString(in string) (*Parameter, error)

NewParameterFromString returns a new Parameter initialized from the given string in neo-go-specific format. It is intended to be used in user-facing interfaces and has some heuristics in it to simplify parameter passing. Exact syntax is documented in the cli documentation.

func (*Parameter) DecodeBinary

func (p *Parameter) DecodeBinary(r *io.BinReader)

DecodeBinary implements io.Serializable interface.

func (*Parameter) EncodeBinary

func (p *Parameter) EncodeBinary(w *io.BinWriter)

EncodeBinary implements io.Serializable interface.

func (*Parameter) MarshalJSON

func (p *Parameter) MarshalJSON() ([]byte, error)

MarshalJSON implements Marshaler interface.

func (Parameter) TryParse

func (p Parameter) TryParse(dest interface{}) error

TryParse converts one Parameter into something more appropriate.

func (*Parameter) UnmarshalJSON

func (p *Parameter) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON implements Unmarshaler interface.

type ParameterPair

type ParameterPair struct {
	Key   Parameter `json:"key"`
	Value Parameter `json:"value"`
}

ParameterPair represents key-value pair, a slice of which is stored in MapType Parameter.

func (*ParameterPair) DecodeBinary

func (p *ParameterPair) DecodeBinary(r *io.BinReader)

DecodeBinary implements io.Serializable interface.

func (*ParameterPair) EncodeBinary

func (p *ParameterPair) EncodeBinary(w *io.BinWriter)

EncodeBinary implements io.Serializable interface.

type Params

type Params []Parameter

Params is an array of Parameter (TODO: drop it?).

func (Params) TryParseArray

func (p Params) TryParseArray(vals ...interface{}) error

TryParseArray converts an array of Parameter into an array of more appropriate things.

type PropertyState

type PropertyState byte

PropertyState represents contract properties (flags).

const (
	HasStorage PropertyState = 1 << iota
	HasDynamicInvoke
	IsPayable
	NoProperties = 0
)

List of supported properties.