cardano namespace

The root namespace for all Cardano functions and types.

Namespaces

namespace allegra: Allegra era ledger types.
namespace alonzo: Alonzo era ledger types.
namespace babbage: Babbage era ledger types.
namespace bip32_ed25519: Root namespace for the BIP32-Ed25519 key classes.
namespace ed25519: Root namespace for the Ed25519 classes.
namespace shelley: Shelley era ledger types.
namespace stake_pool: The namespace containing all Cardano Stake Pool objects.
namespace util: Utility namespace.

Classes

struct ArraySerializable: Virtual struct defining CBOR array serializability.
class BASE16: A static class to encode and decode bytes to and from hex strings.
class BASE58: A static class to encode and decode bytes to and from base58.
class BECH32: A static class to encode and decode bytes to and from Bech32 format.
struct BIP39Dictionary: A dictionary of 2048 BIP39 words.
class BaseAddress: A Cardano base address object.
class ByronAddress: A Cardano Byron era address object.
class ChainPointer: A Cardano chain pointer object.
class EnterpriseAddress: A Cardano enterprise address object.
class IShelleyAddress: Interface class for all Shelley era addresses.
class ITransactionBuilder: Interface for all transaction builders to implement.
struct KesDepth: Structure that represents the depth of the binary tree.
class KesPublicKey
struct KesSeed: Utilities for the Seed of a KES scheme.
struct MapSerializable: Virtual struct defining CBOR map serializability.
class Mnemonic: Represents a BIP39 mnemonic phrase.
struct Rational: Represent a rational number (numerator and denominator).
class RewardsAddress: A Cardano rewards address object.
template <size_t Depth> class SumKesCompactSignature: KES signature in compact form.
template <size_t Depth> class SumKesPrivateKey: KES private key based on the sum composition.
template <size_t Depth> class SumKesSignature: KES Signature.
struct TagSerializable: Virtual struct defining CBOR tagged item serializability.
class VRFPublicKey: Represents a VRF public key.
class VRFSecretKey: Represents a VRF secret key.

Concepts

template <auto Value> concept KesDepth0: Restrain depth to zero.
template <auto Value> concept KesDepthN0: Restrain depth to non-zero.
template <auto Value> concept KesValidDepth: Define a concept for non-type unsigned integer values up to MAX_KES_DEPTH.

Enums

enum class BIP39Language { ChineseSimplified, ChineseTraditional, Czech, English, French, Italian, Japanese, Korean, Portuguese, Spanish }: An enumeration of the BIP39 word dictionaries languages.
enum class Era { Byron, Shelley, Allegra, Mary, Alonzo, Babbage, Conway }: Enum to represent the various Cardano ledger eras.
enum class NetworkID { mainnet, testnet }: An enum representing the network ID of a Cardano address.

Typedefs

using TransactionIndex = uint16_t: Transaction index.
using VRFKeyByteArray = SecureByteArray<VRF_SECRET_KEY_SIZE>: Represent a VRF key as a secure byte array.

Variables

static size_t KEY_HASH_LENGTH constexpr: The length of a key hash used for an address.
size_t MAX_KES_DEPTH constexpr: Maxium supported KES depth.

Typedef documentation

using cardano::TransactionIndex = uint16_t

Transaction index.

transaction_index = uint .size 2