request

Documentation

Index

• Constants
• func CreateDeploymentScript(avm []byte, manif *manifest.Manifest) ([]byte, error)
• func CreateFunctionInvocationScript(contract util.Uint160, params Params) ([]byte, error)
• func CreateInvocationScript(contract util.Uint160, funcParams []Param) ([]byte, error)
• type BlockFilter
• type ExecutionFilter
• type FuncParam
• type In
  • func NewIn() *In
  • func (r *In) DecodeData(data io.ReadCloser) error
  • func (r *In) Params() (*Params, error)
• type NotificationFilter
• type Param
  • func (p *Param) GetArray() ([]Param, error)
  • func (p *Param) GetBoolean() bool
  • func (p *Param) GetBytesBase64() ([]byte, error)
  • func (p *Param) GetBytesHex() ([]byte, error)
  • func (p *Param) GetFuncParam() (FuncParam, error)
  • func (p *Param) GetInt() (int, error)
  • func (p Param) GetSigner() (transaction.Signer, error)
  • func (p Param) GetSigners() ([]transaction.Signer, error)
  • func (p *Param) GetString() (string, error)
  • func (p *Param) GetUint160FromAddress() (util.Uint160, error)
  • func (p *Param) GetUint160FromAddressOrHex() (util.Uint160, error)
  • func (p *Param) GetUint160FromHex() (util.Uint160, error)
  • func (p *Param) GetUint256() (util.Uint256, error)
  • func (p Param) String() string
  • func (p *Param) UnmarshalJSON(data []byte) error
• type Params
  • func (p Params) Value(index int) *Param
  • func (p Params) ValueWithType(index int, valType paramType) *Param
• type Raw
• type RawParams
  • func NewRawParams(vals ...interface{}) RawParams
• type TxFilter

Constants

const (
	StringT paramType
	NumberT
	ArrayT
	FuncParamT
	BlockFilterT
	TxFilterT
	NotificationFilterT
	ExecutionFilterT
	Signer
)

These are parameter types accepted by RPC server.

const (
	// JSONRPCVersion is the only JSON-RPC protocol version supported.
	JSONRPCVersion = "2.0"
)

Functions

func CreateDeploymentScript

func CreateDeploymentScript(avm []byte, manif *manifest.Manifest) ([]byte, error)

CreateDeploymentScript returns a script that deploys given smart contract with its metadata.

func CreateFunctionInvocationScript

func CreateFunctionInvocationScript(contract util.Uint160, params Params) ([]byte, error)

CreateFunctionInvocationScript creates a script to invoke given contract with given parameters.

func CreateInvocationScript

func CreateInvocationScript(contract util.Uint160, funcParams []Param) ([]byte, error)

CreateInvocationScript creates a script to invoke given contract with given parameters. It differs from CreateFunctionInvocationScript in that it expects one array of FuncParams and expands it onto the stack as independent elements.

Types

type BlockFilter

type BlockFilter struct {
	Primary int `json:"primary"`
}

BlockFilter is a wrapper structure for block event filter. The only allowed filter is primary index.

type ExecutionFilter

type ExecutionFilter struct {
	State string `json:"state"`
}

ExecutionFilter is a wrapper structure used for transaction execution events. It allows to choose failing or successful transactions based on their VM state.

type FuncParam

type FuncParam struct {
	Type  smartcontract.ParamType `json:"type"`
	Value Param                   `json:"value"`
}

FuncParam represents a function argument parameter used in the invokefunction RPC method.

type In

type In struct {
	JSONRPC   string          `json:"jsonrpc"`
	Method    string          `json:"method"`
	RawParams json.RawMessage `json:"params,omitempty"`
	RawID     json.RawMessage `json:"id,omitempty"`
}

In represents a standard JSON-RPC 2.0 request: http://www.jsonrpc.org/specification#request_object. It's used in server to represent incoming queries.

func NewIn

func NewIn() *In

NewIn creates a new Request struct.

func (*In) DecodeData

func (r *In) DecodeData(data io.ReadCloser) error

DecodeData decodes the given reader into the the request struct.

func (*In) Params

func (r *In) Params() (*Params, error)

Params takes a slice of any type and attempts to bind the params to it.

type NotificationFilter

type NotificationFilter struct {
	Contract *util.Uint160 `json:"contract,omitempty"`
	Name     *string       `json:"name,omitempty"`
}

NotificationFilter is a wrapper structure representing filter used for notifications generated during transaction execution. Notifications can be filtered by contract hash and by name.

type Param

type Param struct {
	Type  paramType
	Value interface{}
}

Param represents a param either passed to the server or to send to a server using the client.

func (*Param) GetArray

func (p *Param) GetArray() ([]Param, error)

GetArray returns a slice of Params stored in the parameter.

func (*Param) GetBoolean

func (p *Param) GetBoolean() bool

GetBoolean returns boolean value of the parameter.

func (*Param) GetBytesBase64

func (p *Param) GetBytesBase64() ([]byte, error)

GetBytesBase64 returns []byte value of the parameter if it is a base64-encoded string.

func (*Param) GetBytesHex

func (p *Param) GetBytesHex() ([]byte, error)

GetBytesHex returns []byte value of the parameter if it is a hex-encoded string.

func (*Param) GetFuncParam

func (p *Param) GetFuncParam() (FuncParam, error)

GetFuncParam returns current parameter as a function call parameter.

func (*Param) GetInt

func (p *Param) GetInt() (int, error)

GetInt returns int value of te parameter.

func (Param) GetSigner

func (p Param) GetSigner() (transaction.Signer, error)

GetSigner returns transaction.Signer value of the parameter.

func (Param) GetSigners

func (p Param) GetSigners() ([]transaction.Signer, error)

GetSigners returns a slice of transaction.Signer with global scope from array of Uint160 or array of serialized transaction.Signer stored in the parameter.

func (*Param) GetString

func (p *Param) GetString() (string, error)

GetString returns string value of the parameter.

func (*Param) GetUint160FromAddress

func (p *Param) GetUint160FromAddress() (util.Uint160, error)

GetUint160FromAddress returns Uint160 value of the parameter that was supplied as an address.

func (*Param) GetUint160FromAddressOrHex

func (p *Param) GetUint160FromAddressOrHex() (util.Uint160, error)

GetUint160FromAddressOrHex returns Uint160 value of the parameter that was supplied either as raw hex or as an address.

func (*Param) GetUint160FromHex

func (p *Param) GetUint160FromHex() (util.Uint160, error)

GetUint160FromHex returns Uint160 value of the parameter encoded in hex.

func (*Param) GetUint256

func (p *Param) GetUint256() (util.Uint256, error)

GetUint256 returns Uint256 value of the parameter.

func (Param) String

func (p Param) String() string

func (*Param) UnmarshalJSON

func (p *Param) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface.

type Params

type Params []Param

Params represents the JSON-RPC params.

func (Params) Value

func (p Params) Value(index int) *Param

Value returns the param struct for the given index if it exists.

func (Params) ValueWithType

func (p Params) ValueWithType(index int, valType paramType) *Param

ValueWithType returns the param struct at the given index if it exists and matches the given type.

type Raw

type Raw struct {
	JSONRPC   string        `json:"jsonrpc"`
	Method    string        `json:"method"`
	RawParams []interface{} `json:"params"`
	ID        int           `json:"id"`
}

Raw represents JSON-RPC request.

type RawParams

type RawParams struct {
	Values []interface{}
}

RawParams is just a slice of abstract values, used to represent parameters passed from client to server.

func NewRawParams

func NewRawParams(vals ...interface{}) RawParams

NewRawParams creates RawParams from its parameters.

type TxFilter

type TxFilter struct {
	Sender *util.Uint160 `json:"sender,omitempty"`
	Signer *util.Uint160 `json:"signer,omitempty"`
}

TxFilter is a wrapper structure for transaction event filter. It allows to filter transactions by senders and signers.