// SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
// SPDX-License-Identifier: GPL-3.0-or-later
+/**
+* Represents a single Nano address and the associated public key. To include the
+* matching private key, it must be known at the time of object instantiation.
+* The frontier, balance, and representative for the account can also be set or
+* be fetched from the network.
+*/
+export declare class Account {
+ get address (): string
+ get publicKey (): string
+ get balance (): bigint | undefined
+ get frontier (): string | undefined
+ get receivable (): bigint | undefined
+ get representative (): Account | undefined
+ get weight (): bigint | undefined
+ set balance (v: bigint | undefined)
+ set frontier (v: string | undefined)
+ set receivable (v: bigint | undefined)
+ set representative (v: Account | undefined)
+ set weight (v: bigint | undefined)
+ private constructor ()
+ /**
+ * Removes encrypted secrets in storage and releases variable references to
+ * allow garbage collection.
+ */
+ destroy (): Promise<void>
+ /**
+ * Instantiates an Account object from its Nano address.
+ *
+ * @param {string} addresses - Address of the account
+ * @returns {Account} The instantiated Account object
+ */
+ static import (address: string): Account
+ /**
+ * Instantiates Account objects from their Nano addresses.
+ *
+ * @param {string[]} addresses - Addresses of the accounts
+ * @returns {Account[]} The instantiated Account objects
+ */
+ static import (addresses: string[]): Account[]
+ /**
+ * Instantiates an Account object from its public key. It is unable to sign
+ * blocks or messages since it has no private key.
+ *
+ * @param {string} publicKey - Public key of the account
+ * @returns {Account} The instantiated Account object
+ */
+ static import (publicKey: string): Account
+ /**
+ * Instantiates an Account object from its public key. It is unable to sign
+ * blocks or messages since it has no private key.
+ *
+ * @param {Uint8Array} publicKey - Public key of the account
+ * @returns {Account} The instantiated Account object
+ */
+ static import (publicKey: Uint8Array<ArrayBuffer>): Account
+ /**
+ * Instantiates Account objects from their public keys. They are unable to sign
+ * blocks or messages since they have no private key.
+ *
+ * @param {string[]} publicKeys - Public keys of the accounts
+ * @returns {Account[]} The instantiated Account objects
+ */
+ static import (publicKeys: string[]): Account[]
+ /**
+ * Instantiates Account objects from their public keys. They are unable to sign
+ * blocks or messages since they have no private key.
+ *
+ * @param {Uint8Array[]} publicKeys - Public keys of the accounts
+ * @returns {Account[]} The instantiated Account objects
+ */
+ static import (publicKeys: Uint8Array<ArrayBuffer>[]): Account[]
+ /**
+ * Instantiates an Account object from its private key which is then encrypted
+ * and stored in IndexedDB. The corresponding public key will automatically be
+ * derived and saved.
+ *
+ * @param {string} privateKey - Private key of the account
+ * @param {(string|Uint8Array)} password - Used to encrypt the private key
+ * @returns {Account} A new Account object
+ */
+ static import (privateKey: string, password: string | Uint8Array<ArrayBuffer>): Promise<Account>
+ /**
+ * Instantiates an Account object from its private key which is then encrypted
+ * and stored in IndexedDB. The corresponding public key will automatically be
+ * derived and saved.
+ *
+ * @param {Uint8Array} privateKey - Private key of the account
+ * @param {(string|Uint8Array)} password - Used to encrypt the private key
+ * @returns {Account} A new Account object
+ */
+ static import (privateKey: Uint8Array<ArrayBuffer>, password: string | Uint8Array<ArrayBuffer>): Promise<Account>
+ /**
+ * Instantiates Account objects from their private keys which are then
+ * encrypted and stored in IndexedDB. The corresponding public keys will
+ * automatically be derived and saved.
+ *
+ * @param {string[]} privateKeys - Private keys of the account
+ * @param {(string|Uint8Array)} password - Used to encrypt the private keys
+ * @returns {Account[]} The instantiated Account objects
+ */
+ static import (privateKeys: string[], password: string | Uint8Array<ArrayBuffer>): Promise<Account[]>
+ /**
+ * Instantiates Account objects from their private keys which are then
+ * encrypted and stored in IndexedDB. The corresponding public keys will
+ * automatically be derived and saved.
+ *
+ * @param {Uint8Array[]} privateKeys - Private keys of the account
+ * @param {(string|Uint8Array)} password - Used to encrypt the private keys
+ * @returns {Account[]} The instantiated Account objects
+ */
+ static import (privateKeys: Uint8Array<ArrayBuffer>[], password: string | Uint8Array<ArrayBuffer>): Promise<Account[]>
+ /**
+ * Refreshes the account from its current state on the network.
+ *
+ * A successful response sets the balance, frontier, and representative
+ * properties.
+ *
+ * @param {Rpc|string|URL} rpc - RPC node information required to call `account_info`
+ */
+ refresh (rpc: Rpc | string | URL): Promise<void>
+ /**
+ * Signs a block using the private key of the account. The signature is
+ * appended to the signature field of the block before being returned.
+ *
+ * @param {(string|Uint8Array)} password - Required to decrypt the private key for signing
+ * @param {(ChangeBlock|ReceiveBlock|SendBlock)} block - The block data to be hashed and signed
+ * @returns {Promise<string>} Hexadecimal-formatted 64-byte signature
+ */
+ sign (block: ChangeBlock | ReceiveBlock | SendBlock, password: string | Uint8Array<ArrayBuffer>): Promise<string>
+ /**
+ * Retrieves and decryptes the private key of the Account. The same password
+ * used to lock it must be used to unlock it.
+ *
+ * @param {(string|Uint8Array)} password Used previously to lock the Account
+ * @returns Private key bytes as a Uint8Array
+ */
+ exportPrivateKey (password: string | Uint8Array<ArrayBuffer>): Promise<Uint8Array<ArrayBuffer>>
+ /**
+ * Retrieves and decryptes the private key of the Account. The same password
+ * used to lock it must be used to unlock it.
+ *
+ * @param {(string|Uint8Array)} password Used previously to lock the Account
+ * @returns Private key bytes as a hexadecimal string
+ */
+ exportPrivateKey (password: string | Uint8Array<ArrayBuffer>, format: 'hex'): Promise<string>
+ /**
+ * Validates a Nano address with 'nano' and 'xrb' prefixes
+ * Derived from https://github.com/alecrios/nano-address-validator
+ *
+ * @param {string} address - Nano address to validate
+ * @throws Error if address is undefined, not a string, or an invalid format
+ */
+ static validate (address: unknown): asserts address is string
+}
+
+/**
+* Represents a block as defined by the Nano cryptocurrency protocol. The Block
+* class is abstract and cannot be directly instantiated. Every block must be one
+* of three derived classes: SendBlock, ReceiveBlock, ChangeBlock.
+*/
+declare abstract class Block {
+ account: Account
+ type: 'state'
+ abstract subtype: 'send' | 'receive' | 'change'
+ abstract previous: string
+ abstract representative: Account
+ abstract balance: bigint
+ abstract link: string
+ abstract signature?: string
+ abstract work?: string
+ constructor (account: Account | string)
+ /**
+ * Calculates the block hash using Blake2b.
+ *
+ * @returns {Promise<string>} Block data hashed to a byte array
+ */
+ get hash (): string
+ /**
+ * Converts the block to JSON format as expected by the `process` RPC.
+ *
+ * @returns {string} JSON representation of the block
+ */
+ toJSON (): {
+ [key: string]: string
+ }
+ /**
+ * Calculates proof-of-work using a pool of Web Workers.
+ *
+ * A successful response sets the `work` property.
+ */
+ pow (): Promise<void>
+ /**
+ * Signs the block using a private key. If a key is not provided, the private
+ * key of the block's account will be used if it exists. If that fails, an
+ * error is thrown.
+ *
+ * If successful, the result is stored in the object's `signature`
+ * property.
+ *
+ * @param {string} [key] - Hexadecimal-formatted private key to use for signing
+ */
+ sign (key?: string): Promise<void>
+ /**
+ * Signs the block using a Ledger hardware wallet. If that fails, an error is
+ * thrown with the status code from the device.
+ *
+ * If successful, the result is stored in the object's `signature`
+ * property.
+ *
+ * @param {number} index - Account index between 0x0 and 0x7fffffff
+ * @param {object} [block] - JSON of previous block for offline signing
+ */
+ sign (index?: number, block?: {
+ [key: string]: string
+ }): Promise<void>
+ /**
+ * Sends the block to a node for processing on the network.
+ *
+ * The block must already be signed (see `sign()` for more information).
+ * The block must also have a `work` value.
+ *
+ * @param {Rpc|string|URL} rpc - RPC node information required to call `process`
+ * @returns {Promise<string>} Hash of the processed block
+ */
+ process (rpc: Rpc): Promise<string>
+ /**
+ * Verifies the signature of the block. If a key is not provided, the public
+ * key of the block's account will be used if it exists.
+ *
+ * @param {string} [key] - Hexadecimal-formatted public key to use for verification
+ * @returns {boolean} True if block was signed by the matching private key
+ */
+ verify (key?: string): Promise<boolean>
+}
+
+/**
+* Represents a block that sends funds from one address to another as defined by
+* the Nano cryptocurrency protocol.
+*/
+export declare class SendBlock extends Block {
+ type: 'state'
+ subtype: 'send'
+ previous: string
+ representative: Account
+ balance: bigint
+ link: string
+ signature?: string
+ work?: string
+ constructor (sender: Account | string, balance: string, recipient: string, amount: string, representative: Account | string, frontier: string, work?: string)
+}
+
+/**
+* Represents a block that receives funds sent to one address from another as
+* defined by the Nano cryptocurrency protocol.
+*/
+export declare class ReceiveBlock extends Block {
+ type: 'state'
+ subtype: 'receive'
+ previous: string
+ representative: Account
+ balance: bigint
+ link: string
+ signature?: string
+ work?: string
+ constructor (recipient: Account | string, balance: string, origin: string, amount: string, representative: Account | string, frontier?: string, work?: string)
+}
+
+/**
+* Represents a block that changes the representative account to which the user
+* account delegates their vote weight using the the Open Representative Voting
+* specification as defined by the Nano cryptocurrency protocol.
+*/
+export declare class ChangeBlock extends Block {
+ type: 'state'
+ subtype: 'change'
+ previous: string
+ representative: Account
+ balance: bigint
+ link: string
+ signature?: string
+ work?: string
+ constructor (account: Account | string, balance: string, representative: Account | string, frontier: string, work?: string)
+}
+
+export declare class AccountList extends Object {
+ [index: number]: Account
+ get length (): number;
+ [Symbol.iterator] (): Iterator<Account>
+}
+
export type Data = {
[key: string]: ArrayBuffer
}
index?: number
}
+export type RolodexEntry = {
+ name: string
+ account: Account
+}
+
+/**
+* Represents a Nano network node. It primarily consists of a URL which will
+* accept RPC calls, and an optional API key header construction can be passed if
+* required by the node. Once instantiated, the Rpc object can be used to call
+* any action supported by the Nano protocol. The URL protocol must be HTTPS; any
+* other value will be changed automatically.
+*/
+export declare class Rpc {
+ constructor (url: string | URL, apiKeyName?: string)
+ /**
+ *
+ * @param {string} action - Nano protocol RPC call to execute
+ * @param {object} [data] - JSON to send to the node as defined by the action
+ * @returns {Promise<any>} JSON-formatted RPC results from the node
+ */
+ call (action: string, data?: {
+ [key: string]: any
+ }): Promise<any>
+}
+
export type SafeRecord = {
iv: string
salt: string
projects / libnemo.git / commitdiff