Class LuzidSnapshot

Constructors

constructor

Properties

client

Methods

createSnapshot deleteSnapshot deleteSnapshotsMatching getSnaphotableAccounts listSnapshots restoreAccountsFromLastUpdatedSnapshot restoreAccountsFromSnapshot retrieveAccountsInSnapshot

Constructors

constructor

Properties

Private Readonly client

client: LuzidGrpcClient

Methods

createSnapshot

  • createSnapshot(snapshotName, accounts, opts?): Promise<RpcCreateSnapshotResult>

  • Creates a snapshot of the accounts specified.

    Parameters

    • snapshotName: string

      the name to give the snapshot

    • accounts: string[]

      the accounts to include in the snapshot

    • opts: {
          commitment?: "processed" | "confirmed" | "finalized";
          description?: string;
          group?: string;
      } = {}

      optional parameters to control the snapshot creation

      • Optional commitment?: "processed" | "confirmed" | "finalized"

        the commitment used to determine the account state included in the snapshot

      • Optional description?: string

        description of the snapshot

      • Optional group?: string

        group of the snapshot

    Returns Promise<RpcCreateSnapshotResult>

    the id of the snapshot and the number of accounts included

deleteSnapshot

  • deleteSnapshot(snapshotId): Promise<string>

  • Deletes the snapshot with the given id if it exists.

    Parameters

    • snapshotId: string

      the id of the snapshot to delete

    Returns Promise<string>

    the id of the deleted snapshot

deleteSnapshotsMatching

  • deleteSnapshotsMatching(filter?): Promise<string[]>

  • Deletes all globally stored snaphots.

    Parameters

    • Optional filter: SnapshotFilter

      optional filter to apply to the snapshots returned

    Returns Promise<string[]>

    the ids of the deleted snapshots

getSnaphotableAccounts

  • getSnaphotableAccounts(opts?): Promise<RpcSnapshotableAccount[]>

  • Returns the pubkeys of accounts that can be snapshotted.

    Parameters

    • opts: {
          commitment?: "processed" | "confirmed" | "finalized";
          includeProgramAccounts?: boolean;
      } = {}

      optional parameters to configure which accounts are included

      • Optional commitment?: "processed" | "confirmed" | "finalized"

        the commitment the accounts must have reached

      • Optional includeProgramAccounts?: boolean

        whether to include program accounts

    Returns Promise<RpcSnapshotableAccount[]>

listSnapshots

  • listSnapshots(filter?): Promise<RpcSnapshotMetadata[]>

  • Lists all snapshots that have been created with Luzid.

    Parameters

    • Optional filter: SnapshotFilter

      optional filter to apply to the snapshots returned

    Returns Promise<RpcSnapshotMetadata[]>

restoreAccountsFromLastUpdatedSnapshot

  • restoreAccountsFromLastUpdatedSnapshot(opts?): Promise<Successful<RpcSnapshotRestoreResult>>

  • Restores accounts from the snapshot that was updated most recently.

    Parameters

    • Optional opts: {
          accounts?: string[];
          commitment?: "processed" | "confirmed" | "finalized";
          deleteSnapshotAfterRestore?: boolean;
          filter?: SnapshotFilter;
      }

      optional parameters to control the restore process

      • Optional accounts?: string[]

        the accounts to restore, not provided all accounts inside the snapshot will be restored

      • Optional commitment?: "processed" | "confirmed" | "finalized"

        the commitment the restore transaction must reach before this method returns

      • Optional deleteSnapshotAfterRestore?: boolean

        whether to delete the snapshot after it was restored (default: false)

      • Optional filter?: SnapshotFilter

        optional filter to limit the snapshots that are considered when finding the last updated snapshot

    Returns Promise<Successful<RpcSnapshotRestoreResult>>

restoreAccountsFromSnapshot

  • restoreAccountsFromSnapshot(snapshotId, opts?): Promise<Successful<RpcSnapshotRestoreResult>>

  • Restores accounts from a snapshot.

    Parameters

    • snapshotId: string

      the id of the snapshot to retrieve accounts from

    • Optional opts: {
          accounts?: string[];
          commitment?: "processed" | "confirmed" | "finalized";
          deleteSnapshotAfterRestore?: boolean;
      }

      optional parameters to control the restore process

      • Optional accounts?: string[]

        the accounts to restore, not provided all accounts inside the snapshot will be restored

      • Optional commitment?: "processed" | "confirmed" | "finalized"

        the commitment the restore transaction must reach before this method returns

      • Optional deleteSnapshotAfterRestore?: boolean

        whether to delete the snapshot after it was restored (default: false)

    Returns Promise<Successful<RpcSnapshotRestoreResult>>

retrieveAccountsInSnapshot

  • retrieveAccountsInSnapshot(snapshotId): Promise<RpcSnapshotAccountSummary[]>

  • Returns the information of all accounts that are in a snapshot.

    • **snapshotId - the id of the snapshot to retrieve accounts from

    The returned accounts have the following properties:

    Parameters

    • snapshotId: string

    Returns Promise<RpcSnapshotAccountSummary[]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc