bsv.HDPrivateKey

scrypt-ts / bsv / HDPrivateKey

Class: HDPrivateKey

bsv.HDPrivateKey

Table of contents

Constructors

• constructor

Properties

• depth
• fingerPrint
• hdPublicKey
• network
• privateKey
• publicKey
• xprivkey
• xpubkey

Methods

• derive
• deriveChild
• deriveNonCompliantChild
• inspect
• toBuffer
• toHex
• toJSON
• toObject
• toString
• fromBuffer
• fromHex
• fromObject
• fromRandom
• fromSeed
• fromString
• getSerializedError
• isValidPath
• isValidSerialized

Constructors

constructor

• new HDPrivateKey(data?)

Parameters

Name	Type
data?	string | object | Buffer

Defined in

node_modules/bsv/index.d.ts:1125

Properties

depth

• Readonly depth: number

Defined in

node_modules/bsv/index.d.ts:1132

---

fingerPrint

• Readonly fingerPrint: Buffer

Defined in

node_modules/bsv/index.d.ts:1135

---

hdPublicKey

• Readonly hdPublicKey: HDPublicKey

Defined in

node_modules/bsv/index.d.ts:1127

---

network

• Readonly network: Network

Defined in

node_modules/bsv/index.d.ts:1131

---

privateKey

• Readonly privateKey: PrivateKey

Defined in

node_modules/bsv/index.d.ts:1133

---

publicKey

• Readonly publicKey: PublicKey

Defined in

node_modules/bsv/index.d.ts:1134

---

xprivkey

• Readonly xprivkey: Buffer

Defined in

node_modules/bsv/index.d.ts:1129

---

xpubkey

• Readonly xpubkey: Buffer

Defined in

node_modules/bsv/index.d.ts:1130

Methods

derive

▸ derive(arg, hardened?): HDPrivateKey

Parameters

Name	Type
arg	string | number
hardened?	boolean

Returns

HDPrivateKey

Defined in

node_modules/bsv/index.d.ts:1137

---

deriveChild

▸ deriveChild(arg, hardened?): HDPrivateKey

Parameters

Name	Type
arg	string | number
hardened?	boolean

Returns

HDPrivateKey

Defined in

node_modules/bsv/index.d.ts:1138

---

deriveNonCompliantChild

▸ deriveNonCompliantChild(arg, hardened?): HDPrivateKey

Parameters

Name	Type
arg	string | number
hardened?	boolean

Returns

HDPrivateKey

Defined in

node_modules/bsv/index.d.ts:1139

---

inspect

▸ inspect(): string

Returns

string

Defined in

node_modules/bsv/index.d.ts:1149

---

toBuffer

▸ toBuffer(): Buffer

Returns

Buffer

Defined in

node_modules/bsv/index.d.ts:1147

---

toHex

▸ toHex(): string

Returns

string

Defined in

node_modules/bsv/index.d.ts:1148

---

toJSON

▸ toJSON(): object

Returns

object

Defined in

node_modules/bsv/index.d.ts:1146

---

toObject

▸ toObject(): object

Returns

object

Defined in

node_modules/bsv/index.d.ts:1145

---

toString

▸ toString(): string

Returns

string

Defined in

node_modules/bsv/index.d.ts:1144

---

fromBuffer

▸ Static fromBuffer(buf): HDPrivateKey

Parameters

Name	Type
buf	Buffer

Returns

HDPrivateKey

Defined in

node_modules/bsv/index.d.ts:1158

---

fromHex

▸ Static fromHex(hex): HDPrivateKey

Parameters

Name	Type
hex	string

Returns

HDPrivateKey

Defined in

node_modules/bsv/index.d.ts:1159

---

fromObject

▸ Static fromObject(obj): HDPrivateKey

Parameters

Name	Type
obj	object

Returns

HDPrivateKey

Defined in

node_modules/bsv/index.d.ts:1153

---

fromRandom

▸ Static fromRandom(): HDPrivateKey

Returns

HDPrivateKey

Defined in

node_modules/bsv/index.d.ts:1151

---

fromSeed

▸ Static fromSeed(hexa, network): HDPrivateKey

Parameters

Name	Type
hexa	string | Buffer
network	string | Network

Returns

HDPrivateKey

Defined in

node_modules/bsv/index.d.ts:1154

---

fromString

▸ Static fromString(str): HDPrivateKey

Parameters

Name	Type
str	string

Returns

HDPrivateKey

Defined in

node_modules/bsv/index.d.ts:1152

---

getSerializedError

▸ Static getSerializedError(data, network?): any

Parameters

Name	Type
data	string | Buffer
network?	string | Network

Returns

any

Defined in

node_modules/bsv/index.d.ts:1165

---

isValidPath

▸ Static isValidPath(arg, hardened): boolean

Parameters

Name	Type
arg	string | number
hardened	boolean

Returns

boolean

Defined in

node_modules/bsv/index.d.ts:1160

---

isValidSerialized

▸ Static isValidSerialized(data, network?): boolean

Parameters

Name	Type
data	string | Buffer
network?	string | Network

Returns

boolean

Defined in

node_modules/bsv/index.d.ts:1161