mirror of
https://github.com/nspcc-dev/neo-go.git
synced 2024-11-26 19:42:23 +00:00
6b21ad9922
Everywhere including examples, external interop APIs, bindings generators
code and in other valuable places. A couple of `interface{}` usages are
intentionally left in the CHANGELOG.md, documentation and tests.
92 lines
4 KiB
Go
92 lines
4 KiB
Go
/*
|
|
Package storage provides functions to access and modify contract's storage.
|
|
Neo storage's model follows simple key-value DB pattern, this storage is a part
|
|
of blockchain state, so you can use it between various invocations of the same
|
|
contract.
|
|
*/
|
|
package storage
|
|
|
|
import (
|
|
"github.com/nspcc-dev/neo-go/pkg/interop/iterator"
|
|
"github.com/nspcc-dev/neo-go/pkg/interop/neogointernal"
|
|
)
|
|
|
|
// Context represents storage context that is mandatory for Put/Get/Delete
|
|
// operations. It's an opaque type that can only be created properly by
|
|
// GetContext, GetReadOnlyContext or ConvertContextToReadOnly. It's similar
|
|
// to Neo .net framework's StorageContext class.
|
|
type Context struct{}
|
|
|
|
// FindFlags represents parameters to `Find` iterator.
|
|
type FindFlags byte
|
|
|
|
const (
|
|
// None is default option. Iterator values are key-value pairs.
|
|
None FindFlags = 0
|
|
// KeysOnly is used for iterating over keys.
|
|
KeysOnly FindFlags = 1 << 0
|
|
// RemovePrefix is used for stripping prefix (passed to Find) from keys.
|
|
RemovePrefix FindFlags = 1 << 1
|
|
// ValuesOnly is used for iterating over values.
|
|
ValuesOnly FindFlags = 1 << 2
|
|
// DeserializeValues is used for deserializing values on-the-fly.
|
|
// It can be combined with other options.
|
|
DeserializeValues FindFlags = 1 << 3
|
|
// PickField0 is used to get first field in a serialized struct or array.
|
|
PickField0 FindFlags = 1 << 4
|
|
// PickField1 is used to get second field in a serialized struct or array.
|
|
PickField1 FindFlags = 1 << 5
|
|
)
|
|
|
|
// ConvertContextToReadOnly returns new context from the given one, but with
|
|
// writing capability turned off, so that you could only invoke Get and Find
|
|
// using this new Context. If Context is already read-only this function is a
|
|
// no-op. It uses `System.Storage.AsReadOnly` syscall.
|
|
func ConvertContextToReadOnly(ctx Context) Context {
|
|
return neogointernal.Syscall1("System.Storage.AsReadOnly", ctx).(Context)
|
|
}
|
|
|
|
// GetContext returns current contract's (that invokes this function) storage
|
|
// context. It uses `System.Storage.GetContext` syscall.
|
|
func GetContext() Context {
|
|
return neogointernal.Syscall0("System.Storage.GetContext").(Context)
|
|
}
|
|
|
|
// GetReadOnlyContext returns current contract's (that invokes this function)
|
|
// storage context in read-only mode, you can use this context for Get and Find
|
|
// functions, but using it for Put and Delete will fail. It uses
|
|
// `System.Storage.GetReadOnlyContext` syscall.
|
|
func GetReadOnlyContext() Context {
|
|
return neogointernal.Syscall0("System.Storage.GetReadOnlyContext").(Context)
|
|
}
|
|
|
|
// Put saves given value with given key in the storage using given Context.
|
|
// Even though it accepts interface{} hidden under `any` for both, you can only
|
|
// pass simple types there like string, []byte, int or bool (not structures or
|
|
// slices of more complex types). To put more complex types there serialize them
|
|
// first using runtime.Serialize. This function uses `System.Storage.Put` syscall.
|
|
func Put(ctx Context, key any, value any) {
|
|
neogointernal.Syscall3NoReturn("System.Storage.Put", ctx, key, value)
|
|
}
|
|
|
|
// Get retrieves value stored for the given key using given Context. See Put
|
|
// documentation on possible key and value types. If the value is not present in
|
|
// the database it returns nil. This function uses `System.Storage.Get` syscall.
|
|
func Get(ctx Context, key any) any {
|
|
return neogointernal.Syscall2("System.Storage.Get", ctx, key)
|
|
}
|
|
|
|
// Delete removes key-value pair from storage by the given key using given
|
|
// Context. See Put documentation on possible key types. This function uses
|
|
// `System.Storage.Delete` syscall.
|
|
func Delete(ctx Context, key any) {
|
|
neogointernal.Syscall2NoReturn("System.Storage.Delete", ctx, key)
|
|
}
|
|
|
|
// Find returns an iterator.Iterator over key-value pairs in the given Context
|
|
// that match the given key (contain it as a prefix). See Put documentation on
|
|
// possible key types and iterator package documentation on how to use the
|
|
// returned value. This function uses `System.Storage.Find` syscall.
|
|
func Find(ctx Context, key any, options FindFlags) iterator.Iterator {
|
|
return neogointernal.Syscall3("System.Storage.Find", ctx, key, options).(iterator.Iterator)
|
|
}
|