io.neow3j.devpack.neo

Class Storage

java.lang.Object

io.neow3j.devpack.neo.Storage

public class Storage
extends java.lang.Object

Provides a set of methods to insert, query, and delete data in the persistent storage of smart contracts.

Most methods in Storage are available in a version that requires a StorageContext as parameter and a version that doesn't. On multiple consecutive calls to Storage methods, it makes sense to retrieve the StorageContext once and reuse it in each call. This saves GAS because the Syscall for getting the StorageContext is only called once and not with every Storage method invocation.

Constructor Summary

Constructors

Constructor and Description
Storage()

Method Summary

Modifier and Type	Method and Description
static void	delete(byte[] key) Deletes the value corresponding to the given key from the storage.
static void	delete(StorageContext context, byte[] key) Deletes the value corresponding to the given key from the storage.
static void	delete(StorageContext context, java.lang.String key) Deletes the value corresponding to the given key from the storage.
static void	delete(java.lang.String key) Deletes the value corresponding to the given key from the storage.
static Iterator<byte[],byte[]>	find(byte[] prefix) Returns an iterator over the values found under the given key prefix.
static Iterator<byte[],byte[]>	find(StorageContext context, byte[] prefix) Returns an iterator over the values found under the given key prefix.
static Iterator<java.lang.String,byte[]>	find(StorageContext context, java.lang.String prefix) Returns an iterator over the values found under the given key prefix.
static Iterator<java.lang.String,byte[]>	find(java.lang.String prefix) Returns an iterator over the values found under the given key prefix.
static byte[]	get(byte[] key) Returns the value corresponding to the given key.
static byte[]	get(StorageContext context, byte[] key) Returns the value corresponding to the given key.
static byte[]	get(StorageContext context, java.lang.String key) Returns the value corresponding to the given key.
static byte[]	get(java.lang.String key) Returns the value corresponding to the given key.
static StorageContext	getReadOnlyContext() Returns the storage context of the contract in read-only mode.
static StorageContext	getStorageContext() Returns the storage context of the contract.
static void	put(byte[] key, byte[] value) Stores the given key-value pair.
static void	put(byte[] key, int value) Stores the given key-value pair.
static void	put(byte[] key, long value) Stores the given key-value pair.
static void	put(byte[] key, java.lang.String value) Stores the given key-value pair.
static void	put(StorageContext context, byte[] key, byte[] value) Stores the given key-value pair.
static void	put(StorageContext context, byte[] key, int value) Stores the given key-value pair.
static void	put(StorageContext context, byte[] key, long value) Stores the given key-value pair.
static void	put(StorageContext context, byte[] key, java.lang.String value) Stores the given key-value pair.
static void	put(StorageContext context, java.lang.String key, byte[] value) Stores the given key-value pair.
static void	put(StorageContext context, java.lang.String key, int value) Stores the given key-value pair.
static void	put(StorageContext context, java.lang.String key, long value) Stores the given key-value pair.
static void	put(StorageContext context, java.lang.String key, java.lang.String value) Stores the given key-value pair.
static void	put(java.lang.String key, byte[] value) Stores the given key-value pair.
static void	put(java.lang.String key, int value) Stores the given key-value pair.
static void	put(java.lang.String key, long value) Stores the given key-value pair.
static void	put(java.lang.String key, java.lang.String value) Stores the given key-value pair.
static void	putEx(byte[] key, byte[] value, byte storageFlag) Stores the given key-value pair using the given StorageFlags.
static void	putEx(byte[] key, int value, byte storageFlag) Stores the given key-value pair using the the given StorageFlags.
static void	putEx(byte[] key, long value, byte storageFlag) Stores the given key-value pair using the the given StorageFlags.
static void	putEx(byte[] key, java.lang.String value, byte storageFlag) Stores the given key-value pair using the the given StorageFlags.
static void	putEx(java.lang.String key, byte[] value, byte storageFlag) Stores the given key-value pair using the the given StorageFlags.
static void	putEx(java.lang.String key, int value, byte storageFlag) Stores the given key-value pair using the the given StorageFlags.
static void	putEx(java.lang.String key, long value, byte storageFlag) Stores the given key-value pair using the the given StorageFlags.
static void	putEx(java.lang.String key, java.lang.String value, byte storageFlag) Stores the given key-value pair using the the given StorageFlags.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Storage

public Storage()

Method Detail

getStorageContext

public static StorageContext getStorageContext()

Returns the storage context of the contract.

Returns:

the storage context.

getReadOnlyContext

public static StorageContext getReadOnlyContext()

Returns the storage context of the contract in read-only mode.

Returns:

the read-only storage context.

get

public static byte[] get(StorageContext context,
                         byte[] key)

Returns the value corresponding to the given key.

Parameters:

context - The storage context to search in.

key - The key to search for.

Returns:

the value corresponding to the given key.

get

public static byte[] get(StorageContext context,
                         java.lang.String key)

Returns the value corresponding to the given key.

Parameters:

context - The storage context to search in.

key - The key to search for.

Returns:

the value corresponding to the given key.

put

public static void put(StorageContext context,
                       byte[] key,
                       byte[] value)

Stores the given key-value pair.

Parameters:

context - The storage context to store the value in.

key - The key.

value - The value to store.

put

public static void put(StorageContext context,
                       byte[] key,
                       int value)

Stores the given key-value pair.

Parameters:

context - The storage context to store the value in.

key - The key.

value - The value to store.

put

public static void put(StorageContext context,
                       byte[] key,
                       long value)

Stores the given key-value pair.

Parameters:

context - The storage context to store the value in.

key - The key.

value - The value to store.

put

public static void put(StorageContext context,
                       byte[] key,
                       java.lang.String value)

Stores the given key-value pair.

Parameters:

context - The storage context to store the value in.

key - The key.

value - The value to store.

put

public static void put(StorageContext context,
                       java.lang.String key,
                       byte[] value)

Stores the given key-value pair.

Parameters:

context - The storage context to store the value in.

key - The key.

value - The value to store.

put

public static void put(StorageContext context,
                       java.lang.String key,
                       int value)

Stores the given key-value pair.

Parameters:

context - The storage context to store the value in.

key - The key.

value - The value to store.

put

public static void put(StorageContext context,
                       java.lang.String key,
                       long value)

Stores the given key-value pair.

Parameters:

context - The storage context to store the value in.

key - The key.

value - The value to store.

put

public static void put(StorageContext context,
                       java.lang.String key,
                       java.lang.String value)

Stores the given key-value pair.

Parameters:

context - The storage context to store the value in.

key - The key.

value - The value to store.

delete

public static void delete(StorageContext context,
                          byte[] key)

Deletes the value corresponding to the given key from the storage.

Parameters:

context - The storage context to delete from.

key - The key to delete.

delete

public static void delete(StorageContext context,
                          java.lang.String key)

Deletes the value corresponding to the given key from the storage.

Parameters:

context - The storage context to delete from.

key - The key to delete.

find

public static Iterator<byte[],byte[]> find(StorageContext context,
                                           byte[] prefix)

Returns an iterator over the values found under the given key prefix.

Parameters:

context - The storage context to get the values from.

prefix - The key prefix.

Returns:

an iterator over key-value pairs found under the given prefix.

find

public static Iterator<java.lang.String,byte[]> find(StorageContext context,
                                                     java.lang.String prefix)

Returns an iterator over the values found under the given key prefix.

Parameters:

context - The storage context to get the values from.

prefix - The key prefix.

Returns:

an iterator over key-value pairs found under the given prefix.

get

public static byte[] get(byte[] key)

Returns the value corresponding to the given key.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key to search for.

Returns:

the value corresponding to the given key.

get

public static byte[] get(java.lang.String key)

Returns the value corresponding to the given key.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key to search for.

Returns:

the value corresponding to the given key.

put

public static void put(byte[] key,
                       byte[] value)

Stores the given key-value pair.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

put

public static void put(byte[] key,
                       int value)

Stores the given key-value pair.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

put

public static void put(byte[] key,
                       long value)

Stores the given key-value pair.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

putEx

public static void putEx(byte[] key,
                         byte[] value,
                         byte storageFlag)

Stores the given key-value pair using the given StorageFlags.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

storageFlag - The storage flags to use.

putEx

public static void putEx(byte[] key,
                         int value,
                         byte storageFlag)

Stores the given key-value pair using the the given StorageFlags.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

storageFlag - The storage flags to use.

putEx

public static void putEx(byte[] key,
                         long value,
                         byte storageFlag)

Stores the given key-value pair using the the given StorageFlags.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

storageFlag - The storage flags to use.

put

public static void put(byte[] key,
                       java.lang.String value)

Stores the given key-value pair.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

putEx

public static void putEx(byte[] key,
                         java.lang.String value,
                         byte storageFlag)

Stores the given key-value pair using the the given StorageFlags.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

storageFlag - The storage flags to use.

put

public static void put(java.lang.String key,
                       byte[] value)

Stores the given key-value pair.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

putEx

public static void putEx(java.lang.String key,
                         byte[] value,
                         byte storageFlag)

Stores the given key-value pair using the the given StorageFlags.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

storageFlag - The storage flags to use.

putEx

public static void putEx(java.lang.String key,
                         int value,
                         byte storageFlag)

Stores the given key-value pair using the the given StorageFlags.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

storageFlag - The storage flags to use.

putEx

public static void putEx(java.lang.String key,
                         long value,
                         byte storageFlag)

Stores the given key-value pair using the the given StorageFlags.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

storageFlag - The storage flags to use.

put

public static void put(java.lang.String key,
                       int value)

Stores the given key-value pair.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

put

public static void put(java.lang.String key,
                       long value)

Stores the given key-value pair.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

put

public static void put(java.lang.String key,
                       java.lang.String value)

Stores the given key-value pair.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

putEx

public static void putEx(java.lang.String key,
                         java.lang.String value,
                         byte storageFlag)

Stores the given key-value pair using the the given StorageFlags.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key.

value - The value to store.

storageFlag - The storage flags to use.

delete

public static void delete(byte[] key)

Deletes the value corresponding to the given key from the storage.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key to delete.

delete

public static void delete(java.lang.String key)

Deletes the value corresponding to the given key from the storage.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

key - The key to delete.

find

public static Iterator<byte[],byte[]> find(byte[] prefix)

Returns an iterator over the values found under the given key prefix.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

prefix - The key prefix.

Returns:

an iterator over key-value pairs found under the given prefix.

find

public static Iterator<java.lang.String,byte[]> find(java.lang.String prefix)

Returns an iterator over the values found under the given key prefix.

Implicitly makes a Syscall to retrieve the current contract's storage context.

Parameters:

prefix - The key prefix.

Returns:

an iterator over key-value pairs found under the given prefix.