Crate ergo

Expand description

C bindings for ergo-lib

Macros

ergo-lib uses a number of collection types that are simple wrappers around Vec. We have a generic type for such a collection in ergo-lib-c-core::collections::Collection. A limitation of cbindgen is that it cannot process generic functions. This macro generates a C-compatible interface for such a collection for any desired type T.

make_ffi_eq

Generates an equality function for FFI

Structs

Address

Address wrapper

ReturnBool

Convenience type to allow us to pass Rust bools (with possible error) through FFI to the C side.

ReturnNum

Convenience type to allow us to pass Rust enums with u8 representation through FFI to the C side.

ReturnOption

Convenience type to allow us to pass Rust Option<_> types through FFI to C side.

ReturnString

Convenience type to allow us to pass Rust CStrings through FFI to C side (as pointers). Note it is the responsibility of the caller to free the Rust CString. For an example, see MnemonicGenerator in the Swift bindings.

Enums

AddressTypePrefix

Error

NetworkPrefix

Network type

Traits

IntegerType

Functions

delete_ptr^⚠

ergo_lib_address_delete^⚠

ergo_lib_address_from_base58^⚠

ergo_lib_address_from_ergo_tree^⚠

ergo_lib_address_from_mainnet^⚠

ergo_lib_address_from_testnet^⚠

ergo_lib_address_to_base58^⚠

ergo_lib_address_type_prefix^⚠

ergo_lib_batch_merkle_proof_delete^⚠

ergo_lib_batch_merkle_proof_from_json^⚠

ergo_lib_batch_merkle_proof_to_json^⚠

Serializes a BatchMerkleProof to json representation

ergo_lib_batch_merkle_proof_valid^⚠

ergo_lib_block_header_delete^⚠

Delete BlockHeader

ergo_lib_block_header_eq^⚠

ergo_lib_block_header_from_json^⚠

Parse BlockHeader array from JSON (Node API)

ergo_lib_block_header_id^⚠

Get BlockHeaders id

ergo_lib_block_header_transactions_root^⚠

Copy the contents of transactions_root field to output. Key assumption: exactly 32 bytes of memory have been allocated at the address pointed-to by output.

ergo_lib_block_headers_add^⚠

Add an element to collection

ergo_lib_block_headers_delete^⚠

Delete an existing collection

ergo_lib_block_headers_get^⚠

Returns element at position index of an existing collection

ergo_lib_block_headers_len^⚠

Returns length of an existing collection

ergo_lib_block_headers_new^⚠

Create a new empty collection

ergo_lib_block_id_delete^⚠

Delete BlockId

ergo_lib_block_id_eq^⚠

ergo_lib_block_id_from_str^⚠

Convert a hex string into a BlockId

ergo_lib_block_ids_add^⚠

Add an element to collection

ergo_lib_block_ids_delete^⚠

Delete an existing collection

ergo_lib_block_ids_get^⚠

Returns element at position index of an existing collection

ergo_lib_block_ids_len^⚠

Returns length of an existing collection

ergo_lib_block_ids_new^⚠

Create a new empty collection

ergo_lib_box_id_delete^⚠

Drop BoxId

ergo_lib_box_id_eq^⚠

ergo_lib_box_id_from_str^⚠

Parse box id (32 byte digest) from base16-encoded string

ergo_lib_box_id_to_bytes^⚠

Returns byte array (32 bytes) Note: it’s imperative that output points to a valid block of memory of 32 bytes.

ergo_lib_box_id_to_str^⚠

Base16 encoded string

ergo_lib_box_selection_boxes^⚠

Selected boxes to spend as transaction inputs

ergo_lib_box_selection_change^⚠

Selected boxes to use as change

ergo_lib_box_selection_delete^⚠

Drop BoxSelection

ergo_lib_box_selection_eq^⚠

ergo_lib_box_selection_new^⚠

Create a selection to easily inject custom selection algorithms

ergo_lib_box_value_as_i64^⚠

Get value as signed 64-bit long

ergo_lib_box_value_delete^⚠

Drop BoxValue

ergo_lib_box_value_eq^⚠

ergo_lib_box_value_from_i64^⚠

Create from i64 with bounds check

ergo_lib_box_value_safe_user_min^⚠

Recommended (safe) minimal box value to use in case box size estimation is unavailable. Allows box size upto 2777 bytes with current min box value per byte of 360 nanoERGs

ergo_lib_box_value_sum_of^⚠

Create a new box value which is the sum of the arguments, with bounds check.

ergo_lib_box_value_units_per_ergo

Number of units inside one ERGO (i.e. one ERG using nano ERG representation)

ergo_lib_byte_array_delete^⚠

ergo_lib_byte_array_from_raw_parts^⚠

ergo_lib_byte_arrays_add^⚠

Add an element to collection

ergo_lib_byte_arrays_delete^⚠

Delete an existing collection

ergo_lib_byte_arrays_get^⚠

Returns element at position index of an existing collection

ergo_lib_byte_arrays_len^⚠

Returns length of an existing collection

ergo_lib_byte_arrays_new^⚠

Create a new empty collection

ergo_lib_commitment_hint_delete^⚠

Drop CommitmentHint

ergo_lib_context_extension_delete^⚠

Drop ContextExtension

ergo_lib_context_extension_empty^⚠

Create new empty ContextExtension instance

ergo_lib_context_extension_keys^⚠

Returns all keys (represented as u8 values) in the map

ergo_lib_context_extension_len^⚠

Returns the number of elements in the collection

ergo_lib_contract_compile^⚠

Compiles a contract from ErgoScript source code

ergo_lib_contract_delete^⚠

Drop Contract

ergo_lib_contract_eq^⚠

ergo_lib_contract_ergo_tree^⚠

Get the ErgoTree of the contract

ergo_lib_contract_new^⚠

Create new contract from ErgoTree

ergo_lib_contract_pay_to_address^⚠

Create new contract that allow spending of the guarded box by a given recipient

ergo_lib_data_input_box_id^⚠

Get box id

ergo_lib_data_input_delete^⚠

Drop DataInput

ergo_lib_data_input_new^⚠

Parse box id (32 byte digest)

ergo_lib_data_inputs_add^⚠

Add an element to collection

ergo_lib_data_inputs_delete^⚠

Delete an existing collection

ergo_lib_data_inputs_get^⚠

Returns element at position index of an existing collection

ergo_lib_data_inputs_len^⚠

Returns length of an existing collection

ergo_lib_data_inputs_new^⚠

Create a new empty collection

ergo_lib_delete_error^⚠

ergo_lib_delete_string^⚠

ergo_lib_ergo_box_assets_data_delete^⚠

Drop ErgoBoxAssetsData

ergo_lib_ergo_box_assets_data_eq^⚠

ergo_lib_ergo_box_assets_data_list_add^⚠

Add an element to collection

ergo_lib_ergo_box_assets_data_list_delete^⚠

Delete an existing collection

ergo_lib_ergo_box_assets_data_list_get^⚠

Returns element at position index of an existing collection

ergo_lib_ergo_box_assets_data_list_len^⚠

Returns length of an existing collection

ergo_lib_ergo_box_assets_data_list_new^⚠

Create a new empty collection

ergo_lib_ergo_box_assets_data_new^⚠

Create new instance

ergo_lib_ergo_box_assets_data_tokens^⚠

Tokens part of the box

ergo_lib_ergo_box_assets_data_value^⚠

Value part of the box

ergo_lib_ergo_box_candidate_box_value^⚠

Get box value in nanoERGs

ergo_lib_ergo_box_candidate_builder_add_token^⚠

Add given token id and token amount

ergo_lib_ergo_box_candidate_builder_build^⚠

Build the box candidate

ergo_lib_ergo_box_candidate_builder_calc_box_size_bytes^⚠

Calculate serialized box size(in bytes)

ergo_lib_ergo_box_candidate_builder_delete^⚠

Drop ErgoBoxCandidateBuilder

ergo_lib_ergo_box_candidate_builder_delete_register_value^⚠

Delete register value(make register empty) for the given register id (R4-R9)

ergo_lib_ergo_box_candidate_builder_min_box_value_per_byte^⚠

Get minimal value (per byte of the serialized box size)

ergo_lib_ergo_box_candidate_builder_mint_token^⚠

Mint token, as defined in https://github.com/ergoplatform/eips/blob/master/eip-0004.md token - token id(box id of the first input box in transaction) and token amount, token_name - token name (will be encoded in R4), token_desc - token description (will be encoded in R5), num_decimals - number of decimals (will be encoded in R6)

ergo_lib_ergo_box_candidate_builder_new^⚠

Create builder with required box parameters: value - amount of money associated with the box contract - guarding contract, which should be evaluated to true in order to open(spend) this box creation_height - height when a transaction containing the box is created. It should not exceed height of the block, containing the transaction with this box.

ergo_lib_ergo_box_candidate_builder_register_value^⚠

Returns register value for the given register id (R4-R9), or None if the register is empty

ergo_lib_ergo_box_candidate_builder_set_min_box_value_per_byte^⚠

Set minimal value (per byte of the serialized box size)

ergo_lib_ergo_box_candidate_builder_set_register_value^⚠

Set register with a given id (R4-R9) to the given value

ergo_lib_ergo_box_candidate_builder_set_value^⚠

Set new box value

ergo_lib_ergo_box_candidate_builder_value^⚠

Get box value

ergo_lib_ergo_box_candidate_calc_min_box_value^⚠

Calculate minimal box value for the current box serialized size(in bytes)

ergo_lib_ergo_box_candidate_creation_height^⚠

Get box creation height

ergo_lib_ergo_box_candidate_delete^⚠

Drop ErgoBoxCandidate

ergo_lib_ergo_box_candidate_eq^⚠

ergo_lib_ergo_box_candidate_ergo_tree^⚠

Get ergo tree for box

ergo_lib_ergo_box_candidate_register_value^⚠

Returns value (ErgoTree constant) stored in the register or None if the register is empty

ergo_lib_ergo_box_candidate_tokens^⚠

Get tokens for box

ergo_lib_ergo_box_candidates_add^⚠

Add an element to collection

ergo_lib_ergo_box_candidates_delete^⚠

Delete an existing collection

ergo_lib_ergo_box_candidates_get^⚠

Returns element at position index of an existing collection

ergo_lib_ergo_box_candidates_len^⚠

Returns length of an existing collection

ergo_lib_ergo_box_candidates_new^⚠

Create a new empty collection

ergo_lib_ergo_box_creation_height^⚠

Get box creation height

ergo_lib_ergo_box_delete^⚠

Drop ErgoBox

ergo_lib_ergo_box_eq^⚠

ergo_lib_ergo_box_ergo_tree^⚠

Get ergo tree for box

ergo_lib_ergo_box_from_json^⚠

Parse from JSON. Supports Ergo Node/Explorer API and box values and token amount encoded as strings

ergo_lib_ergo_box_id^⚠

Get box id

ergo_lib_ergo_box_new^⚠

Make a new box with: value - amount of money associated with the box contract - guarding contract, which should be evaluated to true in order to open(spend) this box creation_height - height when a transaction containing the box is created. tx_id - transaction id in which this box was “created” (participated in outputs) index - index (in outputs) in the transaction

ergo_lib_ergo_box_register_value^⚠

Returns value (ErgoTree constant) stored in the register or None if the register is empty

ergo_lib_ergo_box_to_json^⚠

JSON representation as text (compatible with Ergo Node/Explorer API, numbers are encoded as numbers)

ergo_lib_ergo_box_to_json_eip12^⚠

JSON representation according to EIP-12 https://github.com/ergoplatform/eips/pull/23

ergo_lib_ergo_box_tokens^⚠

Get tokens for box

ergo_lib_ergo_box_value^⚠

Get box value in nanoERGs

ergo_lib_ergo_boxes_add^⚠

Add an element to collection

ergo_lib_ergo_boxes_delete^⚠

Delete an existing collection

ergo_lib_ergo_boxes_get^⚠

Returns element at position index of an existing collection

ergo_lib_ergo_boxes_len^⚠

Returns length of an existing collection

ergo_lib_ergo_boxes_new^⚠

Create a new empty collection

ergo_lib_ergo_state_context_delete^⚠

ergo_lib_ergo_state_context_eq^⚠

ergo_lib_ergo_state_context_new^⚠

Create new context from pre-header

ergo_lib_ergo_tree_bytes_len^⚠

Determine number of bytes of the serialized ErgoTree

ergo_lib_ergo_tree_constants_len^⚠

Get constants number as stored in serialized ErgoTree or error if the parsing of constants is failed

ergo_lib_ergo_tree_delete^⚠

Drop ErgoTree

ergo_lib_ergo_tree_eq^⚠

ergo_lib_ergo_tree_from_base16_bytes^⚠

Decode from base16 encoded serialized ErgoTree

ergo_lib_ergo_tree_from_bytes^⚠

Decode from encoded serialized ErgoTree

ergo_lib_ergo_tree_get_constant^⚠

Returns constant with given index (as stored in serialized ErgoTree) or None if index is out of bounds or error if constants parsing were failed

ergo_lib_ergo_tree_template_bytes^⚠

Serialized proposition expression of SigmaProp type with ConstantPlaceholder nodes instead of Constant nodes. Key assumption: enough memory has been allocated at the address pointed-to by output. Use ergo_lib_ergo_tree_template_bytes_len to determine the length of the byte array.

ergo_lib_ergo_tree_template_bytes_len^⚠

Returns the number of bytes of the Serialized proposition expression of SigmaProp type with ConstantPlaceholder nodes instead of Constant nodes.

ergo_lib_ergo_tree_to_base16_bytes^⚠

Get Base16-encoded serialized bytes

ergo_lib_ergo_tree_to_bytes^⚠

Convert to serialized bytes. Key assumption: enough memory has been allocated at the address pointed-to by output. Use ergo_lib_ergo_tree_bytes_len to determine the length of the byte array.

ergo_lib_ergo_tree_with_constant^⚠

Returns new ErgoTree instance with a new constant value for a given index in constants list (as stored in serialized ErgoTree), or an error. Note that the original ErgoTree instance pointed-at by ergo_tree_ptr is untouched.

ergo_lib_error_to_string^⚠

ergo_lib_hints_bag_add_commitment^⚠

Add commitment hint to the bag

ergo_lib_hints_bag_delete^⚠

Drop HintsBag

ergo_lib_hints_bag_empty^⚠

Empty HintsBag

ergo_lib_hints_bag_get^⚠

Get commitment

ergo_lib_hints_bag_len^⚠

Length of HintsBag

ergo_lib_input_box_id^⚠

Get box id

ergo_lib_input_delete^⚠

Drop Input

ergo_lib_input_spending_proof^⚠

Get spending proof

ergo_lib_inputs_add^⚠

Add an element to collection

ergo_lib_inputs_delete^⚠

Delete an existing collection

ergo_lib_inputs_get^⚠

Returns element at position index of an existing collection

ergo_lib_inputs_len^⚠

Returns length of an existing collection

ergo_lib_inputs_new^⚠

Create a new empty collection

ergo_lib_mnemonic_generator^⚠

Create new MnemonicGenerator instance

ergo_lib_mnemonic_generator_free_mnemonic^⚠

Free a previously-created CString. Intended to be paired with one of the mnemonic generation functions. Called by the client.

ergo_lib_mnemonic_generator_generate^⚠

Generate mnemonic sentence using random entropy

ergo_lib_mnemonic_generator_generate_from_entropy^⚠

Generate mnemonic sentence using provided entropy

ergo_lib_nipopow_proof_delete^⚠

Delete NipopowProof

ergo_lib_nipopow_proof_from_json^⚠

Parse from JSON.

ergo_lib_nipopow_proof_is_better_than^⚠

Implementation of the ≥ algorithm from KMZ17, see Algorithm 4

ergo_lib_nipopow_proof_suffix_head^⚠

Get suffix head

ergo_lib_nipopow_proof_to_json^⚠

JSON representation as text

ergo_lib_nipopow_verifier_best_chain^⚠

Returns chain of BlockHeaders from the best proof.

ergo_lib_nipopow_verifier_best_proof^⚠

Returns the best proof.

ergo_lib_nipopow_verifier_delete^⚠

Delete NipopowVerifier

ergo_lib_nipopow_verifier_new^⚠

Create new NipopowVerifier instance

ergo_lib_nipopow_verifier_process^⚠

Process given proof

ergo_lib_po_pow_header_eq^⚠

ergo_lib_popow_header_check_interlinks_proof^⚠

ergo_lib_popow_header_delete^⚠

ergo_lib_popow_header_from_json^⚠

ergo_lib_popow_header_get_header^⚠

ergo_lib_popow_header_get_interlinks^⚠

ergo_lib_popow_header_get_interlinks_proof^⚠

ergo_lib_popow_header_to_json^⚠

ergo_lib_pre_header_eq^⚠

ergo_lib_preheader_delete^⚠

Drop PreHeader

ergo_lib_preheader_from_block_header^⚠

Create instance using data from block header

ergo_lib_propositions_add_proposition_from_bytes^⚠

Adding new proposition

ergo_lib_propositions_delete^⚠

Drop Propositions

ergo_lib_propositions_new^⚠

Create empty proposition holder

ergo_lib_prover_result_context_extension^⚠

Get extension

ergo_lib_prover_result_delete^⚠

Drop ProverResult

ergo_lib_prover_result_proof^⚠

Get proof. Key assumption: enough memory has been allocated at the address pointed-to by output. Use ergo_lib_prover_result_proof_len to determine the length of the byte array.

ergo_lib_prover_result_proof_len^⚠

Return the number of bytes that make up the proof.

ergo_lib_prover_result_to_json^⚠

JSON representation as text (compatible with Ergo Node/Explorer API, numbers are encoded as numbers)

ergo_lib_reduced_tx_delete^⚠

Drop ReducedTransaction

ergo_lib_reduced_tx_from_unsigned_tx^⚠

Returns reduced transaction, i.e. unsigned transaction where each unsigned input is augmented with ReducedInput which contains a script reduction result.

ergo_lib_reduced_tx_unsigned_tx^⚠

Returns the unsigned transation

ergo_lib_secret_key_delete^⚠

Drop SecretKey

ergo_lib_secret_key_from_bytes^⚠

Parse dlog secret key from bytes (SEC-1-encoded scalar)

ergo_lib_secret_key_generate_random^⚠

Generate random key

ergo_lib_secret_key_get_address^⚠

Address (encoded public image)

ergo_lib_secret_key_to_bytes^⚠

Encode from a serialized key. Key assumption: 32 bytes must be allocated at the address pointed-to by output.

ergo_lib_secret_keys_add^⚠

Add an element to collection

ergo_lib_secret_keys_delete^⚠

Delete an existing collection

ergo_lib_secret_keys_get^⚠

Returns element at position index of an existing collection

ergo_lib_secret_keys_len^⚠

Returns length of an existing collection

ergo_lib_secret_keys_new^⚠

Create a new empty collection

ergo_lib_signed_message_delete^⚠

Drop SignedMessage

ergo_lib_simple_box_selector_delete^⚠

Drop SimpleBoxSelector

ergo_lib_simple_box_selector_new^⚠

Naive box selector, collects inputs until target balance is reached

ergo_lib_simple_box_selector_select^⚠

Selects inputs to satisfy target balance and tokens. inputs - available inputs (returns an error, if empty), target_balance - coins (in nanoERGs) needed, target_tokens - amount of tokens needed. Returns selected inputs and box assets(value+tokens) with change.

ergo_lib_token_amount_as_i64^⚠

Get value as signed 64-bit long

ergo_lib_token_amount_delete^⚠

Drop TokenAmount

ergo_lib_token_amount_eq^⚠

ergo_lib_token_amount_from_i64^⚠

Create from i64 with bounds check

ergo_lib_token_delete^⚠

Drop Token

ergo_lib_token_eq^⚠

ergo_lib_token_get_amount^⚠

Get token amount

ergo_lib_token_get_id^⚠

Get token id

ergo_lib_token_id_delete^⚠

Drop TokenId

ergo_lib_token_id_eq^⚠

ergo_lib_token_id_from_box_id^⚠

Create token id from ergo box id (32 byte digest)

ergo_lib_token_id_from_str^⚠

Parse token id (32 byte digest) from base16-encoded string

ergo_lib_token_id_to_str^⚠

Base16 encoded string

ergo_lib_token_new^⚠

Create a token with given token id and amount

ergo_lib_token_to_json_eip12^⚠

JSON representation according to EIP-12 https://github.com/ergoplatform/eips/pull/23

ergo_lib_tokens_add^⚠

Add an element to collection

ergo_lib_tokens_delete^⚠

Delete an existing collection

ergo_lib_tokens_get^⚠

Returns element at position index of an existing collection

ergo_lib_tokens_len^⚠

Returns length of an existing collection

ergo_lib_tokens_new^⚠

Create a new empty collection

ergo_lib_transaction_extract_hints^⚠

Extract hints from signed transaction

ergo_lib_transaction_hints_bag_add_hints_for_input^⚠

Adding hints for input

ergo_lib_transaction_hints_bag_all_hints_for_input^⚠

Get HintsBag corresponding to input index

ergo_lib_transaction_hints_bag_delete^⚠

Drop TransactionHintsBag

ergo_lib_transaction_hints_bag_empty^⚠

Empty TransactionHintsBag

ergo_lib_tx_builder_box_selection^⚠

Get box selection

ergo_lib_tx_builder_build^⚠

Build the unsigned transaction

ergo_lib_tx_builder_change_address^⚠

Get change address

ergo_lib_tx_builder_current_height^⚠

Get current height

ergo_lib_tx_builder_data_inputs^⚠

Get data inputs

ergo_lib_tx_builder_delete^⚠

Drop TxBuilder

ergo_lib_tx_builder_fee_amount^⚠

Get fee amount

ergo_lib_tx_builder_new^⚠

Creates new TxBuilder box_selection - selected input boxes output_candidates - output boxes to be “created” in this transaction, current_height - chain height that will be used in additionally created boxes (change, miner’s fee, etc.), fee_amount - miner’s fee, change_address - change (inputs - outputs) will be sent to this address, will be given to miners,

ergo_lib_tx_builder_output_candidates^⚠

Get outputs EXCLUDING fee and change

ergo_lib_tx_builder_set_context_extension^⚠

Set context extension for a given input

ergo_lib_tx_builder_set_data_inputs^⚠

Set transaction’s data inputs

ergo_lib_tx_builder_set_token_burn_permit^⚠

Permits the burn of the given token amount, i.e. allows this token amount to be omitted in the outputs

ergo_lib_tx_builder_suggested_tx_fee^⚠

Suggested transaction fee (semi-default value used across wallets and dApps as of Oct 2020)

ergo_lib_tx_data_inputs^⚠

ergo_lib_tx_delete^⚠

Drop Transaction

ergo_lib_tx_from_json^⚠

Parse from JSON. Supports Ergo Node/Explorer API and box values and token amount encoded as strings

ergo_lib_tx_from_unsigned_tx^⚠

Create Transaction from UnsignedTransaction and an array of proofs in the same order as UnsignedTransaction.inputs with empty proof indicated with empty byte array

ergo_lib_tx_id^⚠

Get id for transaction

ergo_lib_tx_id_delete^⚠

Drop TxId

ergo_lib_tx_id_eq^⚠

ergo_lib_tx_id_from_str^⚠

Convert a hex string into a TxId

ergo_lib_tx_id_to_str^⚠

Get the tx id as bytes

ergo_lib_tx_inputs^⚠

ergo_lib_tx_output_candidates^⚠

ergo_lib_tx_outputs^⚠