Class Signer

Estimate the receipt associated to the transaction if it sent to the blockchain. It is useful to estimate the consumption of mana. The transaction is signed during this process and sent to the rpc node with the "broadcast:false" option to just compute the transaction without broadcasting it to the network. After that, the initial signatures are restored (if any) and the ones used for the estimation will be removed.

Returns

Signer address

Function to get the private key in hex format or wif format

Example

const signer = Signer.fromSeed("one two three four five six");
console.log(signer.getPrivateKey());
// bab7fd6e5bd624f4ea0c33f7e7219262a6fa93a945a8964d9f110148286b7b37

console.log(signer.getPrivateKey("wif"));
// L3UfgFJWmbVziGB1uZBjkG1UjKkF7hhpXWY7mbTUdmycmvXCVtiL

console.log(signer.getPrivateKey("wif", false));
// 5KEX4TMHG66fT7cM9HMZLmdp4hVq4LC4X2Fkg6zeypM5UteWmtd

Function to prepare a block

Returns

A prepared block. ()

Function to recover the signer addresses from a signed transaction or block. The output format can be compressed (default) or uncompressed.

Example

const addresses = await signer.recoverAddress(tx);

If the signature data contains more data, like in the blocks for PoW consensus, use the "transformSignature" function to extract the signature.

Example

 const powDescriptorJson = {
   nested: {
     mypackage: {
       nested: {
         pow_signature_data: {
           fields: {
             nonce: {
               type: "bytes",
               id: 1,
             },
             recoverable_signature: {
               type: "bytes",
               id: 2,
             },
           },
         },
       },
     },
   },
 };

 const serializer = new Serializer(powDescriptorJson, {
  defaultTypeName: "pow_signature_data",
 });

 const addresses = await signer.recoverAddress(block, {
   transformSignature: async (signatureData) => {
     const powSignatureData = await serializer.deserialize(signatureData);
     return powSignatureData.recoverable_signature;
   },
 });

Function to recover the publics keys from a signed transaction or block. The output format can be compressed (default) or uncompressed.

Example

const publicKeys = await Signer.recoverPublicKeys(tx);

If the signature data contains more data, like in the blocks for PoW consensus, use the "transformSignature" function to extract the signature.

Example

 const powDescriptorJson = {
   nested: {
     mypackage: {
       nested: {
         pow_signature_data: {
           fields: {
             nonce: {
               type: "bytes",
               id: 1,
             },
             recoverable_signature: {
               type: "bytes",
               id: 2,
             },
           },
         },
       },
     },
   },
 };

 const serializer = new Serializer(powDescriptorJson, {
  defaultTypeName: "pow_signature_data",
 });

 const publicKeys = await signer.recoverPublicKeys(block, {
   transformSignature: async (signatureData) => {
     const powSignatureData = await serializer.deserialize(signatureData);
     return powSignatureData.recoverable_signature;
   },
 });

Function to sign and send a transaction. It internally uses Provider.sendTransaction

Function to sign a block for federated consensus. That is, just the ecdsa signature. For other algorithms, like PoW, you have to sign the block and then process the signature to add the extra data (nonce in the case of PoW).

Function to sign a hash value. It returns the bytes signature. The signature is in compact format with the recovery byte

Function to sign a message, which could be a string or a Uint8Array

Function to sign a transaction. It's important to remark that the transaction parameter is modified inside this function.

Function to import a private key from the seed

Example

const signer = Signer.fromSeed("my seed");
console.log(signer.getAddress());
// 1BqtgWBcqm9cSZ97avLGZGJdgso7wx6pCA

Returns

Signer object

Function to import a private key from the WIF

Example

const signer = Signer.fromWif("L59UtJcTdNBnrH2QSBA5beSUhRufRu3g6tScDTite6Msuj7U93tM")
console.log(signer.getAddress());
// 1MbL6mG8ASAvSYdoMnGUfG3ZXkmQ2dpL5b

Returns

Signer object

Function to recover the public key from hash and signature