Type Alias AccountNotificationsApi

Type declaration

• accountNotifications:function

  • accountNotifications(
        address: Address,
        config: Readonly<{ commitment?: Commitment }> & Readonly<
            { encoding: "base64" },
        >,
    ): Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • Subscribe to an account to receive notifications when the lamports or data for a given account public key changes.

    The notification format is the same as seen in the getAccountInfo RPC HTTP method.

    Parameters

    • address: Address
    • config: Readonly<{ commitment?: Commitment }> & Readonly<{ encoding: "base64" }>

    Returns Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

    See

    https://docs.solana.com/api/websocket#getAccountInfo

  • accountNotifications(
        address: Address,
        config: Readonly<{ commitment?: Commitment }> & Readonly<
            { encoding: "base64+zstd" },
        >,
    ): Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • Parameters

    • address: Address
    • config: Readonly<{ commitment?: Commitment }> & Readonly<{ encoding: "base64+zstd" }>

    Returns Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • accountNotifications(
        address: Address,
        config: Readonly<{ commitment?: Commitment }> & Readonly<
            { encoding: "jsonParsed" },
        >,
    ): Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • Parameters

    • address: Address
    • config: Readonly<{ commitment?: Commitment }> & Readonly<{ encoding: "jsonParsed" }>

    Returns Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • accountNotifications(
        address: Address,
        config: Readonly<{ commitment?: Commitment }> & Readonly<
            { encoding: "base58" },
        >,
    ): Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • Parameters

    • address: Address
    • config: Readonly<{ commitment?: Commitment }> & Readonly<{ encoding: "base58" }>

    Returns Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • accountNotifications(
        address: Address,
        config?: Readonly<{ commitment?: Commitment }>,
    ): Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • Parameters

    • address: Address
    • Optionalconfig: Readonly<{ commitment?: Commitment }>

    Returns Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>