From 8bfab3f9421d0910bdff76a5e0ea8342d56e7781 Mon Sep 17 00:00:00 2001 From: Chris Duncan Date: Sat, 16 May 2026 00:29:42 -0700 Subject: [PATCH] Documentation. --- src/lib/ledger/index.ts | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/src/lib/ledger/index.ts b/src/lib/ledger/index.ts index aa1a1bd..0dd9950 100644 --- a/src/lib/ledger/index.ts +++ b/src/lib/ledger/index.ts @@ -257,20 +257,21 @@ export class Ledger { } /** - * Update cache from raw block data. Suitable for offline use. - * - * @param {number} index - Account number - * @param {object} block - JSON-formatted block data - */ + * Update frontier block cached in device memory from raw block data. Suitable + * for offline use. + * + * @param {number} index - Account number + * @param {object} block - JSON-formatted block data + */ static async updateCache (index: number, block: Block): Promise /** - * Update cache from a block hash by calling out to a node. Suitable for online - * use only. - * - * @param {number} index - Account number - * @param {string} hash - Hexadecimal block hash - * @param {Rpc} rpc - Rpc class object with a node URL - */ + * Update frontier block cached in device memory from a block hash by calling + * out to a node. Suitable for online use only. + * + * @param {number} index - Account number + * @param {string} hash - Hexadecimal block hash + * @param {Rpc} rpc - Rpc class object with a node URL + */ static async updateCache (index: number, hash: string, rpc: Rpc): Promise static async updateCache (index: number, input: any, node?: Rpc): Promise { if (typeof input === 'string' && node instanceof Rpc) { -- 2.47.3