Package org.symbol.sdk.facade

Class NemFacade

java.lang.Object

org.symbol.sdk.facade.NemFacade

---

public final class NemFacade extends Object

NemFacade

High-level facade used to interact with the NEM blockchain: signing, verifying, hashing, and creating transactions.

• Nested Class Summary

  Nested Classes

  Modifier and Type

  Class

  Description

  static final class 

  NemFacade.NemAccount

  NEM account — adds the signing key pair to NemFacade.NemPublicAccount.

  static class 

  NemFacade.NemPublicAccount

  NEM public account — known public key plus derived address.

• Field Summary

  Fields

  Modifier and Type

  Field

  Description

  static final String

  BIP32_CURVE_NAME

  BIP32 curve name for NEM.

  final Network

  network

  Underlying network.

  final NemTransactionFactory

  transactionFactory

  Underlying transaction factory.

• Constructor Summary

  Constructors

  Constructor

  Description

  NemFacade(String networkName)

  Creates a NEM facade by network name.

  NemFacade(Network network)

  Creates a NEM facade around an explicit network.

• Method Summary

  All MethodsStatic MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  static KeyPair

  bip32NodeToKeyPair(Bip32.Bip32Node bip32Node)

  Derives a NEM KeyPair from a BIP32 node.

  int[]

  bip32Path(int accountId)

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

  NemFacade.NemAccount

  createAccount(CryptoTypes.PrivateKey privateKey)

  Creates a NEM account from a private key.

  NemFacade.NemPublicAccount

  createPublicAccount(CryptoTypes.PublicKey publicKey)

  Creates a NEM public account from a public key.

  Transaction

  createTransactionFromJson(String json, CryptoTypes.PublicKey signerPublicKey, long fee, long deadlineSeconds)

  Creates a transaction from a JSON descriptor document.

  Transaction

  createTransactionFromTypedDescriptor(NemTransactionDescriptor typedDescriptor, CryptoTypes.PublicKey signerPublicKey, long fee, long deadlineSeconds)

  Creates a transaction from a typed transaction descriptor.

  byte[]

  extractSigningPayload(Transaction transaction)

  Gets the payload to sign for a NEM transaction.

  CryptoTypes.Hash256

  hashTransaction(Transaction transaction)

  Hashes a NEM transaction; the hash is Keccak-256 of the non-verifiable serialization.

  NetworkTimestamp

  now()

  Creates a network timestamp representing the current time.

  CryptoTypes.Signature

  signTransaction(KeyPair keyPair, Transaction transaction)

  Signs a NEM transaction.

  boolean

  verifyTransaction(Transaction transaction, CryptoTypes.Signature signature)

  Verifies a NEM transaction signature.

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Field Details

  • BIP32_CURVE_NAME

    public static final String BIP32_CURVE_NAME

    BIP32 curve name for NEM.

    See Also:

    • Constant Field Values

  • network

    public final Network network

    Underlying network.

  • transactionFactory

    public final NemTransactionFactory transactionFactory

    Underlying transaction factory.

• Constructor Details

  • NemFacade

    public NemFacade(Network network)

    Creates a NEM facade around an explicit network.

    Parameters:

    network - NEM network.

  • NemFacade

    public NemFacade(String networkName)

    Creates a NEM facade by network name.

    Parameters:

    networkName - Network name (e.g. "mainnet", "testnet").

• Method Details

  • now

    public NetworkTimestamp now()

    NemFacade.now

    Creates a network timestamp representing the current time.

    Returns:

    Network timestamp representing the current time.

  • createPublicAccount

    public NemFacade.NemPublicAccount createPublicAccount(CryptoTypes.PublicKey publicKey)

    NemFacade.createPublicAccount

    Creates a NEM public account from a public key.

    Parameters:

    publicKey - Account public key.

    Returns:

    NEM public account.

  • createAccount

    public NemFacade.NemAccount createAccount(CryptoTypes.PrivateKey privateKey)

    NemFacade.createAccount

    Creates a NEM account from a private key.

    Parameters:

    privateKey - Account private key.

    Returns:

    NEM account.

  • createTransactionFromTypedDescriptor

    public Transaction createTransactionFromTypedDescriptor(NemTransactionDescriptor typedDescriptor, CryptoTypes.PublicKey signerPublicKey, long fee, long deadlineSeconds)

    NemFacade.createTransactionFromTypedDescriptor

    Creates a transaction from a typed transaction descriptor.

    Parameters:

    typedDescriptor - Typed transaction descriptor.

    signerPublicKey - Signer public key.

    fee - Transaction fee.

    deadlineSeconds - Approximate seconds from now for the deadline.

    Returns:

    Created transaction.

  • createTransactionFromJson

    public Transaction createTransactionFromJson(String json, CryptoTypes.PublicKey signerPublicKey, long fee, long deadlineSeconds)

    NemFacade.createTransactionFromJson

    Creates a transaction from a JSON descriptor document.

    Parameters:

    json - JSON object with the same shape as the untyped descriptor map.

    signerPublicKey - Signer public key.

    fee - Transaction fee.

    deadlineSeconds - Approximate seconds from now for the deadline.

    Returns:

    Created transaction.

  • hashTransaction

    public CryptoTypes.Hash256 hashTransaction(Transaction transaction)

    NemFacade.hashTransaction

    Hashes a NEM transaction; the hash is Keccak-256 of the non-verifiable serialization.

    Parameters:

    transaction - Transaction object.

    Returns:

    Transaction hash.

  • extractSigningPayload

    public byte[] extractSigningPayload(Transaction transaction)

    NemFacade.extractSigningPayload

    Gets the payload to sign for a NEM transaction.

    Parameters:

    transaction - Transaction object.

    Returns:

    Verifiable data to sign — the non-verifiable serialization of the transaction.

  • signTransaction

    public CryptoTypes.Signature signTransaction(KeyPair keyPair, Transaction transaction)

    NemFacade.signTransaction

    Signs a NEM transaction.

    Parameters:

    keyPair - Signer key pair.

    transaction - Transaction object.

    Returns:

    Transaction signature.

  • verifyTransaction

    public boolean verifyTransaction(Transaction transaction, CryptoTypes.Signature signature)

    NemFacade.verifyTransaction

    Verifies a NEM transaction signature.

    Parameters:

    transaction - Transaction object.

    signature - Signature to verify.

    Returns:

    true if the signature is valid for the transaction.

  • bip32Path

    public int[] bip32Path(int accountId)

    NemFacade.bip32Path

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

    Parameters:

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

    Returns:

    BIP32 path for the specified account.

  • bip32NodeToKeyPair

    public static KeyPair bip32NodeToKeyPair(Bip32.Bip32Node bip32Node)

    NemFacade.bip32NodeToKeyPair

    Derives a NEM KeyPair from a BIP32 node. BIP32 private keys should be used as-is, so the bytes are reversed here to counteract the NEM KeyPair constructor's internal reverse.

    Parameters:

    bip32Node - BIP32 node.

    Returns:

    Derived key pair.