Class Api

The API structure returned by LedgerClientFactory (or older style composeApi)

The programming interface uses a builder pattern to mount an API.

Example: Using recommended LedgerClientFactory

const api = LedgerClientFactory.createClient({
  nodeHost: 'https://europe.signum.network', // one of the mainnet nodes
})
Copy

Example: Using older composeApi style

const api = composeApi({
  nodeHost: 'https://europe.signum.network', // one of the mainnet nodes
})
Copy

Customize API

While this is a straightforward way to have access to all API functionality, this methods has the disadvantage of including all needed dependencies, thus leading to a bigger bundle, for those who use bundlers like webpack. To reduce the bundle size, one may mount a subset of the API conforming their needs using the ApiComposer class.