Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DatastoreRequest

The datastore RPC command allows plugins to store data in the Core Lightning database, for later retrieval.

key is an array of values (though a single value is treated as a one-element array), to form a hierarchy. Using the first element of the key as the plugin name (e.g. [ "summary" ]) is recommended. A key can either have children or a value, never both: parents are created and removed automatically.

mode is one of "must-create" (default, fails if it already exists), "must-replace" (fails if it doesn't already exist), "create-or-replace" (never fails), "must-append" (must already exist, append this to what's already there) or "create-or-append" (append if anything is there, otherwise create).

generation, if specified, means that the update will fail if the previously-existing data is not exactly that generation. This allows for simple atomicity. This is only legal with mode "must-replace" or "must-append".

Hierarchy

  • DatastoreRequest

Index

Properties

generation?: string
hex?: string
key: string | string[]
mode?: "must-create" | "must-replace" | "create-or-replace" | "must-append" | "create-or-append"
string?: string

Generated using TypeDoc