Recipes

2min
In this section we show usage examples of SignumJS, which give an understanding of how SignumJS works. The provided examples require at least some basic knowledge of Java/TypeScript. All requests are asynchronous such that the concept of async/await and Promise is required.
Most examples are self containing and fully functional, i.e. can be copied and pasted directly and executed using NodeJS. Many of these recipes are also available in an extended form in the /examples folder in the SignumJS Github repository.
To run the examples a NodeJS environment must be set up. SignumJS works with NodeJS 12+
The very basic usage
Almost all examples require to create an instance of the Signum Ledger Client to get easy access to a networks node:
JS
HTML
// const {LedgerClientFactory} = require('@signumjs/core') 
import {LedgerClientFactory} from '@signumjs/core'

const ledger = LedgerClientFactory.createClient({
    nodeHost: "http://localhost:6876"
});

// now you have access to the entire API of the Signum Node
// e.g. getting the account data
const account = await ledger.account.getAccount({accountId: '2402520554221019656'})

// const {LedgerClientFactory} = require('@signumjs/core') 
import {LedgerClientFactory} from '@signumjs/core'

const ledger = LedgerClientFactory.createClient({
    nodeHost: "http://localhost:6876"
});

// now you have access to the entire API of the Signum Node
// e.g. getting the account data
const account = await ledger.account.getAccount({accountId: '2402520554221019656'})
﻿
﻿
Wallets Module
Wallets