StakeAddress

Wrapper for Cardano stake address bytes. An StakeAddress consists of two parts internally:

Stake addresses are used to query the assets held by given staking credentials.

Constructor

new helios.StakeAddress(bytes: []number)

Static methods

fromAddress

Convert a regular Address into a StakeAddress. Throws an error if the Address doesn't have a staking credential.

helios.StakeAddress.fromAddress(address: helios.Address): helios.StakeAddress

fromCbor

Deserializes bytes into an StakeAddress.

helios.StakeAddress.fromCbor(bytes: []number): helios.StakeAddress

fromBech32

Converts a Bech32 string into an StakeAddress:

helios.StakeAddress.fromBech32(str: string): helios.StakeAddress

fromHash

Converts a StakeKeyHash or StakingValidatorHash into StakeAddress.

helios.StakeAddress.fromHash(
    isTestnet: boolean,
    hash: helios.StakeKeyHash | helios.StakingValidatorHash
)

Note: bech32 encoded stake addresses have a "stake" or "stake_test" prefix.

fromHex

Constructs a StakeAddress using a hexadecimal string representation of the address bytes.

helios.StakeAddress.fromHex(hex: string): helios.StakeAddress

isForTestnet

Returns true if the given StakeAddress is a testnet address.

helios.StakeAddress.isForTestnet(
    stake_address: helios.StakeAddress
): boolean

Getters

stakingHash

Returns the underlying StakeKeyHash](./stakekeyhash.md) or [StakingValidatorHash`.

stake_address.stakingHash: (helios.StakeKeyHash | helios.StakingValidatorHash)

Methods

toBech32

Turns a StakeAddress into its Bech32 representation.

stake_address.toBech32(): string

toCbor

Turns a StakeAddress into its CBOR representation.

stake_address.toCbor(): number[]

toHex

Turns a StakeAddress into its hexadecimal representation.

stake_address.toHex(): string