Main class to read and write data from Factom blockchain.

const cli = new FactomCli({
     factomd: {
         host: 'api.factomd.net',
         port: 443,
         protocol: 'https'
     },
     walletd: {
         host: 'localhost',
         user: 'paul',
         password: 'pass'
     }
});

cli.rewindChainWhile('dab6c095c22ec6db1b0961fdb82d504a95f0a31467bb7df73cc793532b0e9ae3', (entry) => true, function(entry) {
     // Do stuff with the entry
})

Extract the key contained in an address. Cannot be used with public FCT address as those contain a RCD hash and not a key (See addressToRcdHash).

Extract the RCD hash from a public FCT address.

Class representing an Admin block.

Class to build an Entry

Class to build a Transaction.

Class representing an Entry.

const myEntry = Entry.builder()
.chainId('9107a308f91fd7962fecb321fdadeb37e2ca7d456f1d99d24280136c0afd55f2')
.extId('6d79206578742069642031') // If no encoding parameter is passed as 2nd argument, 'hex' is used as default
.extId('Some external ID', 'utf8')
.content('My new content',  'utf8')
.build();

Class representing a Factoid transaction.

const transaction = Transaction.builder()
  .input('Fs2w6VL6cwBqt6SpUyPLvdo9TK834gCr52Y225z8C5aHPAFav36X', 14000000)
  .input('Fs2E6iXCLAKDiPqVtfxtuQCKsTe7o6DJFDnht1wST53s4ibtdu9f', 1010000 + fees)
  .output('FA3syRxpYEvFFvoN4ZfNRJVQdumLpTK4CMmMUFmKGeqyTNgsg5uH', 5000000)
  .output('FA24PAtyZWWVAPm95ZCVpwyY6RYHeCMTiZt2v4VQAY8aBXMUZteF', 10000000)
   // Note that the line below is to buy Entry Credits (see the address type) and the amount is in Factoshis like other outputs:
   // it is *not* the number of Entry Credits you are purchasing.
  .output('EC2UFobcsWom2NvyNDN67Q8eTdpCQvwYe327ZeGTLXbYaZ56e3QR', 10000)
  .build()

Factomd API client.

Extends BaseCli

Walletd API client.

Extends BaseCli

Class representing a Chain.

Listen for new Factom Events:

• newDirectoryBlock - Triggers when blockchain adds a new directory block. Listener receives new directory block.
• newFactoidBlock - Triggers when blockchain adds a new factoid block. Listener receives new factoid block.
• newAdminBlock - Triggers when blockchain adds a new admin block. Listener receives new admin block.
• newEntryCreditBlock - Triggers when blockchain adds a new entry credit block. Listener receives new entry credit block.
• newChain - Triggers when blockchain adds a new chain. Listener receives first entry block of new chain.
• FA29eyMVJaZ2tbGqJ3M49gANaXMXCjgfKcJGe5mx8p4iQFCvFDAC - Triggers when factoid address sends or receives a transaction. Listener receives transaction.
• 4060c0192a421ca121ffff935889ef55a64574a6ef0e69b2b4f8a0ab919b2ca4 - Triggers when entry chain adds new entry block. Listener receives entry block.

Extends EventEmitter

const { FactomCli, FactomEventEmitter } = require('factom');
const cli = new FactomCli();
// Poll the blockchain every 10s
const emitter = new FactomEventEmitter(cli, { interval: 10000 });
emitter.on('newDirectoryBlock', (directoryBlock) => ...);
emitter.on('newFactoidBlock', (factoidBlock) => ...);
emitter.on('newAdminBlock', (adminBlock) => ...);
emitter.on('newEntryCreditBlock', (entryCreditBlock) => ...);
emitter.on('newChain', (entryBlock) => ...);
// Listen to any transaction involving a given Factoid address
emitter.on('FA29eyMVJaZ2tbGqJ3M49gANaXMXCjgfKcJGe5mx8p4iQFCvFDAC', (transaction) => ...);
// Listen to any new entries in a given chain
emitter.on('4060c0192a421ca121ffff935889ef55a64574a6ef0e69b2b4f8a0ab919b2ca4', (entryBlock) => ...);

Compose the commit and reveal of a Chain, that can then be used as inputs of the factomd APIs commit-chain and reveal-chain.

Compose the commit of a Chain, that can then be used as input of the factomd API commit-chain. Note that if the chain first entry doesn't have a timestamp set the library will use Date.now() as the default for the commit timestamp.

Compose the commit of a Chain using an external signing function. The commit can then be sent through factomd API commit-chain.

Compose the commit and reveal of a Chain using an external signing function for the commit. The result can then be used as inputs of the factomd APIs commit-chain and reveal-chain.

Compose the reveal of a Chain, that can then be used as input of the factomd API reveal-chain.

Compose the commit and reveal of an Entry, that can then be used as inputs of the factomd APIs commit-entry and reveal-entry.

Compose the commit of an Entry, that can then be used as input of the factomd API commit-entry. Note that if the Entry doesn't have a timestamp set the library will use Date.now() as the default for the commit timestamp.

Compose the commit of an Entry delegating the signature. The commit can then be sent through factomd API commit-entry.

Compose the commit and reveal of an Entry using an external signing function. The result can then be used as inputs of the factomd APIs commit-entry and reveal-entry.

Compose the reveal of an Entry, that can then be used as input of the factomd API reveal-entry.

Compute the ID of a Chain provided its first entry.

Compute the transaction ID of the Chain commit. The transaction ID is dependent on the timestamp set in the chain first entry. Note that if the timestamp is not set the library uses Date.now() as the default, changing the result of this function if called at different times.

Compute the transaction ID of the Entry commit. The transaction ID is dependent on the timestamp set in the entry. Note that if the timestamp is not set the library uses Date.now() as the default, changing the result of this function if called at different times.

Describe the options of connection to factomd or factom-walletd.

Type: Object

const cli = new FactomdCli({
     host: '52.202.51.228',
     port: 8088,
     path: '/',
     debugPath: '/debug',
     user: 'paul',
     password: 'pwd',
     protocol: 'https',
     rejectUnauthorized: false,
     timeout: 5000,
     retry: {
         retries: 3,
         factor: 2,
         minTimeout: 500,
         maxTimeout: 2000
     }
});

Class representing a Directory block.

Class representing an Entry block.

Block context of an Entry.

Type: Object

Class representing an Entry Credit block.

Class representing a Factoid block.

Generate a new random EC address pair (private and public).

Generate a new random FCT address pair (private and public).

Get public address corresponding to an address.

Validate that an address is valid (well formed).

Validate if an address is a valid EC address (public or private).

Validate if an address is a valid FCT address (public or private).

Validate if an address is a valid private EC or FCT address.

Validate if an address is a valid private EC address.

Validate if an address is a valid private FCT address.

Validate if an address is a valid public EC or FCT address.

Validate if an address is a valid public EC address.

Validate if an address is a valid public FCT address.

Build a human readable public EC address from a 32-byte key.

Build a human readable public FCT address from a key.

Build a human readable public FCT address from a RCD hash.

Build a human readable private EC address from a 32-byte seed.

Build a human readable private FCT address from a 32-byte seed.

Class to hold address and amount of an input/output of a Transaction.

Block context of a Transaction.

Type: Object