Constructor
new Keypair(keys)
Parameters:
Name | Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
keys |
object
|
At least one of keys must be provided.
|
Methods
(static) fromBase58Seed(seed) → {Keypair}
Base58 address encoding is DEPRECATED! Use this method only for transition to strkey encoding.
- Deprecated:
- Source:
Parameters:
Name | Type | Description |
---|---|---|
seed |
string
|
Base58 secret seed |
Returns:
- Type:
-
Keypair
(static) fromPublicKey(publicKey) → {Keypair}
Creates a new Keypair
object from public key.
Parameters:
Name | Type | Description |
---|---|---|
publicKey |
string
|
public key (ex. |
Returns:
- Type:
-
Keypair
(static) fromRawEd25519Seed(rawSeed) → {Keypair}
Creates a new Keypair
object from ed25519 secret key seed raw bytes.
Parameters:
Name | Type | Description |
---|---|---|
rawSeed |
Buffer
|
Raw 32-byte ed25519 secret key seed |
Returns:
- Type:
-
Keypair
(static) fromSecret(secret) → {Keypair}
Creates a new Keypair
instance from secret. This can either be secret key or secret seed depending
on underlying public-key signature system. Currently Keypair
only supports ed25519.
Parameters:
Name | Type | Description |
---|---|---|
secret |
string
|
secret key (ex. |
Returns:
- Type:
-
Keypair
(static) master() → {Keypair}
Returns Keypair
object representing network master key.
Returns:
- Type:
-
Keypair
canSign() → {boolean}
Returns true
if this Keypair
object contains secret key and can sign.
Returns:
- Type:
-
boolean
publicKey() → {string}
Returns public key associated with this Keypair
object.
Returns:
- Type:
-
string
rawPublicKey() → {Buffer}
Returns raw public key
Returns:
- Type:
-
Buffer
rawSecretKey() → {Buffer}
Returns raw secret key.
Returns:
- Type:
-
Buffer
secret() → {string}
Returns secret key associated with this Keypair
object
Returns:
- Type:
-
string
sign(data) → {Buffer}
Signs data.
Parameters:
Name | Type | Description |
---|---|---|
data |
Buffer
|
Data to sign |
Returns:
- Type:
-
Buffer
verify(data, signature) → {boolean}
Verifies if signature
for data
is valid.
Parameters:
Name | Type | Description |
---|---|---|
data |
Buffer
|
Signed data |
signature |
Buffer
|
Signature |
Returns:
- Type:
-
boolean