Class SymbolFacade

constructor

• new SymbolFacade(network): SymbolFacade

• Creates a Symbol facade.

  Parameters

  • network: string | Network

    Symbol network or network name.

  Returns SymbolFacade

network

transactionFactory

Static Address

Static BIP32_CURVE_NAME

Static KeyPair

Static Verifier

Static deriveSharedKey

static

• get static(): typeof SymbolFacade

• Gets class type.

  Returns typeof SymbolFacade

  Class type.

bip32Path

• bip32Path(accountId): number[]

• Creates a network compatible BIP32 path for the specified account.

  Parameters

  • accountId: number

    Id of the account for which to generate a BIP32 path.

  Returns number[]

  BIP32 path for the specified account.

cosignTransaction

• cosignTransaction(keyPair, transaction, detached?): Cosignature | DetachedCosignature

• Cosigns a Symbol transaction.

  Parameters

  • keyPair: KeyPair

    Key pair of the cosignatory.
  • transaction: models.Transaction

    Transaction object.
  • Optional detached: boolean

    \c true if resulting cosignature is appropriate for network propagation. \c false if resulting cosignature is appropriate for attaching to an aggregate.

  Returns Cosignature | DetachedCosignature

  Signed cosignature.

createAccount

• createAccount(privateKey): SymbolAccount

• Creates a Symbol account from a private key.

  Parameters

  • privateKey: PrivateKey

    Account private key.

  Returns SymbolAccount

  Symbol account.

createEmbeddedTransactionFromTypedDescriptor

• createEmbeddedTransactionFromTypedDescriptor(typedDescriptor, signerPublicKey): EmbeddedTransaction

• Creates an embedded transaction from a (typed) transaction descriptor.

  Parameters

  • typedDescriptor: object

    Transaction (typed) descriptor.
  • signerPublicKey: PublicKey

    Signer public key.

  Returns EmbeddedTransaction

  Created embedded transaction.

createPublicAccount

• createPublicAccount(publicKey): SymbolPublicAccount

• Creates a Symbol public account from a public key.

  Parameters

  • publicKey: PublicKey

    Account public key.

  Returns SymbolPublicAccount

  Symbol public account.

createTransactionFromTypedDescriptor

• createTransactionFromTypedDescriptor(typedDescriptor, signerPublicKey, feeMultiplier, deadlineSeconds, cosignatureCount?): models.Transaction

• Creates a transaction from a (typed) transaction descriptor.

  Parameters

  • typedDescriptor: object

    Transaction (typed) descriptor.
  • signerPublicKey: PublicKey

    Signer public key.
  • feeMultiplier: number

    Fee multiplier.
  • deadlineSeconds: number

    Approximate seconds from now for deadline.
  • Optional cosignatureCount: number

    Number of cosignature spaces to reserve.

  Returns models.Transaction

  Created transaction.

extractSigningPayload

• extractSigningPayload(transaction): Uint8Array

• Gets the payload to sign given a Symbol transaction.

  Parameters

  • transaction: models.Transaction

    Transaction object.

  Returns Uint8Array

  Verifiable data to sign.

hashTransaction

• hashTransaction(transaction): Hash256

• Hashes a Symbol transaction.

  Parameters

  • transaction: models.Transaction

    Transaction object.

  Returns Hash256

  Transaction hash.

now

• now(): NetworkTimestamp

• Creates a network timestamp representing the current time.

  Returns NetworkTimestamp

  Network timestamp representing the current time.

signTransaction

• signTransaction(keyPair, transaction): Signature

• Signs a Symbol transaction.

  Parameters

  • keyPair: KeyPair

    Key pair.
  • transaction: models.Transaction

    Transaction object.

  Returns Signature

  Transaction signature.

verifyTransaction

• verifyTransaction(transaction, signature): boolean

• Verifies a Symbol transaction.

  Parameters

  • transaction: models.Transaction

    Transaction object.
  • signature: Signature

    Signature to verify.

  Returns boolean

  \c true if transaction signature is verified.

Static bip32NodeToKeyPair

• bip32NodeToKeyPair(bip32Node): KeyPair

• Derives a Symbol KeyPair from a BIP32 node.

  Parameters

  • bip32Node: Bip32Node

    BIP32 node.

  Returns KeyPair

  Derived key pair.

Static cosignTransactionHash

• cosignTransactionHash(keyPair, transactionHash, detached?): Cosignature | DetachedCosignature

• Cosigns a Symbol transaction hash.

  Parameters

  • keyPair: KeyPair

    Key pair of the cosignatory.
  • transactionHash: Hash256

    Transaction hash.
  • Optional detached: boolean

    \c true if resulting cosignature is appropriate for network propagation. \c false if resulting cosignature is appropriate for attaching to an aggregate.

  Returns Cosignature | DetachedCosignature

  Signed cosignature.

Static hashEmbeddedTransactions

• hashEmbeddedTransactions(embeddedTransactions): Hash256

• Hashes embedded transactions of an aggregate transaction.

  Parameters

  • embeddedTransactions: EmbeddedTransaction[]

    Embedded transactions to hash.

  Returns Hash256

  Aggregate transactions hash.