Documentation GitHub npm

Class

SignerKey

SignerKey()

A container class with helpers to convert between signer keys (xdr.SignerKey) and StrKeys.

It's primarly used for manipulating the extraSigners precondition on a Transaction.

Constructor

# new SignerKey()

See:
  • TransactionBuilder.setExtraSigners

View Source js-stellar-base/src/signerkey.js, line 13

Methods

# static decodeAddress(address) → {xdr.SignerKey}

Decodes a StrKey address into an xdr.SignerKey instance.

Only ED25519 public keys (G...), pre-auth transactions (T...), hashes (H...), and signed payloads (P...) can be signer keys.

Parameters:
Name Type Description
address string

a StrKey-encoded signer address

View Source js-stellar-base/src/signerkey.js, line 23

xdr.SignerKey

# static encodeSignerKey(signerKey) → {string}

Encodes a signer key into its StrKey equivalent.

Parameters:
Name Type Description
signerKey xdr.SignerKey

the signer

View Source js-stellar-base/src/signerkey.js, line 61

the StrKey representation of the signer

string