sdk/wallet/Derivation.ts
Derivation overview
Table of contents
utils
DerivationError (class)
Signature
export declare class DerivationErrorSeedDerivationResult (type alias)
Result of deriving keys and addresses from a seed or Bip32 root
- address: Core Address object (payment address)
- rewardAddress: bech32 reward address (stake... / stake_test...)
- paymentKey / stakeKey: ed25519e_sk bech32 private keys
- keyStore: Map of KeyHash hex -> PrivateKey for signing operations
- paymentKhHex / stakeKhHex: KeyHash hex strings for quick lookup
Signature
export type SeedDerivationResult = {
address: CoreAddress.Address
rewardAddress: CoreRewardAddress.RewardAddress | undefined
paymentKey: string
stakeKey: string | undefined
keyStore: Map<string, PrivateKey.PrivateKey>
paymentKhHex: string
stakeKhHex: string | undefined
}addressFromSeed
Derive only addresses (payment and optional reward) from a seed.
Signature
export declare function addressFromSeed(
seed: string,
options: {
password?: string
addressType?: "Base" | "Enterprise"
accountIndex?: number
network?: "Mainnet" | "Testnet" | "Custom"
} = {}
): { address: CoreAddress.Address; rewardAddress: CoreRewardAddress.RewardAddress | undefined }keysFromSeed
Derive only the bech32 private keys (ed25519e_sk...) from a seed.
Signature
export declare function keysFromSeed(
seed: string,
options: {
password?: string
accountIndex?: number
} = {}
): { paymentKey: string; stakeKey: string }walletFromBip32
Same as walletFromSeed but accepts a Bip32 root key directly.
Signature
export declare function walletFromBip32(
rootXPrv: Bip32PrivateKey.Bip32PrivateKey,
options: {
addressType?: "Base" | "Enterprise"
accountIndex?: number
network?: "Mainnet" | "Testnet" | "Custom"
} = {}
): SeedDerivationResultwalletFromPrivateKey
Build an address (enterprise by default) from an already-derived payment private key. Optionally provide a stake private key to get a base address + reward address.
Signature
export declare function walletFromPrivateKey(
paymentKeyBech32: string,
options: {
stakeKeyBech32?: string
addressType?: "Base" | "Enterprise"
network?: "Mainnet" | "Testnet" | "Custom"
} = {}
): Effect.Effect<SeedDerivationResult, DerivationError>walletFromSeed
Signature
export declare const walletFromSeed: (
seed: string,
options?: {
password?: string
addressType?: "Base" | "Enterprise"
accountIndex?: number
network?: "Mainnet" | "Testnet" | "Custom"
}
) => Effect.Effect<SeedDerivationResult, DerivationError | Bip32PrivateKey.Bip32PrivateKeyError>