interop

Documentation

Overview

Package interop contains smart contract API functions and type synonyms. Its subpackages can be imported into smart contracts written in Go to provide various functionality. Upon compilation, functions from these packages will be substituted with appropriate NeoVM system calls implemented by Neo. Usually these system calls have additional price in NeoVM, so they're explicitly written in the documentation of respective functions.

Types defined here are used for proper manifest generation. Here is how Go types correspond to smartcontract and VM types:

int-like - Integer
bool - Boolean
[]byte - ByteArray (Buffer in VM)
string - String (ByteString in VM)
(interface{})(nil) - Any
(any)(nil) - Any
non-byte slice - Array
map[K]V - map

Other types are defined explicitly in this pkg: Hash160, Hash256, Interface, PublicKey, Signature.

Note that unless written otherwise structures defined in this packages can't be correctly created by new() or composite literals, they should be received from some interop functions (and then used as parameters for some other interop functions).

Index

• Constants
• type Hash160
  • func (a Hash160) Equals(b any) bool
• type Hash256
  • func (a Hash256) Equals(b any) bool
• type Interface
• type PublicKey
  • func (a PublicKey) Equals(b any) bool
• type Signature
  • func (a Signature) Equals(b any) bool

Constants

const (
	// Hash160Len is the length of proper Hash160 in bytes, use it to
	// sanitize input parameters.
	Hash160Len = 20
	// Hash256Len is the length of proper Hash256 in bytes, use it to
	// sanitize input parameters.
	Hash256Len = 32
	// PublicKeyCompressedLen is the length of compressed public key (which
	// is the most common public key type), use it to sanitize input
	// parameters.
	PublicKeyCompressedLen = 33
	// PublicKeyUncompressedLen is the length of uncompressed public key
	// (but you're not likely to ever encounter that), use it to sanitize
	// input parameters.
	PublicKeyUncompressedLen = 65
	// SignatureLen is the length of standard signature, use it to sanitize
	// input parameters.
	SignatureLen = 64
)

Types

type Hash160

type Hash160 []byte

Hash160 represents 20-byte hash.

func (Hash160) Equals

func (a Hash160) Equals(b any) bool

Equals compares Hash160 with the provided stackitem using EQUAL opcode. The provided stackitem `b` must be either one of the primitive type (int, bool, string, []byte) or derived from the primitive type, otherwise Equals will fail on .(string) conversion.

type Hash256

type Hash256 []byte

Hash256 represents 32-byte hash.

func (Hash256) Equals

func (a Hash256) Equals(b any) bool

Equals compares Hash256 with the provided stackitem using EQUAL opcode. The provided stackitem `b` must be either one of the primitive type (int, bool, string, []byte) or derived from the primitive type, otherwise Equals will fail on .(string) conversion.

type Interface

type Interface any

Interface represents interop interface type which is needed for transparent handling of VM-internal types (e.g. storage.Context).

type PublicKey

type PublicKey []byte

PublicKey represents marshalled ecdsa public key.

func (PublicKey) Equals

func (a PublicKey) Equals(b any) bool

Equals compares PublicKey with the provided stackitem using EQUAL opcode. The provided stackitem `b` must be either one of the primitive type (int, bool, string, []byte) or derived from the primitive type, otherwise Equals will fail on .(string) conversion.

type Signature

type Signature []byte

Signature represents 64-byte signature.

func (Signature) Equals

func (a Signature) Equals(b any) bool

Equals compares Signature with the provided stackitem using EQUAL opcode. The provided stackitem `b` must be either one of the primitive types (int, bool, string, []byte) or derived from the primitive type, otherwise Equals will fail on .(string) conversion.