diff --git a/typescript/index.html b/typescript/index.html index aa197b60..9c76e1c5 100644 --- a/typescript/index.html +++ b/typescript/index.html @@ -1,27 +1,27 @@ cardano-addresses
Options
All
  • Public
  • Public/Protected
  • All
Menu

cardano-addresses

This module is a TypeScript/JavaScript binding for the cardano-addresses package.

-

Index

Interfaces

Type aliases

Functions

Type aliases

Address

Address: string
+

Index

Interfaces

Type aliases

Functions

Type aliases

Address

Address: string

A Cardano address, encoded as bech32, base58, or hexadecimal.

-

AddressStyle

AddressStyle: "Shelley" | "Icarus" | "Byron"
+

AddressStyle

AddressStyle: "Shelley" | "Icarus" | "Byron"

Supported address formats for the Cardano Shelley era.

-

Bytes

Bytes: string
+

Bytes

Bytes: string

Hex-encoded bytes.

TODO: what's the best way of representing bytestrings in TypeScript?

-

InspectAddress

InspectAddress: InspectAddressShelley | InspectAddressIcarus | InspectAddressByron
+

InspectAddress

InspectAddress: InspectAddressShelley | InspectAddressIcarus | InspectAddressByron

The return value of inspectAddress.

-

KeyHash

KeyHash: Bytes
+

KeyHash

KeyHash: Bytes

Verification key hash.

-

ScriptHash

ScriptHash: Bytes
+

ScriptHash

ScriptHash: Bytes

Hash of a script.

-

StakeReference

StakeReference: "none" | "by value" | "by pointer"
+

StakeReference

StakeReference: "none" | "by value" | "by pointer"

How the stake at this address will be delegated.

-

XPub

XPub: string
+

XPub

XPub: string

A bech32-encoded extended public key.

TODO: Add proper XPub type, which is the result of bech32 parsing a string.

-

Functions

inspectAddress

  • inspectAddress(address: string, rootXPub?: string): Promise<InspectAddress>

Functions

inspectAddress

  • inspectAddress(address: string, rootXPub?: string): Promise<InspectAddress>

  • Get information about a Cardano address. Three address formats are supported: Shelley, Icarus, and Byron.

    If the address can't be parsed, the promise will be rejected with @@ -33,5 +33,5 @@ key. This only applies to Byron addresses, and is for decrypting the InspectAddressByron.payload field.

Returns Promise<InspectAddress>

The fields parsed from the address.

-

version

  • version(): Promise<string>

version

  • version(): Promise<string>

Generated using TypeDoc

\ No newline at end of file diff --git a/typescript/interfaces/ChainPointer.html b/typescript/interfaces/ChainPointer.html index 2087ab78..98f9499a 100644 --- a/typescript/interfaces/ChainPointer.html +++ b/typescript/interfaces/ChainPointer.html @@ -1,3 +1,3 @@ ChainPointer | cardano-addresses
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ChainPointer

A stake reference pointer.

-

Hierarchy

  • ChainPointer

Index

Properties

Properties

output_index

output_index: number

slot_num

slot_num: number

transaction_index

transaction_index: number

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

output_index

output_index: number

slot_num

slot_num: number

transaction_index

transaction_index: number

Generated using TypeDoc

\ No newline at end of file diff --git a/typescript/interfaces/ErrInspectAddress.html b/typescript/interfaces/ErrInspectAddress.html index 80d25329..da6cf005 100644 --- a/typescript/interfaces/ErrInspectAddress.html +++ b/typescript/interfaces/ErrInspectAddress.html @@ -1,3 +1,3 @@ ErrInspectAddress | cardano-addresses
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ErrInspectAddress

Represents a failure to decode the given address.

-

Hierarchy

  • ErrInspectAddress

Index

Properties

Properties

error

error: { code: string; details?: unknown }

Type declaration

  • code: string
  • Optional details?: unknown

message

message: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

error

error: { code: string; details?: unknown }

Type declaration

  • code: string
  • Optional details?: unknown

message

message: string

Generated using TypeDoc

\ No newline at end of file diff --git a/typescript/interfaces/InspectAddressByron.html b/typescript/interfaces/InspectAddressByron.html index e7dd9ab8..c4fa4607 100644 --- a/typescript/interfaces/InspectAddressByron.html +++ b/typescript/interfaces/InspectAddressByron.html @@ -1,12 +1,12 @@ InspectAddressByron | cardano-addresses
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InspectAddressByron

Corresponds to Cardano.Address.Style.Byron.AddressInfo.

-

Hierarchy

  • InspectAddressByron

Index

Properties

Properties

address_root

address_root: string
+

Hierarchy

  • InspectAddressByron

Index

Properties

Properties

address_root

address_root: string

Hex-encoded address payload

-

address_style

address_style: "Byron"

address_type

address_type: number
+

address_style

address_style: "Byron"

address_type

address_type: number

Numeric address type field.

-

Optional network_tag

network_tag?: number
+

Optional network_tag

network_tag?: number

Which network the address belongs to. Unset for mainnet.

-

payload

payload: string | { account_index: number; address_index: number }
+

payload

payload: string | { account_index: number; address_index: number }

Heirarchical derivation payload. If a root XPub is provided, the derivation indices are decrypted. Otherwise, it will be the encrypted payload.

diff --git a/typescript/interfaces/InspectAddressIcarus.html b/typescript/interfaces/InspectAddressIcarus.html index 91ea4f3a..36c4f6d9 100644 --- a/typescript/interfaces/InspectAddressIcarus.html +++ b/typescript/interfaces/InspectAddressIcarus.html @@ -1,9 +1,9 @@ InspectAddressIcarus | cardano-addresses
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InspectAddressIcarus

Corresponds to Cardano.Address.Style.Icarus.AddressInfo.

-

Hierarchy

  • InspectAddressIcarus

Index

Properties

Properties

address_root

address_root: string
+

Hierarchy

  • InspectAddressIcarus

Index

Properties

Properties

address_root

address_root: string

Hex-encoded address payload

-

address_style

address_style: "Icarus"

address_type

address_type: number
+

address_style

address_style: "Icarus"

address_type

address_type: number

Numeric address type field.

-

network_tag

network_tag: number
+

network_tag

network_tag: number

Which network the address belongs to. Unset for mainnet.

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/typescript/interfaces/InspectAddressShelley.html b/typescript/interfaces/InspectAddressShelley.html index 9ffe3440..13c833bc 100644 --- a/typescript/interfaces/InspectAddressShelley.html +++ b/typescript/interfaces/InspectAddressShelley.html @@ -1,5 +1,5 @@ -InspectAddressShelley | cardano-addresses
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InspectAddressShelley

Hierarchy

  • InspectAddressShelley

Index

Properties

Properties

address_style

address_style: "Shelley"

address_type

address_type: number
+InspectAddressShelley | cardano-addresses
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InspectAddressShelley

Hierarchy

  • InspectAddressShelley

Index

Properties

Properties

address_style

address_style: "Shelley"

address_type

address_type: number

Numeric address type field.

-

network_tag

network_tag: number
+

network_tag

network_tag: number

An integer denoting which network the address belongs to.

-

Optional pointer

pointer?: ChainPointer

Optional script_hash

script_hash?: string

Optional script_hash_bech32

script_hash_bech32?: string

Optional spending_key_hash

spending_key_hash?: string

Optional spending_key_hash_bech32

spending_key_hash_bech32?: string

Optional stake_key_hash

stake_key_hash?: string

Optional stake_key_hash_bech32

stake_key_hash_bech32?: string

Optional stake_reference

stake_reference?: StakeReference

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional pointer

pointer?: ChainPointer

Optional script_hash

script_hash?: string

Optional script_hash_bech32

script_hash_bech32?: string

Optional spending_key_hash

spending_key_hash?: string

Optional spending_key_hash_bech32

spending_key_hash_bech32?: string

Optional stake_key_hash

stake_key_hash?: string

Optional stake_key_hash_bech32

stake_key_hash_bech32?: string

Optional stake_reference

stake_reference?: StakeReference

Legend

  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file