@argonprotocol/localchain 1.0.11 → 1.0.13

package/cli.js

@@ -1,4 +1,4 @@
 #!/usr/bin/env node
 
-const {runCli} = require('./index.js')
+const { runCli } = require('./index.js');
 runCli().catch(console.error);

package/index.d.ts

@@ -1,367 +1,482 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
 export class AccountStore {
-  getDepositAccount(notaryId?: number | undefined | null): Promise<LocalAccount>
-  getTaxAccount(notaryId?: number | undefined | null): Promise<LocalAccount>
-  get(address: string, accountType: AccountType, notaryId: number): Promise<LocalAccount>
-  getById(id: number): Promise<LocalAccount>
-  hasAccount(address: string, accountType: AccountType, notaryId: number): Promise<boolean>
+  getDepositAccount(
+    notaryId?: number | undefined | null,
+  ): Promise<LocalAccount>;
+  getTaxAccount(notaryId?: number | undefined | null): Promise<LocalAccount>;
+  get(
+    address: string,
+    accountType: AccountType,
+    notaryId: number,
+  ): Promise<LocalAccount>;
+  getById(id: number): Promise<LocalAccount>;
+  hasAccount(
+    address: string,
+    accountType: AccountType,
+    notaryId: number,
+  ): Promise<boolean>;
   /** Finds an account with no balance that is not waiting for a send claim */
-  findIdleJumpAccount(accountType: AccountType, notaryId: number): Promise<LocalAccount | null>
-  insert(address: string, accountType: AccountType, notaryId: number, hdPath?: string | undefined | null): Promise<LocalAccount>
-  list(includeJumpAccounts?: boolean | undefined | null): Promise<Array<LocalAccount>>
+  findIdleJumpAccount(
+    accountType: AccountType,
+    notaryId: number,
+  ): Promise<LocalAccount | null>;
+  insert(
+    address: string,
+    accountType: AccountType,
+    notaryId: number,
+    hdPath?: string | undefined | null,
+  ): Promise<LocalAccount>;
+  list(
+    includeJumpAccounts?: boolean | undefined | null,
+  ): Promise<Array<LocalAccount>>;
 }
 
 export class BalanceChange {
-  id: number
-  accountId: number
-  changeNumber: number
-  balance: string
-  netBalanceChange: string
-  channelHoldNoteJson?: string
-  notaryId: number
-  notesJson: string
-  proofJson?: string
-  finalizedBlockNumber?: number
-  status: BalanceChangeStatus
-  transactionId?: number
-  notarizationId?: number
-}
-export type BalanceChangeRow = BalanceChange
+  id: number;
+  accountId: number;
+  changeNumber: number;
+  balance: string;
+  netBalanceChange: string;
+  channelHoldNoteJson?: string;
+  notaryId: number;
+  notesJson: string;
+  proofJson?: string;
+  finalizedBlockNumber?: number;
+  status: BalanceChangeStatus;
+  transactionId?: number;
+  notarizationId?: number;
+}
+export type BalanceChangeRow = BalanceChange;
 
 export class BalanceChangeBuilder {
-  accountType: AccountType
-  address: string
-  localAccountId: number
-  changeNumber: number
-  syncStatus?: BalanceChangeStatus
-  static newAccount(address: string, localAccountId: number, accountType: AccountType): BalanceChangeBuilder
-  isEmptySignature(): Promise<boolean>
-  get balance(): Promise<bigint>
-  get accountId32(): Promise<Uint8Array>
-  isPendingClaim(): Promise<boolean>
-  send(amount: bigint, restrictToAddresses?: Array<string> | undefined | null): Promise<void>
-  claim(amount: bigint): Promise<ClaimResult>
-  claimChannelHold(amount: bigint): Promise<ClaimResult>
-  claimFromMainchain(transfer: LocalchainTransfer): Promise<void>
-  sendToMainchain(amount: bigint): Promise<void>
-  createChannelHold(amount: bigint, paymentAddress: string, domain?: string | undefined | null, delegatedSignerAddress?: string | undefined | null): Promise<void>
-  sendToVote(amount: bigint): Promise<void>
+  accountType: AccountType;
+  address: string;
+  localAccountId: number;
+  changeNumber: number;
+  syncStatus?: BalanceChangeStatus;
+  static newAccount(
+    address: string,
+    localAccountId: number,
+    accountType: AccountType,
+  ): BalanceChangeBuilder;
+  isEmptySignature(): Promise<boolean>;
+  get balance(): Promise<bigint>;
+  get accountId32(): Promise<Uint8Array>;
+  isPendingClaim(): Promise<boolean>;
+  send(
+    amount: bigint,
+    restrictToAddresses?: Array<string> | undefined | null,
+  ): Promise<void>;
+  claim(amount: bigint): Promise<ClaimResult>;
+  claimChannelHold(amount: bigint): Promise<ClaimResult>;
+  claimFromMainchain(transfer: LocalchainTransfer): Promise<void>;
+  sendToMainchain(amount: bigint): Promise<void>;
+  createChannelHold(
+    amount: bigint,
+    paymentAddress: string,
+    domain?: string | undefined | null,
+    delegatedSignerAddress?: string | undefined | null,
+  ): Promise<void>;
+  sendToVote(amount: bigint): Promise<void>;
   /** Lease a Domain. Domain leases are converted in full to tax. */
-  leaseDomain(): Promise<bigint>
+  leaseDomain(): Promise<bigint>;
   /** Create scale encoded signature message for the balance change. */
-  static toSigningMessage(balanceChangeJson: string): Uint8Array
+  static toSigningMessage(balanceChangeJson: string): Uint8Array;
 }
 
 export class BalanceChangeStore {
-  allForAccount(accountId: number): Promise<Array<BalanceChange>>
-  getLatestForAccount(accountId: number): Promise<BalanceChange | null>
-  cancel(id: number): Promise<void>
-  getById(id: number): Promise<BalanceChange>
-  findUnsettled(): Promise<Array<BalanceChange>>
+  allForAccount(accountId: number): Promise<Array<BalanceChange>>;
+  getLatestForAccount(accountId: number): Promise<BalanceChange | null>;
+  cancel(id: number): Promise<void>;
+  getById(id: number): Promise<BalanceChange>;
+  findUnsettled(): Promise<Array<BalanceChange>>;
 }
 
 export class BalanceSync {
-  constructor(localchain: Localchain)
-  sync(options?: VoteCreationOptions | undefined | null): Promise<BalanceSyncResult>
-  consolidateJumpAccounts(): Promise<Array<NotarizationTracker>>
-  syncUnsettledBalances(): Promise<Array<BalanceChange>>
-  syncMainchainTransfers(): Promise<Array<NotarizationTracker>>
-  convertTaxToVotes(options: VoteCreationOptions): Promise<Array<NotarizationTracker>>
-  syncBalanceChange(balanceChange: BalanceChange): Promise<BalanceChange>
-  processPendingChannelHolds(): Promise<ChannelHoldResult>
+  constructor(localchain: Localchain);
+  sync(
+    options?: VoteCreationOptions | undefined | null,
+  ): Promise<BalanceSyncResult>;
+  consolidateJumpAccounts(): Promise<Array<NotarizationTracker>>;
+  syncUnsettledBalances(): Promise<Array<BalanceChange>>;
+  syncMainchainTransfers(): Promise<Array<NotarizationTracker>>;
+  convertTaxToVotes(
+    options: VoteCreationOptions,
+  ): Promise<Array<NotarizationTracker>>;
+  syncBalanceChange(balanceChange: BalanceChange): Promise<BalanceChange>;
+  processPendingChannelHolds(): Promise<ChannelHoldResult>;
 }
 
 export class BalanceSyncResult {
-  get balanceChanges(): Array<BalanceChange>
-  get channelHoldNotarizations(): Array<NotarizationTracker>
-  get channelHoldsUpdated(): Array<ChannelHold>
-  get mainchainTransfers(): Array<NotarizationTracker>
-  get jumpAccountConsolidations(): Array<NotarizationTracker>
-  get blockVotes(): Array<NotarizationTracker>
+  get balanceChanges(): Array<BalanceChange>;
+  get channelHoldNotarizations(): Array<NotarizationTracker>;
+  get channelHoldsUpdated(): Array<ChannelHold>;
+  get mainchainTransfers(): Array<NotarizationTracker>;
+  get jumpAccountConsolidations(): Array<NotarizationTracker>;
+  get blockVotes(): Array<NotarizationTracker>;
 }
 
 export class BalanceTipResult {
-  balanceTip: Uint8Array
-  notebookNumber: number
-  tick: number
+  balanceTip: Uint8Array;
+  notebookNumber: number;
+  tick: number;
 }
 
 export class ChannelHold {
-  id: string
-  initialBalanceChangeJson: string
-  notaryId: number
-  fromAddress: string
-  delegatedSignerAddress?: string
-  toAddress: string
-  domainHash?: Array<number>
-  expirationTick: number
-  balanceChangeNumber: number
-  notarizationId?: number
-  isClient: boolean
-  missedClaimWindow: boolean
-  get holdAmount(): bigint
-  get settledAmount(): bigint
-  get settledSignature(): Uint8Array
-  isPastClaimPeriod(currentTick: number): boolean
+  id: string;
+  initialBalanceChangeJson: string;
+  notaryId: number;
+  fromAddress: string;
+  delegatedSignerAddress?: string;
+  toAddress: string;
+  domainHash?: Array<number>;
+  expirationTick: number;
+  balanceChangeNumber: number;
+  notarizationId?: number;
+  isClient: boolean;
+  missedClaimWindow: boolean;
+  get holdAmount(): bigint;
+  get settledAmount(): bigint;
+  get settledSignature(): Uint8Array;
+  isPastClaimPeriod(currentTick: number): boolean;
 }
 
 export class ChannelHoldResult {
-  get channelHoldNotarizations(): Array<NotarizationTracker>
-  get channelHoldsUpdated(): Array<ChannelHold>
+  get channelHoldNotarizations(): Array<NotarizationTracker>;
+  get channelHoldsUpdated(): Array<ChannelHold>;
 }
 
 export class DomainLease {
-  id: number
-  name: string
-  topLevel: string
-  registeredToAddress: string
-  notarizationId: number
-  registeredAtTick: number
+  id: number;
+  name: string;
+  topLevel: string;
+  registeredToAddress: string;
+  notarizationId: number;
+  registeredAtTick: number;
 }
-export type DomainRow = DomainLease
+export type DomainRow = DomainLease;
 
 export class DomainStore {
-  static tldFromString(topLevel: string): DomainTopLevel
-  get list(): Promise<Array<DomainLease>>
-  hashDomain(domain: JsDomain): Uint8Array
-  static getHash(domain: string): Uint8Array
-  static parse(domain: string): Domain
-  get(id: number): Promise<DomainLease>
+  static tldFromString(topLevel: string): DomainTopLevel;
+  get list(): Promise<Array<DomainLease>>;
+  hashDomain(domain: JsDomain): Uint8Array;
+  static getHash(domain: string): Uint8Array;
+  static parse(domain: string): Domain;
+  get(id: number): Promise<DomainLease>;
 }
 
 export class Keystore {
-  useExternal(defaultAddress: string, sign: (address: string, signatureMessage: Uint8Array) => Promise<Uint8Array>, derive: (hdPath: string) => Promise<string>): Promise<void>
+  useExternal(
+    defaultAddress: string,
+    sign: (
+      address: string,
+      signatureMessage: Uint8Array,
+    ) => Promise<Uint8Array>,
+    derive: (hdPath: string) => Promise<string>,
+  ): Promise<void>;
   /** Bootstrap this localchain with a new key. Must be empty or will throw an error! Defaults to SR25519 if no scheme is provided. */
-  bootstrap(scheme?: CryptoScheme | undefined | null, passwordOption?: KeystorePasswordOption | undefined | null): Promise<string>
+  bootstrap(
+    scheme?: CryptoScheme | undefined | null,
+    passwordOption?: KeystorePasswordOption | undefined | null,
+  ): Promise<string>;
   /** Import a known keypair into the embedded keystore. */
-  importSuri(suri: string, scheme: CryptoScheme, passwordOption?: KeystorePasswordOption | undefined | null): Promise<string>
-  unlock(passwordOption?: KeystorePasswordOption | undefined | null): Promise<void>
-  lock(): Promise<void>
-  isUnlocked(): Promise<boolean>
-  deriveAccountId(hdPath: string): Promise<string>
-  sign(address: string, message: Uint8Array): Promise<Uint8Array>
+  importSuri(
+    suri: string,
+    scheme: CryptoScheme,
+    passwordOption?: KeystorePasswordOption | undefined | null,
+  ): Promise<string>;
+  unlock(
+    passwordOption?: KeystorePasswordOption | undefined | null,
+  ): Promise<void>;
+  lock(): Promise<void>;
+  isUnlocked(): Promise<boolean>;
+  deriveAccountId(hdPath: string): Promise<string>;
+  sign(address: string, message: Uint8Array): Promise<Uint8Array>;
 }
 
 export class LocalAccount {
-  id: number
-  address: string
-  hdPath?: string
-  accountId32: string
-  notaryId: number
-  accountType: AccountType
-  createdAt: number
-  updatedAt: number
-  origin?: NotaryAccountOrigin
+  id: number;
+  address: string;
+  hdPath?: string;
+  accountId32: string;
+  notaryId: number;
+  accountType: AccountType;
+  createdAt: number;
+  updatedAt: number;
+  origin?: NotaryAccountOrigin;
 }
 
 export class Localchain {
-  path: string
-  static load(config: LocalchainConfig): Promise<Localchain>
-  static loadWithoutMainchain(path: string, tickerConfig: TickerConfig, keystorePassword?: KeystorePasswordOption | undefined | null): Promise<Localchain>
-  attachMainchain(mainchainClient: MainchainClient): Promise<void>
-  updateTicker(ntpSyncPoolUrl?: string | undefined | null): Promise<void>
-  close(): Promise<void>
-  accountOverview(): Promise<LocalchainOverview>
-  static getDefaultDir(): string
-  static setDefaultDir(value: string): void
-  static getDefaultPath(): string
-  get address(): Promise<string>
-  get name(): string
-  get currentTick(): number
-  durationToNextTick(): bigint
-  get ticker(): TickerRef
-  get keystore(): Keystore
-  get mainchainClient(): Promise<MainchainClient | null>
-  get mainchainTransfers(): MainchainTransferStore
-  get notaryClients(): NotaryClients
-  get accounts(): AccountStore
-  get balanceChanges(): BalanceChangeStore
-  get domains(): DomainStore
-  get openChannelHolds(): OpenChannelHoldsStore
-  get balanceSync(): BalanceSync
-  get transactions(): Transactions
-  beginChange(): NotarizationBuilder
+  path: string;
+  static load(config: LocalchainConfig): Promise<Localchain>;
+  static loadWithoutMainchain(
+    path: string,
+    tickerConfig: TickerConfig,
+    keystorePassword?: KeystorePasswordOption | undefined | null,
+  ): Promise<Localchain>;
+  attachMainchain(mainchainClient: MainchainClient): Promise<void>;
+  updateTicker(ntpSyncPoolUrl?: string | undefined | null): Promise<void>;
+  close(): Promise<void>;
+  accountOverview(): Promise<LocalchainOverview>;
+  static getDefaultDir(): string;
+  static setDefaultDir(value: string): void;
+  static getDefaultPath(): string;
+  get address(): Promise<string>;
+  get name(): string;
+  get currentTick(): number;
+  durationToNextTick(): bigint;
+  get ticker(): TickerRef;
+  get keystore(): Keystore;
+  get mainchainClient(): Promise<MainchainClient | null>;
+  get mainchainTransfers(): MainchainTransferStore;
+  get notaryClients(): NotaryClients;
+  get accounts(): AccountStore;
+  get balanceChanges(): BalanceChangeStore;
+  get domains(): DomainStore;
+  get openChannelHolds(): OpenChannelHoldsStore;
+  get balanceSync(): BalanceSync;
+  get transactions(): Transactions;
+  beginChange(): NotarizationBuilder;
 }
 
 export class MainchainClient {
-  host: string
-  close(): Promise<void>
-  static connect(host: string, timeoutMillis: number): Promise<MainchainClient>
-  getTicker(): Promise<Ticker>
-  getChainIdentity(): Promise<ChainIdentity>
-  getBestBlockHash(): Promise<Uint8Array>
-  getVoteBlockHash(currentTick: number): Promise<BestBlockForVote | null>
-  getDomainRegistration(domainName: string, topLevel: DomainTopLevel): Promise<DomainRegistration | null>
-  getDomainZoneRecord(domainName: string, topLevel: DomainTopLevel): Promise<ZoneRecord | null>
-  getNotaryDetails(notaryId: number): Promise<NotaryDetails | null>
-  getAccount(address: string): Promise<AccountInfo>
-  getOwnership(address: string): Promise<BalancesAccountData>
-  getTransferToLocalchainFinalizedBlock(transferId: number): Promise<number | null>
-  waitForLocalchainTransfer(transferId: number): Promise<LocalchainTransfer | null>
-  getAccountChangesRoot(notaryId: number, notebookNumber: number): Promise<Uint8Array | null>
-  latestFinalizedNumber(): Promise<number>
-  waitForNotebookImmortalized(notaryId: number, notebookNumber: number): Promise<number>
+  host: string;
+  close(): Promise<void>;
+  static connect(host: string, timeoutMillis: number): Promise<MainchainClient>;
+  getTicker(): Promise<Ticker>;
+  getChainIdentity(): Promise<ChainIdentity>;
+  getBestBlockHash(): Promise<Uint8Array>;
+  getVoteBlockHash(currentTick: number): Promise<BestBlockForVote | null>;
+  getDomainRegistration(
+    domainName: string,
+    topLevel: DomainTopLevel,
+  ): Promise<DomainRegistration | null>;
+  getDomainZoneRecord(
+    domainName: string,
+    topLevel: DomainTopLevel,
+  ): Promise<ZoneRecord | null>;
+  getNotaryDetails(notaryId: number): Promise<NotaryDetails | null>;
+  getAccount(address: string): Promise<AccountInfo>;
+  getOwnership(address: string): Promise<BalancesAccountData>;
+  getTransferToLocalchainFinalizedBlock(
+    transferId: number,
+  ): Promise<number | null>;
+  waitForLocalchainTransfer(
+    transferId: number,
+  ): Promise<LocalchainTransfer | null>;
+  getAccountChangesRoot(
+    notaryId: number,
+    notebookNumber: number,
+  ): Promise<Uint8Array | null>;
+  latestFinalizedNumber(): Promise<number>;
+  waitForNotebookImmortalized(
+    notaryId: number,
+    notebookNumber: number,
+  ): Promise<number>;
 }
 
 export class MainchainTransferStore {
-  sendToLocalchain(amount: bigint, notaryId?: number | undefined | null): Promise<LocalchainTransfer>
+  sendToLocalchain(
+    amount: bigint,
+    notaryId?: number | undefined | null,
+  ): Promise<LocalchainTransfer>;
 }
 
 export class NotarizationBuilder {
-  set notaryId(notaryId: number)
-  get notaryId(): Promise<number>
-  set transaction(transaction: LocalchainTransaction)
-  get transaction(): Promise<LocalchainTransaction | null>
-  get isFinalized(): Promise<boolean>
-  get unclaimedTax(): Promise<bigint>
-  get channelHolds(): Promise<Array<ChannelHold>>
-  get accounts(): Promise<Array<LocalAccount>>
-  get balanceChangeBuilders(): Promise<Array<BalanceChangeBuilder>>
-  get unusedVoteFunds(): Promise<bigint>
-  get unusedDomainFunds(): Promise<bigint>
-  get unclaimedDeposits(): Promise<bigint>
-  getBalanceChange(account: LocalAccount): Promise<BalanceChangeBuilder>
-  addAccount(address: string, accountType: AccountType, notaryId: number): Promise<BalanceChangeBuilder>
-  addAccountById(localAccountId: number): Promise<BalanceChangeBuilder>
-  getJumpAccount(accountType: AccountType): Promise<BalanceChangeBuilder>
-  defaultDepositAccount(): Promise<BalanceChangeBuilder>
-  defaultTaxAccount(): Promise<BalanceChangeBuilder>
-  loadAccount(account: LocalAccount): Promise<BalanceChangeBuilder>
-  canAddChannelHold(channelHold: OpenChannelHold): Promise<boolean>
-  cancelChannelHold(openChannelHold: OpenChannelHold): Promise<void>
-  claimChannelHold(openChannelHold: OpenChannelHold): Promise<void>
-  addVote(vote: BlockVote): Promise<void>
-  leaseDomain(domain: string, registerToAddress: string): Promise<void>
+  set notaryId(notaryId: number);
+  get notaryId(): Promise<number>;
+  set transaction(transaction: LocalchainTransaction);
+  get transaction(): Promise<LocalchainTransaction | null>;
+  get isFinalized(): Promise<boolean>;
+  get unclaimedTax(): Promise<bigint>;
+  get channelHolds(): Promise<Array<ChannelHold>>;
+  get accounts(): Promise<Array<LocalAccount>>;
+  get balanceChangeBuilders(): Promise<Array<BalanceChangeBuilder>>;
+  get unusedVoteFunds(): Promise<bigint>;
+  get unusedDomainFunds(): Promise<bigint>;
+  get unclaimedDeposits(): Promise<bigint>;
+  getBalanceChange(account: LocalAccount): Promise<BalanceChangeBuilder>;
+  addAccount(
+    address: string,
+    accountType: AccountType,
+    notaryId: number,
+  ): Promise<BalanceChangeBuilder>;
+  addAccountById(localAccountId: number): Promise<BalanceChangeBuilder>;
+  getJumpAccount(accountType: AccountType): Promise<BalanceChangeBuilder>;
+  defaultDepositAccount(): Promise<BalanceChangeBuilder>;
+  defaultTaxAccount(): Promise<BalanceChangeBuilder>;
+  loadAccount(account: LocalAccount): Promise<BalanceChangeBuilder>;
+  canAddChannelHold(channelHold: OpenChannelHold): Promise<boolean>;
+  cancelChannelHold(openChannelHold: OpenChannelHold): Promise<void>;
+  claimChannelHold(openChannelHold: OpenChannelHold): Promise<void>;
+  addVote(vote: BlockVote): Promise<void>;
+  leaseDomain(domain: string, registerToAddress: string): Promise<void>;
   /** Calculates the transfer tax on the given amount */
-  getTransferTaxAmount(amount: bigint): bigint
+  getTransferTaxAmount(amount: bigint): bigint;
   /** Calculates the total needed to end up with the given balance */
-  getTotalForAfterTaxBalance(finalBalance: bigint): bigint
-  getChannelHoldTaxAmount(amount: bigint): bigint
-  claimFromMainchain(transfer: LocalchainTransfer): Promise<BalanceChangeBuilder>
-  claimAndPayTax(microgonsPlusTax: bigint, depositAccountId: number | undefined | null, useDefaultTaxAccount: boolean): Promise<BalanceChangeBuilder>
-  fundJumpAccount(microgons: bigint): Promise<BalanceChangeBuilder>
-  acceptArgonFileRequest(argonFileJson: string): Promise<void>
-  importArgonFile(argonFileJson: string): Promise<void>
+  getTotalForAfterTaxBalance(finalBalance: bigint): bigint;
+  getChannelHoldTaxAmount(amount: bigint): bigint;
+  claimFromMainchain(
+    transfer: LocalchainTransfer,
+  ): Promise<BalanceChangeBuilder>;
+  claimAndPayTax(
+    microgonsPlusTax: bigint,
+    depositAccountId: number | undefined | null,
+    useDefaultTaxAccount: boolean,
+  ): Promise<BalanceChangeBuilder>;
+  fundJumpAccount(microgons: bigint): Promise<BalanceChangeBuilder>;
+  acceptArgonFileRequest(argonFileJson: string): Promise<void>;
+  importArgonFile(argonFileJson: string): Promise<void>;
   /**
    * Exports an argon file from this notarization builder with the intention that these will be sent to another
    * user (who will import into their own localchain).
    */
-  exportAsFile(fileType: ArgonFileType): Promise<string>
-  toJSON(): Promise<string>
-  notarizeAndWaitForNotebook(): Promise<NotarizationTracker>
-  notarize(): Promise<NotarizationTracker>
-  verify(): Promise<void>
-  sign(): Promise<void>
+  exportAsFile(fileType: ArgonFileType): Promise<string>;
+  toJSON(): Promise<string>;
+  notarizeAndWaitForNotebook(): Promise<NotarizationTracker>;
+  notarize(): Promise<NotarizationTracker>;
+  verify(): Promise<void>;
+  sign(): Promise<void>;
 }
 
 export class NotarizationTracker {
-  notebookNumber: number
-  tick: number
-  notaryId: number
-  notarizationId: number
-  notarizedBalanceChanges: number
-  notarizedVotes: number
+  notebookNumber: number;
+  tick: number;
+  notaryId: number;
+  notarizationId: number;
+  notarizedBalanceChanges: number;
+  notarizedVotes: number;
   /** Returns the balance changes that were submitted to the notary indexed by the stringified account id (napi doesn't allow numbers as keys) */
-  get balanceChangesByAccountId(): Promise<Record<string, BalanceChange>>
-  waitForNotebook(): Promise<void>
-  get channelHolds(): Promise<Array<ChannelHold>>
+  get balanceChangesByAccountId(): Promise<Record<string, BalanceChange>>;
+  waitForNotebook(): Promise<void>;
+  get channelHolds(): Promise<Array<ChannelHold>>;
   /** Asks the notary for proof the transaction was included in a notebook header. If this notebook has not been finalized yet, it will return an error. */
-  getNotebookProof(): Promise<Array<NotebookProof>>
+  getNotebookProof(): Promise<Array<NotebookProof>>;
   /** Confirms the root added to the mainchain */
-  waitForImmortalized(mainchainClient: MainchainClient): Promise<ImmortalizedBlock>
+  waitForImmortalized(
+    mainchainClient: MainchainClient,
+  ): Promise<ImmortalizedBlock>;
 }
 
 export class NotaryClient {
-  notaryId: number
-  autoVerifyHeaderSignatures: boolean
-  isConnected(): Promise<boolean>
-  static connect(notaryId: number, publicKey: Uint8Array, host: string, autoVerifyHeaderSignatures: boolean): Promise<NotaryClient>
-  getBalanceTip(address: string, accountType: AccountType): Promise<BalanceTipResult>
-  get metadata(): Promise<NotebookMeta>
+  notaryId: number;
+  autoVerifyHeaderSignatures: boolean;
+  isConnected(): Promise<boolean>;
+  static connect(
+    notaryId: number,
+    publicKey: Uint8Array,
+    host: string,
+    autoVerifyHeaderSignatures: boolean,
+  ): Promise<NotaryClient>;
+  getBalanceTip(
+    address: string,
+    accountType: AccountType,
+  ): Promise<BalanceTipResult>;
+  subscribeHeaders(
+    callback: (arg0: NotebookNumber, arg1: Tick) => any,
+  ): Promise<Subscription>;
+  get metadata(): Promise<NotebookMeta>;
 }
 
 export class NotaryClients {
-  static new(mainchainClient: MainchainClient): NotaryClients
-  close(): Promise<void>
-  useClient(client: NotaryClient): Promise<void>
-  get(notaryId: number): Promise<NotaryClient>
+  static new(mainchainClient: MainchainClient): NotaryClients;
+  close(): Promise<void>;
+  useClient(client: NotaryClient): Promise<void>;
+  get(notaryId: number): Promise<NotaryClient>;
 }
 
 export class OpenChannelHold {
-  get channelHold(): Promise<ChannelHold>
-  sign(settledAmount: bigint): Promise<SignatureResult>
-  exportForSend(): Promise<string>
-  recordUpdatedSettlement(microgons: bigint, signature: Uint8Array): Promise<void>
+  get channelHold(): Promise<ChannelHold>;
+  sign(settledAmount: bigint): Promise<SignatureResult>;
+  exportForSend(): Promise<string>;
+  recordUpdatedSettlement(
+    microgons: bigint,
+    signature: Uint8Array,
+  ): Promise<void>;
 }
 
 export class OpenChannelHoldsStore {
-  get(id: string): Promise<OpenChannelHold>
-  open(channelHold: ChannelHold): OpenChannelHold
-  getClaimable(): Promise<Array<OpenChannelHold>>
+  get(id: string): Promise<OpenChannelHold>;
+  open(channelHold: ChannelHold): OpenChannelHold;
+  getClaimable(): Promise<Array<OpenChannelHold>>;
   /** Import a channel_hold from a JSON string. Verifies with the notary that the channel hold is valid. */
-  importChannelHold(channelHoldJson: string): Promise<OpenChannelHold>
+  importChannelHold(channelHoldJson: string): Promise<OpenChannelHold>;
   /** Create a new channel_hold as a client. You must first notarize a channel hold note to the notary for the `client_address`. */
-  openClientChannelHold(accountId: number): Promise<OpenChannelHold>
+  openClientChannelHold(accountId: number): Promise<OpenChannelHold>;
 }
 
 export class OverviewStore {
-  get(): Promise<LocalchainOverview>
+  get(): Promise<LocalchainOverview>;
+}
+
+export class Subscription {
+  /** Cancels the subscription. */
+  cancel(): Promise<void>;
 }
 
 export class TickerRef {
-  get current(): number
-  tickForTime(timestampMillis: number): bigint
-  timeForTick(tick: number): number
-  millisToNextTick(): number
-  get channelHoldExpirationTicks(): number
+  get current(): number;
+  tickForTime(timestampMillis: number): bigint;
+  timeForTick(tick: number): number;
+  millisToNextTick(): number;
+  get channelHoldExpirationTicks(): number;
 }
 
 export class Transactions {
-  create(transactionType: TransactionType): Promise<LocalchainTransaction>
-  request(microgons: bigint): Promise<string>
-  createChannelHold(channelHoldMicrogons: bigint, recipientAddress: string, domain?: string | undefined | null, notaryId?: number | undefined | null, delegatedSignerAddress?: string | undefined | null): Promise<OpenChannelHold>
-  send(microgons: bigint, to?: Array<string> | undefined | null): Promise<string>
-  importArgons(argonFile: string): Promise<NotarizationTracker>
-  acceptArgonRequest(argonFile: string): Promise<NotarizationTracker>
+  create(transactionType: TransactionType): Promise<LocalchainTransaction>;
+  request(microgons: bigint): Promise<string>;
+  createChannelHold(
+    channelHoldMicrogons: bigint,
+    recipientAddress: string,
+    domain?: string | undefined | null,
+    notaryId?: number | undefined | null,
+    delegatedSignerAddress?: string | undefined | null,
+  ): Promise<OpenChannelHold>;
+  send(
+    microgons: bigint,
+    to?: Array<string> | undefined | null,
+  ): Promise<string>;
+  importArgons(argonFile: string): Promise<NotarizationTracker>;
+  acceptArgonRequest(argonFile: string): Promise<NotarizationTracker>;
 }
 
 export interface AccountInfo {
-  nonce: number
-  consumers: number
-  providers: number
-  sufficients: number
-  data: BalancesAccountData
+  nonce: number;
+  consumers: number;
+  providers: number;
+  sufficients: number;
+  data: BalancesAccountData;
 }
 
 export enum AccountType {
   Tax = 'tax',
-  Deposit = 'deposit'
+  Deposit = 'deposit',
 }
 
-export const ADDRESS_PREFIX: number
+export const ADDRESS_PREFIX: number;
 
 /** The version of the Argon file format. */
-export const ARGON_FILE_VERSION: string
+export const ARGON_FILE_VERSION: string;
 
 export enum ArgonFileType {
   Send = 0,
-  Request = 1
+  Request = 1,
 }
 
 export interface BalanceChangeGroup {
-  netBalanceChange: bigint
-  netTax: bigint
-  heldBalance: bigint
-  timestamp: number
-  notes: Array<string>
-  finalizedBlockNumber?: number
-  status: BalanceChangeStatus
-  notarizationId?: number
-  transactionId?: number
-  transactionType?: TransactionType
-  balanceChanges: Array<BalanceChangeSummary>
-  notebookNumber?: number
+  netBalanceChange: bigint;
+  netTax: bigint;
+  heldBalance: bigint;
+  timestamp: number;
+  notes: Array<string>;
+  finalizedBlockNumber?: number;
+  status: BalanceChangeStatus;
+  notarizationId?: number;
+  transactionId?: number;
+  transactionType?: TransactionType;
+  balanceChanges: Array<BalanceChangeSummary>;
+  notebookNumber?: number;
 }
 
 export enum BalanceChangeStatus {
@@ -376,125 +491,125 @@ export enum BalanceChangeStatus {
   /** A balance change has been sent to another user to claim. Keep checking until it is claimed. */
   WaitingForSendClaim = 'WaitingForSendClaim',
   /** A pending balance change that was canceled before being claimed by another user (channel_hold or send). */
-  Canceled = 'Canceled'
+  Canceled = 'Canceled',
 }
 
 export interface BalanceChangeSummary {
-  id: number
-  finalBalance: bigint
-  holdBalance: bigint
-  netBalanceChange: bigint
-  changeNumber: number
-  accountId: number
-  accountType: AccountType
-  isJumpAccount: boolean
-  notes: Array<string>
-  status: BalanceChangeStatus
-  notebookNumber?: number
-  finalizedBlockNumber?: number
+  id: number;
+  finalBalance: bigint;
+  holdBalance: bigint;
+  netBalanceChange: bigint;
+  changeNumber: number;
+  accountId: number;
+  accountType: AccountType;
+  isJumpAccount: boolean;
+  notes: Array<string>;
+  status: BalanceChangeStatus;
+  notebookNumber?: number;
+  finalizedBlockNumber?: number;
 }
 
 export interface BalancesAccountData {
-  free: bigint
-  reserved: bigint
-  frozen: bigint
-  flags: bigint
+  free: bigint;
+  reserved: bigint;
+  frozen: bigint;
+  flags: bigint;
 }
 
 export interface BestBlockForVote {
-  blockHash: Uint8Array
-  voteMinimum: bigint
+  blockHash: Uint8Array;
+  voteMinimum: bigint;
 }
 
 export interface BlockVote {
   /** The creator of the seal */
-  address: string
+  address: string;
   /** The block hash being voted on. Must be in last 2 ticks. */
-  blockHash: Array<number>
+  blockHash: Array<number>;
   /** A unique index per account for this notebook */
-  index: number
+  index: number;
   /** The voting power of this vote, determined from the amount of tax */
-  power: bigint
+  power: bigint;
   /** The tick where a vote was intended */
-  tick: number
+  tick: number;
   /** The domain used to create this vote */
-  domainHash: Array<number>
+  domainHash: Array<number>;
   /** The domain payment address used to create this vote */
-  domainAddress: string
+  domainAddress: string;
   /** The mainchain address where rewards will be sent */
-  blockRewardsAddress: string
+  blockRewardsAddress: string;
   /** A signature of the vote by the account_id */
-  signature: Array<number>
+  signature: Array<number>;
 }
 
 export enum Chain {
   Mainnet = 'mainnet',
   Testnet = 'testnet',
   LocalTestnet = 'local-testnet',
-  Devnet = 'devnet'
+  Devnet = 'devnet',
 }
 
 export interface ChainIdentity {
-  chain: Chain
-  genesis: Buffer
+  chain: Chain;
+  genesis: Buffer;
 }
 
 export interface ChainIdentity {
-  chain: Chain
-  genesisHash: string
+  chain: Chain;
+  genesisHash: string;
 }
 
 /** Number of ticks past the expiration of a channel_hold that a recipient has to claim. After this point, sender can recoup the channel_holded funds */
-export const CHANNEL_HOLD_CLAWBACK_TICKS: number
+export const CHANNEL_HOLD_CLAWBACK_TICKS: number;
 
 /** Minimum amount that can be settled in a channel_hold */
-export const CHANNEL_HOLD_MINIMUM_SETTLEMENT: bigint
+export const CHANNEL_HOLD_MINIMUM_SETTLEMENT: bigint;
 
 export interface ChannelHold {
-  id: string
-  fromAddress: string
-  toAddress: string
-  balanceChangeNumber: number
-  expirationTick: number
-  isClient: boolean
-  initialBalanceChangeJson: string
-  notaryId: number
-  holdAmount: bigint
-  delegatedSignerAddress?: string
-  domainHash?: Buffer
-  notarizationId?: number
-  missedClaimWindow: boolean
-  settledAmount: bigint
+  id: string;
+  fromAddress: string;
+  toAddress: string;
+  balanceChangeNumber: number;
+  expirationTick: number;
+  isClient: boolean;
+  initialBalanceChangeJson: string;
+  notaryId: number;
+  holdAmount: bigint;
+  delegatedSignerAddress?: string;
+  domainHash?: Buffer;
+  notarizationId?: number;
+  missedClaimWindow: boolean;
+  settledAmount: bigint;
 }
 
 export interface ClaimResult {
-  claimed: bigint
-  tax: bigint
+  claimed: bigint;
+  tax: bigint;
 }
 
 export enum CryptoScheme {
   Ed25519 = 0,
   Sr25519 = 1,
-  Ecdsa = 2
+  Ecdsa = 2,
 }
 
 /** Max versions that can be in a datastore zone record */
-export const DATASTORE_MAX_VERSIONS: number
+export const DATASTORE_MAX_VERSIONS: number;
 
 export interface Domain {
-  name: string
-  topLevel: DomainTopLevel
+  name: string;
+  topLevel: DomainTopLevel;
 }
 
 /** Cost to lease a domain for 1 year */
-export const DOMAIN_LEASE_COST: bigint
+export const DOMAIN_LEASE_COST: bigint;
 
 /** Minimum domain name length */
-export const DOMAIN_MIN_NAME_LENGTH: number
+export const DOMAIN_MIN_NAME_LENGTH: number;
 
 export interface DomainRegistration {
-  registeredToAddress: string
-  registeredAtTick: number
+  registeredToAddress: string;
+  registeredAtTick: number;
 }
 
 export enum DomainTopLevel {
@@ -517,12 +632,12 @@ export enum DomainTopLevel {
   Sports = 16,
   Transportation = 17,
   Travel = 18,
-  Weather = 19
+  Weather = 19,
 }
 
 export interface ImmortalizedBlock {
-  immortalizedBlock: number
-  accountChangesMerkleRoot: Uint8Array
+  immortalizedBlock: number;
+  accountChangesMerkleRoot: Uint8Array;
 }
 
 /**
@@ -531,143 +646,143 @@ export interface ImmortalizedBlock {
  */
 export interface KeystorePasswordOption {
   /** Provides a password directly for the keystore. Converted to a SecretString inside Rust, but not cleared out in javascript or napi. */
-  password?: Buffer
+  password?: Buffer;
   /** Initiate a prompt from the cli to load the password. */
-  interactiveCli?: boolean
+  interactiveCli?: boolean;
   /** Load the password from a file. */
-  passwordFile?: string
+  passwordFile?: string;
 }
 
 export interface LocalchainConfig {
-  path: string
-  mainchainUrl: string
-  ntpPoolUrl?: string
-  keystorePassword?: KeystorePasswordOption
+  path: string;
+  mainchainUrl: string;
+  ntpPoolUrl?: string;
+  keystorePassword?: KeystorePasswordOption;
 }
 
 export interface LocalchainOverview {
   /** The name of this localchain */
-  name: string
+  name: string;
   /** The primary localchain address */
-  address: string
+  address: string;
   /** The current account balance */
-  balance: bigint
+  balance: bigint;
   /** The net pending balance change acceptance/confirmation */
-  pendingBalanceChange: bigint
+  pendingBalanceChange: bigint;
   /** Balance held in channel_hold */
-  heldBalance: bigint
+  heldBalance: bigint;
   /** Tax accumulated for the account */
-  tax: bigint
+  tax: bigint;
   /** The net pending tax balance change */
-  pendingTaxChange: bigint
+  pendingTaxChange: bigint;
   /** Changes to the account ordered from most recent to oldest */
-  changes: Array<BalanceChangeGroup>
+  changes: Array<BalanceChangeGroup>;
   /** The mainchain balance */
-  mainchainBalance: bigint
+  mainchainBalance: bigint;
   /** The mainchain identity */
-  mainchainIdentity?: ChainIdentity
+  mainchainIdentity?: ChainIdentity;
   /** The net pending mainchain balance pending movement in/out of the localchain */
-  processingMainchainBalanceChange: bigint
+  processingMainchainBalanceChange: bigint;
 }
 
 export interface LocalchainTransaction {
-  id: number
-  transactionType: TransactionType
+  id: number;
+  transactionType: TransactionType;
 }
 
 export interface LocalchainTransfer {
-  address: string
-  amount: bigint
-  notaryId: number
-  expirationTick: number
-  transferId: number
+  address: string;
+  amount: bigint;
+  notaryId: number;
+  expirationTick: number;
+  transferId: number;
 }
 
 /** Max balance changes that can be in a single notarization */
-export const NOTARIZATION_MAX_BALANCE_CHANGES: number
+export const NOTARIZATION_MAX_BALANCE_CHANGES: number;
 
 /** Max notarizations that can be in a single notarization */
-export const NOTARIZATION_MAX_BLOCK_VOTES: number
+export const NOTARIZATION_MAX_BLOCK_VOTES: number;
 
 /** Max domains that can be in a single notarization */
-export const NOTARIZATION_MAX_DOMAINS: number
+export const NOTARIZATION_MAX_DOMAINS: number;
 
 export interface NotaryAccountOrigin {
-  notaryId: number
-  notebookNumber: number
-  accountUid: number
+  notaryId: number;
+  notebookNumber: number;
+  accountUid: number;
 }
 
 export interface NotaryDetails {
-  id: number
-  hosts: Array<string>
-  publicKey: Uint8Array
+  id: number;
+  hosts: Array<string>;
+  publicKey: Uint8Array;
 }
 
 export interface NotebookMeta {
-  finalizedNotebookNumber: number
-  finalizedTick: number
+  finalizedNotebookNumber: number;
+  finalizedTick: number;
 }
 
 export interface NotebookProof {
-  address: string
-  accountType: AccountType
-  notebookNumber: number
-  balance: bigint
+  address: string;
+  accountType: AccountType;
+  notebookNumber: number;
+  balance: bigint;
   /** H256 hash of the balance tip */
-  balanceTip: Uint8Array
-  changeNumber: number
-  accountOrigin: NotaryAccountOrigin
-  channelHoldNoteJson?: string
-  leafIndex: number
-  numberOfLeaves: number
-  proof: Array<Uint8Array>
+  balanceTip: Uint8Array;
+  changeNumber: number;
+  accountOrigin: NotaryAccountOrigin;
+  channelHoldNoteJson?: string;
+  leafIndex: number;
+  numberOfLeaves: number;
+  proof: Array<Uint8Array>;
 }
 
-export declare function runCli(): Promise<void>
+export declare function runCli(): Promise<void>;
 
 export interface SignatureResult {
-  signature: Uint8Array
-  microgons: bigint
+  signature: Uint8Array;
+  microgons: bigint;
 }
 
 export interface Ticker {
-  tickDurationMillis: number
-  channelHoldExpirationTicks: number
+  tickDurationMillis: number;
+  channelHoldExpirationTicks: number;
 }
 
 export interface TickerConfig {
-  tickDurationMillis: number
-  channelHoldExpirationTicks: number
-  ntpPoolUrl?: string
+  tickDurationMillis: number;
+  channelHoldExpirationTicks: number;
+  ntpPoolUrl?: string;
 }
 
 export enum TransactionType {
   Send = 0,
   Request = 1,
   OpenChannelHold = 2,
-  Consolidation = 3
+  Consolidation = 3,
 }
 
 /** Maximum tax amount that can be charged on a transfer */
-export const TRANSFER_TAX_CAP: bigint
+export const TRANSFER_TAX_CAP: bigint;
 
 export interface VersionHost {
   /** Datastore id is a 2-50 char string that uniquely identifies a domain. */
-  datastoreId: string
+  datastoreId: string;
   /** The host address where the domain can be accessed. */
-  host: string
+  host: string;
 }
 
 export interface VoteCreationOptions {
-  votesAddress?: string
+  votesAddress?: string;
   /** What's the minimum amount of tax we should wait for before voting on blocks */
-  minimumVoteAmount?: number
+  minimumVoteAmount?: number;
 }
 
 export interface ZoneRecord {
-  paymentAddress: string
-  notaryId: number
+  paymentAddress: string;
+  notaryId: number;
   /** A mapping of versions to host addresses. */
-  versions: Record<string, VersionHost>
+  versions: Record<string, VersionHost>;
 }

package/index.js

@@ -386,6 +386,7 @@ module.exports.NotaryClients = nativeBinding.NotaryClients
 module.exports.OpenChannelHold = nativeBinding.OpenChannelHold
 module.exports.OpenChannelHoldsStore = nativeBinding.OpenChannelHoldsStore
 module.exports.OverviewStore = nativeBinding.OverviewStore
+module.exports.Subscription = nativeBinding.Subscription
 module.exports.TickerRef = nativeBinding.TickerRef
 module.exports.Transactions = nativeBinding.Transactions
 module.exports.AccountType = nativeBinding.AccountType

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@argonprotocol/localchain",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "A nodejs binding to the Argon Localchain",
   "bin": "cli.js",
   "publishConfig": {
@@ -40,7 +40,7 @@
     ]
   },
   "devDependencies": {
-    "@argonprotocol/mainchain": "1.0.11",
+    "@argonprotocol/mainchain": "1.0.13",
     "@napi-rs/cli": "3.0.0-alpha.55",
     "@types/http-proxy": "^1.17.14",
     "@types/jest": "^29.5.11",
@@ -77,10 +77,10 @@
   },
   "packageManager": "yarn@4.1.0",
   "optionalDependencies": {
-    "@argonprotocol/localchain-darwin-x64": "1.0.11",
-    "@argonprotocol/localchain-darwin-arm64": "1.0.11",
-    "@argonprotocol/localchain-win32-x64-msvc": "1.0.11",
-    "@argonprotocol/localchain-linux-x64-gnu": "1.0.11",
-    "@argonprotocol/localchain-linux-arm64-gnu": "1.0.11"
+    "@argonprotocol/localchain-darwin-x64": "1.0.13",
+    "@argonprotocol/localchain-darwin-arm64": "1.0.13",
+    "@argonprotocol/localchain-win32-x64-msvc": "1.0.13",
+    "@argonprotocol/localchain-linux-x64-gnu": "1.0.13",
+    "@argonprotocol/localchain-linux-arm64-gnu": "1.0.13"
   }
 }