RewardAddress overview

Table of contents

• arbitrary
  • arbitrary
• model
  • RewardAddress (type alias)
• predicates
  • isRewardAddress
• schemas
  • RewardAddress

arbitrary

arbitrary

FastCheck arbitrary for generating random RewardAddress instances.

Signature

export declare const arbitrary: FastCheck.Arbitrary<string & Brand<"RewardAddress">>

Added in v2.0.0

model

RewardAddress (type alias)

Type representing a reward/stake address string in bech32 format

Signature

export type RewardAddress = typeof RewardAddress.Type

Added in v2.0.0

predicates

isRewardAddress

Check if the given value is a valid RewardAddress

Signature

export declare const isRewardAddress: (
  u: unknown,
  overrideOptions?: ParseOptions | number
) => u is string & Brand<"RewardAddress">

Added in v2.0.0

schemas

RewardAddress

Reward address format schema (human-readable addresses) Following CIP-0019 encoding requirements

Signature

export declare const RewardAddress: Schema.brand<Schema.filter<typeof Schema.String>, "RewardAddress">

Added in v2.0.0