Crate rusk_abi

Rusk ABI

The ABI to develop Dusk Network smart contracts

Modules

• arg_buf
• dusk
  Dusk denomination.

Structs

• ArchivedEvent
  An archived Event
• ArchivedRawCall
  An archived RawCall
• ArchivedRawResult
  An archived RawResult
• ArgbufWriter
  A small struct that can fmt::Write to the argument buffer.
• ContractId
  ID to identify the wasm contracts after they have been deployed
• ContractIdResolver
  The resolver for an archived ContractId
• Event
  And event emitted by a contract.
• EventResolver
  The resolver for an archived Event
• RawCall
  A RawCall is a contract call that doesn’t care about types and only operates on raw data.
• RawCallResolver
  The resolver for an archived RawCall
• RawResult
• RawResultResolver
  The resolver for an archived RawResult

Enums

• ArchivedContractError
  An archived ContractError
• ArchivedPaymentInfo
  An archived PaymentInfo
• ArchivedPublicInput
  An archived PublicInput
• ContractError
  The error possibly returned on an inter-contract-call.
• ContractErrorResolver
  The resolver for an archived ContractError
• PaymentInfo
  Enum representing all possible payment configurations.
• PaymentInfoResolver
  The resolver for an archived PaymentInfo
• PublicInput
  Enum that represents all possible types of public inputs
• PublicInputResolver
  The resolver for an archived PublicInput

Constants

• ARGBUF_LEN
  The size of the argument buffer in bytes
• CONTRACT_ID_BYTES
  The length of ContractId in bytes
• LICENSE_CONTRACT
  ID of the genesis license contract
• POSEIDON_TREE_DEPTH
  Constant depth of the merkle tree that provides the opening proofs.
• SCRATCH_BUF_BYTES
  How many bytes to use for scratch space when serializing
• STAKE_CONTRACT
  ID of the genesis stake contract
• TRANSCRIPT_LABEL
  Label used for the ZK transcript initialization. Must be the same for prover and verifier.
• TRANSFER_CONTRACT
  ID of the genesis transfer contract

Functions

• block_height
  Get the current block height.
• call
  Calls a contract’s fn_name function with the given argument fn_arg. The contract will have 93% of the remaining points available to spend.
• call_raw
  Calls a contract with the given RawCall. The contract will have 93% of the remaining points available to spend.
• call_raw_with_limit
  Calls a contract with the given RawCall allowing it to spend the given points_limit.
• call_with_limit
  Calls a contract’s fn_name function with the given argument fn_arg, allowing it to spend the given points_limit.
• caller
  Return the ID of the calling contract. The returned id will be uninitialized if there is no caller - meaning this is the first contract to be called.
• contract_to_scalar
  Converts a ContractId to a BlsScalar
• emit
  Emits an event with the given data.
• feed
  Feeds the host with data.
• gen_contract_id
  Generate a ContractId address from the given slice of bytes, that is also a valid BlsScalar
• hash
  Compute the blake2b hash of the given bytes, returning the resulting scalar. The output of the hasher is truncated (last nibble) to fit onto a scalar.
• host_query
  Execute some code that the host provides under the given name.
• limit
  Returns the points limit with which the contact was called.
• meta_data
  Returns data made available by the host under the given name. The type D must be correctly specified, otherwise undefined behavior will occur.
• owner
  Return the current contract’s owner.
• payment_info
  Query a contract for the types of payment it accepts.
• poseidon_hash
  Compute the poseidon hash of the given scalars
• self_id
  Return the current contract’s id.
• spent
  Returns the amount of points the contact has spent.
• verify_bls
  Verify a BLS signature is valid for the given public key and message
• verify_proof
  Verify a proof is valid for a given circuit type and public inputs
• verify_schnorr
  Verify a schnorr signature is valid for the given public key and message
• wrap_call
  Wrap a call with its respective (de)serializers.

Type Aliases

• StandardBufSerializer
  Type with rkyv serialization capabilities for specific types.