# new Keypair(keys)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
keys |
object
|
At least one of keys must be provided. |
|
type |
string
|
Public-key signature system name. (currently only |
|
publicKey |
Buffer
|
<optional> |
Raw public key |
secretKey |
Buffer
|
<optional> |
Raw secret key (32-byte secret seed in ed25519`) |
Classes
Methods
# canSign() → {boolean}
Returns true if this Keypair object contains secret key and can sign.
boolean
# sign(data) → {Buffer}
Signs data.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Buffer
|
Data to sign |
Buffer
# signDecorated(data) → {xdr.DecoratedSignature}
Returns the decorated signature (hint+sig) for arbitrary data.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Buffer
|
arbitrary data to sign |
- See:
-
- TransactionBase.addDecoratedSignature
the raw signature structure which can be added directly to a transaction envelope
xdr.DecoratedSignature
# signPayloadDecorated(data) → {xdr.DecoratedSignature}
Returns the raw decorated signature (hint+sig) for a signed payload signer.
The hint is defined as the last 4 bytes of the signer key XORed with last 4 bytes of the payload (zero-left-padded if necessary).
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Buffer
|
data to both sign and treat as the payload |
- See:
-
- https://github.com/stellar/stellar-protocol/blob/master/core/cap-0040.md#signature-hint
- TransactionBase.addDecoratedSignature
xdr.DecoratedSignature
# verify(data, signature) → {boolean}
Verifies if signature for data is valid.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Buffer
|
Signed data |
signature |
Buffer
|
Signature |
boolean
# xdrMuxedAccount(idopt) → {xdr.MuxedAccount}
Creates a xdr.MuxedAccount object from the public key.
You will get a different type of muxed account depending on whether or not you pass an ID.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string
|
<optional> |
stringified integer indicating the underlying muxed ID of the new account object |
xdr.MuxedAccount
# static fromPublicKey(publicKey) → {Keypair}
Creates a new Keypair object from public key.
Parameters:
| Name | Type | Description |
|---|---|---|
publicKey |
string
|
public key (ex. |
# 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 |
# 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. |
# static master(networkPassphrase) → {Keypair}
Returns Keypair object representing network master key.
Parameters:
| Name | Type | Description |
|---|---|---|
networkPassphrase |
string
|
passphrase of the target stellar network (e.g. "Public Global Stellar Network ; September 2015"). |