Skip to content

SymbolAccount⚓︎

SymbolAccount
Symbol account.

Extends⚓︎

Constructors⚓︎

new SymbolAccount()⚓︎

new SymbolAccount(facade, keyPair): SymbolAccount

Creates a Symbol account.

Parameters⚓︎

Parameter Type Description
facade SymbolFacade Symbol facade.
keyPair KeyPair Account key pair.

Returns⚓︎

SymbolAccount

Overrides⚓︎

SymbolPublicAccount.constructor

Properties⚓︎

Property Modifier Type Description Inherited from
_facade protected SymbolFacade - SymbolPublicAccount._facade
address public Address Account address. SymbolPublicAccount.address
keyPair public KeyPair Account key pair. -
publicKey public PublicKey Account public key. SymbolPublicAccount.publicKey

Methods⚓︎

cosignTransaction()⚓︎

cosignTransaction(transaction, detached?): 
  | Cosignature
  | DetachedCosignature
SymbolAccount.cosignTransaction
Cosigns a Symbol transaction.

Parameters⚓︎

Parameter Type Description
transaction Transaction Transaction object.
detached? boolean true if resulting cosignature is appropriate for network propagation. false if resulting cosignature is appropriate for attaching to an aggregate.

Returns⚓︎

| Cosignature | DetachedCosignature

Signed cosignature.

cosignTransactionHash()⚓︎

cosignTransactionHash(transactionHash, detached?): 
  | Cosignature
  | DetachedCosignature
SymbolAccount.cosignTransactionHash
Cosigns a Symbol transaction hash.

Parameters⚓︎

Parameter Type Description
transactionHash Hash256 Transaction hash.
detached? boolean true if resulting cosignature is appropriate for network propagation. false if resulting cosignature is appropriate for attaching to an aggregate.

Returns⚓︎

| Cosignature | DetachedCosignature

Signed cosignature.

messageEncoder()⚓︎

messageEncoder(): default
SymbolAccount.messageEncoder
Creates a message encoder that can be used for encrypting and encoding messages between two parties.

Returns⚓︎

default

Message encoder using this account as one party.

signTransaction()⚓︎

signTransaction(transaction): Signature
SymbolAccount.signTransaction
Signs a Symbol transaction.

Parameters⚓︎

Parameter Type Description
transaction Transaction Transaction object.

Returns⚓︎

Signature

Transaction signature.