ledgr v0.0.10

Ledgr

Ledgr is a simple account management system that keeps track of balances for individual nostr public keys.

Specification

Data

Ledgr is stored in a single JSON file that contains nostr public keys and their balances:

{
   "npub1": 1,
   "npub2": 2,
   "npub3": 3
}

Note: By default, the ledgr is stored in a file called ledgr.json.

Functions

Ledger offers the following functions for working with balances of public keys:

• deposit: Deposits satoshis to a public key.
• withdraw: Withdraws satoshis from a public key.
• transfer: Transfers satoshis from one public key to another.

Guide

Deposit

To deposit satoshis to a public key, use the deposit function.

deposit(npub, amount)

• npub: The public key to which the satoshis should be deposited.
• amount: The number of satoshis you want to deposit.

Withdraw

To withdraw satoshis from a public key, use the withdraw function.

withdraw(npub, amount)

• npub: The public key from which the satoshis should be withdrawn.
• amount: The number of satoshis you want to withdraw.

Transfer

To transfer satoshis from one public key to another, use the transfer function.

transfer(from_npub, to_npub, amount)

• from_npub: The public key from which the satoshis should be transferred.
• to_npub: The public key to which the satoshis should be transferred.
• amount: The number of satoshis you want to transfer.

Usage Example

JavaScript

import { Ledgr } from 'Ledgr';

// Create a new Ledgr instance
const ledgr = new Ledgr();

// Deposit 100 satoshis to the public key 'npub1'
ledgr.deposit('npub1', 100);

// Withdraw 50 satoshis from the public key 'npub1'
ledgr.withdraw('npub1', 50);

// Transfer 25 satoshis from the public key 'npub1' to the public key 'npub2'
ledgr.transfer('npub1', 'npub2', 25);

// Print the current balances
console.log(ledgr.balances);

This way, you can use Ledgr to manage the balances of individual public keys and perform various operations such as deposits, withdrawals, and transfers of satoshis.