Module concordium_std::prims

This module provides the primitive interface to the chain. Functions here should be wrapped in safer wrappers when used from contracts. This module is provided for expert users who wish to optimize their smart contract to the utmost for space and size, and should not be used by the majority of users.

The functions in this module are inherently unsafe, and if preconditions that they state are not ensured then strange behaviour will occur. The behaviour is well-defined on the compiled Wasm by the semantics of the chain, but it is essentially impossible to predict since it is affected by memory layout decided by the compiler and the allocator, and other Rust implementation details. Consequences can range from accidental memory corruption to program termination.

Functions

get_init_origin^⚠

Address of the sender, 32 bytes

get_parameter_section^⚠

Write a section of the i-th parameter to the given location. Return the number of bytes written or -1 if the parameter does not exist. The location is assumed to contain enough memory to write the requested length into.

get_parameter_size^⚠

Get the size of the i-th parameter to the call. 0-th parameter is always the original parameter that the method was invoked with, invoking a contract adds additional parameters to the stack. Returns -1 if the given parameter does not exist.

get_policy_section^⚠

Write a section of the policy to the given location. Return the number of bytes written. The location is assumed to contain enough memory to write the requested length into.

get_receive_entrypoint^⚠

Write the receive entrypoint name into the given location. It is assumed that the location contains enough space to write the name.

get_receive_entrypoint_size^⚠

Get the size of the entrypoint that was named.

get_receive_invoker^⚠

Invoker of the top-level transaction, AccountAddress.

get_receive_owner^⚠

Owner of the contract, AccountAddress.

get_receive_self_address^⚠

Address of the contract itself, ContractAddress.

get_receive_self_balance^⚠

Self-balance of the contract, returns the amount

get_receive_sender^⚠

Immediate sender of the message (either contract or account).

get_slot_time^⚠

Slot time (in milliseconds) from chain meta data

hash_keccak_256^⚠

Hash the data using Keccak-256 algorithm. The resulting hash (32 bytes) is written starting at the output pointer. The output segment may overlap with the data segment.

hash_sha2_256^⚠

Hash the data using the SHA2-256 algorithm. The resulting hash (32 bytes) is written starting at the output pointer. The output segment may overlap with the data segment.

hash_sha3_256^⚠

Hash the data using the SHA3-256 algorithm. The resulting hash (32 bytes) is written starting at the output pointer. The output segment may overlap with the data segment.

invoke^⚠

Invoke a host instruction. The arguments are

log_event^⚠

Add a log item. Return values are

state_create_entry^⚠

Create an empty entry with the given key. The return value is either u64::MAX if creating the entry failed because of an iterator lock on the part of the tree, or else the first bit is 0, and the remaining bits are an entry identifier that maybe used in subsequent calls. If an entry at that key already exists it is set to the empty entry.

state_delete_entry^⚠

Delete the entry. Returns one of

state_delete_prefix^⚠

Delete a prefix in the tree, that is, delete all parts of the tree that have the given key as prefix. Returns

state_entry_read^⚠

Read a part of the entry. The arguments are entry … entry id returned by state_iterator_next or state_create_entry start … where to write in Wasm memory length … length of the data to read offset … where to start reading in the entry The return value is

state_entry_resize^⚠

Resize the entry to the given size. Returns

state_entry_size^⚠

Return the current size of the entry in bytes. The return value is either

state_entry_write^⚠

Write a part of the entry. The arguments are entry … entry id returned by state_iterator_next or state_create_entry start … where to read from Wasm memory length … length of the data to read offset … where to start writing in the entry The return value is

state_iterate_prefix^⚠

Construct an iterator over a part of the tree. This locks the part of the tree that has the given prefix. Locking means that no deletions or insertions of entries may occur in that subtree. Returns

state_iterator_delete^⚠

Delete the iterator, unlocking the subtree. Returns

state_iterator_key_read^⚠

Read a section of the key the iterator is currently pointing at. Returns either

state_iterator_key_size^⚠

Get the size of the key that the iterator is currently pointing at. Returns

state_iterator_next^⚠

Return the next entry along the iterator, and advance the iterator. The return value is

state_lookup_entry^⚠

Lookup an entry with the given key. The return value is either u64::MAX if the entry at the given key does not exist, or else the first bit of the result is 0, and the remaining bits are an entry identifier that may be used in subsequent calls.

verify_ecdsa_secp256k1_signature^⚠

Verify an ecdsa over secp256k1 with bitcoin-core implementation. The public key is expected to be 33 bytes, the signature is expected to be 64 bytes (serialized in compressed format), and the message must be 32 bytes. We only allow checking signatures on 32-byte arrays which are expected to be message hashes.

verify_ed25519_signature^⚠

Verify an ed25519 signature. The public key is expected to be 32 bytes, the signature is expected to be 64 bytes, and the message may be variable length.

write_output^⚠

Write to the return value of the contract. The parameters are