interop: provide missing smartcontract parameter type defs

Contract can have Hash160, Hash256, Signature etc. types which
all map to a `[]byte` in Go. Having synonyms helps us to generate
proper manifest file.

examples/token/token.go

@@ -2,6 +2,7 @@ package tokencontract
 
 import (
 	"github.com/nspcc-dev/neo-go/examples/token/nep5"
+	"github.com/nspcc-dev/neo-go/pkg/interop"
 	"github.com/nspcc-dev/neo-go/pkg/interop/storage"
 	"github.com/nspcc-dev/neo-go/pkg/interop/util"
 )
@@ -52,12 +53,12 @@ func TotalSupply() int {
 }
 
 // BalanceOf returns the amount of token on the specified address
-func BalanceOf(holder []byte) interface{} {
+func BalanceOf(holder interop.Hash160) interface{} {
 	return token.BalanceOf(ctx, holder)
 }
 
 // Transfer token from one user to another
-func Transfer(from []byte, to []byte, amount int) bool {
+func Transfer(from interop.Hash160, to interop.Hash160, amount int) bool {
 	return token.Transfer(ctx, from, to, amount)
 }
 

pkg/interop/blockchain/blockchain.go

@@ -3,21 +3,24 @@ Package blockchain provides functions to access various blockchain data.
 */
 package blockchain
 
-import "github.com/nspcc-dev/neo-go/pkg/interop/contract"
+import (
+	"github.com/nspcc-dev/neo-go/pkg/interop"
+	"github.com/nspcc-dev/neo-go/pkg/interop/contract"
+)
 
 // Transaction represents a NEO transaction. It's similar to Transaction class
 // in Neo .net framework.
 type Transaction struct {
 	// Hash represents the hash (256 bit BE value in a 32 byte slice) of the
 	// given transaction (which also is its ID).
-	Hash []byte
+	Hash interop.Hash256
 	// Version represents the transaction version.
 	Version int
 	// Nonce is a random number to avoid hash collision.
 	Nonce int
 	// Sender represents the sender (160 bit BE value in a 20 byte slice) of the
 	// given Transaction.
-	Sender []byte
+	Sender interop.Hash160
 	// SysFee represents fee to be burned.
 	SysFee int
 	// NetFee represents fee to be distributed to consensus nodes.
@@ -35,22 +38,22 @@ type Transaction struct {
 type Block struct {
 	// Hash represents the hash (256 bit BE value in a 32 byte slice) of the
 	// given block.
-	Hash []byte
+	Hash interop.Hash256
 	// Version of the block.
 	Version int
 	// PrevHash represents the hash (256 bit BE value in a 32 byte slice) of the
 	// previous block.
-	PrevHash []byte
+	PrevHash interop.Hash256
 	// MerkleRoot represents the root hash (256 bit BE value in a 32 byte slice)
 	// of a transaction list.
-	MerkleRoot []byte
+	MerkleRoot interop.Hash256
 	// Timestamp represents millisecond-precision block timestamp.
 	Timestamp int
 	// Index represents the height of the block.
 	Index int
 	// NextConsensus represents contract address of the next miner (160 bit BE
 	// value in a 20 byte slice).
-	NextConsensus []byte
+	NextConsensus interop.Hash160
 	// TransactionsLength represents the length of block's transactions array.
 	TransactionsLength int
 }
@@ -74,7 +77,7 @@ func GetBlock(heightOrHash interface{}) Block {
 // GetTransaction returns transaction found by the given hash (256 bit in BE
 // format represented as a slice of 32 bytes). This function uses
 // `System.Blockchain.GetTransaction` syscall.
-func GetTransaction(hash []byte) Transaction {
+func GetTransaction(hash interop.Hash256) Transaction {
 	return Transaction{}
 }
 
@@ -82,14 +85,14 @@ func GetTransaction(hash []byte) Transaction {
 // represented as a slice of 32 bytes) from the block found by the given hash or
 // index (with the same encoding as for GetHeader) by its index. This
 // function uses `System.Blockchain.GetTransactionFromBlock` syscall.
-func GetTransactionFromBlock(heightOrHash interface{}, index int) []byte {
+func GetTransactionFromBlock(heightOrHash interface{}, index int) interop.Hash256 {
 	return nil
 }
 
 // GetTransactionHeight returns transaction's height (index of the block that
 // includes it) by the given ID (256 bit in BE format represented as a slice of
 // 32 bytes). This function uses `System.Blockchain.GetTransactionHeight` syscall.
-func GetTransactionHeight(hash []byte) int {
+func GetTransactionHeight(hash interop.Hash256) int {
 	return 0
 }
 
@@ -97,6 +100,6 @@ func GetTransactionHeight(hash []byte) int {
 // format represented as a slice of 20 bytes). Refer to the `contract` package
 // for details on how to use the returned structure. This function uses
 // `System.Blockchain.GetContract` syscall.
-func GetContract(scriptHash []byte) contract.Contract {
+func GetContract(scriptHash interop.Hash160) contract.Contract {
 	return contract.Contract{}
 }

pkg/interop/contract/contract.go

@@ -3,6 +3,8 @@ Package contract provides functions to work with contracts.
 */
 package contract
 
+import "github.com/nspcc-dev/neo-go/pkg/interop"
+
 // Contract represents a Neo contract and is used in interop functions. It's
 // a data structure that you can manipulate with using functions from
 // this package. It's similar in function to the Contract class in the Neo .net
@@ -40,13 +42,13 @@ func Destroy() {}
 
 // IsStandard checks if contract with provided hash is a standard signature/multisig contract.
 // This function uses `System.Contract.IsStandard` syscall.
-func IsStandard(h []byte) bool {
+func IsStandard(h interop.Hash160) bool {
 	return false
 }
 
 // CreateStandardAccount calculates script hash of a given public key.
 // This function uses `System.Contract.CreateStandardAccount` syscall.
-func CreateStandardAccount(pub []byte) []byte {
+func CreateStandardAccount(pub interop.PublicKey) []byte {
 	return nil
 }
 

pkg/interop/crypto/crypto.go

@@ -3,36 +3,38 @@ Package crypto provides an interface to cryptographic syscalls.
 */
 package crypto
 
+import "github.com/nspcc-dev/neo-go/pkg/interop"
+
 // SHA256 computes SHA256 hash of b. It uses `Neo.Crypto.SHA256` syscall.
-func SHA256(b []byte) []byte {
+func SHA256(b []byte) interop.Hash256 {
 	return nil
 }
 
 // RIPEMD160 computes RIPEMD160 hash of b. It uses `Neo.Crypto.RIPEMD160` syscall.
-func RIPEMD160(b []byte) []byte {
+func RIPEMD160(b []byte) interop.Hash160 {
 	return nil
 }
 
 // ECDsaSecp256r1Verify checks that sig is correct msg's signature for a given pub
 // (serialized public key). It uses `Neo.Crypto.VerifyWithECDsaSecp256r1` syscall.
-func ECDsaSecp256r1Verify(msg []byte, pub []byte, sig []byte) bool {
+func ECDsaSecp256r1Verify(msg []byte, pub interop.PublicKey, sig interop.Signature) bool {
 	return false
 }
 
 // ECDsaSecp256k1Verify checks that sig is correct msg's signature for a given pub
 // (serialized public key). It uses `Neo.Crypto.VerifyWithECDsaSecp256k1` syscall.
-func ECDsaSecp256k1Verify(msg []byte, pub []byte, sig []byte) bool {
+func ECDsaSecp256k1Verify(msg []byte, pub interop.PublicKey, sig interop.Signature) bool {
 	return false
 }
 
 // ECDSASecp256r1CheckMultisig checks multiple ECDSA signatures at once. It uses
 // `Neo.Crypto.CheckMultisigWithECDsaSecp256r1` syscall.
-func ECDSASecp256r1CheckMultisig(msg []byte, pubs [][]byte, sigs [][]byte) bool {
+func ECDSASecp256r1CheckMultisig(msg []byte, pubs []interop.PublicKey, sigs []interop.Signature) bool {
 	return false
 }
 
 // ECDSASecp256k1CheckMultisig checks multiple ECDSA signatures at once. It uses
 // `Neo.Crypto.CheckMultisigWithECDsaSecp256k1` syscall.
-func ECDSASecp256k1CheckMultisig(msg []byte, pubs [][]byte, sigs [][]byte) bool {
+func ECDSASecp256k1CheckMultisig(msg []byte, pubs []interop.PublicKey, sigs []interop.Signature) bool {
 	return false
 }

pkg/interop/doc.go

@@ -1,11 +1,23 @@
 /*
-Package interop contains smart contract API functions.
+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
+	non-byte slice - Array
+	map[K]V - map
+Other types are defined explicitly in this pkg:
+	Hash160, Hash256, InteropInterface, 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

pkg/interop/engine/engine.go

@@ -5,10 +5,12 @@ framework.
 */
 package engine
 
+import "github.com/nspcc-dev/neo-go/pkg/interop"
+
 // AppCall executes previously deployed blockchain contract with specified hash
 // (160 bit in BE form represented as 20-byte slice) using provided arguments.
 // It returns whatever this contract returns. This function uses
 // `System.Contract.Call` syscall.
-func AppCall(scriptHash []byte, method string, args ...interface{}) interface{} {
+func AppCall(scriptHash interop.Hash160, method string, args ...interface{}) interface{} {
 	return nil
 }

pkg/interop/runtime/engine.go

@@ -1,6 +1,9 @@
 package runtime
 
-import "github.com/nspcc-dev/neo-go/pkg/interop/blockchain"
+import (
+	"github.com/nspcc-dev/neo-go/pkg/interop"
+	"github.com/nspcc-dev/neo-go/pkg/interop/blockchain"
+)
 
 // GetScriptContainer returns the transaction that initially triggered current
 // execution context. It never changes in a single execution, no matter how deep
@@ -15,7 +18,7 @@ func GetScriptContainer() blockchain.Transaction {
 // AppCall can change the value returned by this function if it calls a
 // different contract. This function uses
 // `System.Runtime.GetExecutingScriptHash` syscall.
-func GetExecutingScriptHash() []byte {
+func GetExecutingScriptHash() interop.Hash160 {
 	return nil
 }
 
@@ -24,7 +27,7 @@ func GetExecutingScriptHash() []byte {
 // running context (caller of current contract or function), so it's one level
 // above the GetExecutingScriptHash in the call stack. It uses
 // `System.Runtime.GetCallingScriptHash` syscall.
-func GetCallingScriptHash() []byte {
+func GetCallingScriptHash() interop.Hash160 {
 	return nil
 }
 
@@ -33,6 +36,6 @@ func GetCallingScriptHash() []byte {
 // (this is a script that is contained in a transaction returned by
 // GetScriptContainer) execution from the start. This function uses
 // `System.Runtime.GetEntryScriptHash` syscall.
-func GetEntryScriptHash() []byte {
+func GetEntryScriptHash() interop.Hash160 {
 	return nil
 }

pkg/interop/runtime/runtime.go

@@ -4,6 +4,8 @@ It has similar function to Runtime class in .net framwork for Neo.
 */
 package runtime
 
+import "github.com/nspcc-dev/neo-go/pkg/interop"
+
 // Trigger values to compare with GetTrigger result.
 const (
 	System       byte = 0x01
@@ -60,7 +62,7 @@ func GasLeft() int64 {
 // 'nil' literal means no filtering. It returns slice consisting of following elements:
 // [  scripthash of notification's contract  ,  emitted item  ].
 // This function uses `System.Runtime.GetNotifications` syscall.
-func GetNotifications(h []byte) [][]interface{} {
+func GetNotifications(h interop.Hash160) [][]interface{} {
 	return nil
 }
 

pkg/interop/types.go

@@ -0,0 +1,17 @@
+package interop
+
+// Signature represents 64-byte signature.
+type Signature []byte
+
+// Hash160 represents 20-byte hash.
+type Hash160 []byte
+
+// Hash256 represents 32-byte hash.
+type Hash256 []byte
+
+// PublicKey represents marshalled ecdsa public key.
+type PublicKey []byte
+
+// Interface represents interop interface type which is needed for
+// transparent handling of VM-internal types (e.g. storage.Context)
+type Interface interface{}

pkg/interop/util/util.go

@@ -3,11 +3,13 @@ Package util contains some special useful functions that are provided by compile
 */
 package util
 
+import "github.com/nspcc-dev/neo-go/pkg/interop"
+
 // FromAddress is an utility function that converts a Neo address to its hash
 // (160 bit BE value in a 20 byte slice). It can only be used for strings known
 // at compilation time, because the conversion is actually being done by the
 // compiler.
-func FromAddress(address string) []byte {
+func FromAddress(address string) interop.Hash160 {
 	return nil
 }