Type Alias ProgramNotificationsApi

Type declaration

• programNotifications:function

  • programNotifications(
        programId: Address,
        config: Readonly<
            {
                commitment?: Commitment;
                filters?: readonly Readonly<
                    | { dataSize: ProgramNotificationsDatasizeFilter }
                    | {
                        memcmp:
                            | ProgramNotificationsMemcmpFilterBase58
                            | ProgramNotificationsMemcmpFilterBase64;
                    },
                >[];
            },
        > & Readonly<{ encoding: "base64" }>,
    ): Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • Subscribe to a program to receive notifications when the lamports or data for an account owned by the given program changes

    Parameters

    • programId: Address
    • config: Readonly<
          {
              commitment?: Commitment;
              filters?: readonly Readonly<
                  | { dataSize: ProgramNotificationsDatasizeFilter }
                  | {
                      memcmp:
                          | ProgramNotificationsMemcmpFilterBase58
                          | ProgramNotificationsMemcmpFilterBase64;
                  },
              >[];
          },
      > & Readonly<{ encoding: "base64" }>

    Returns Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>
  • programNotifications(
        programId: Address,
        config: Readonly<
            {
                commitment?: Commitment;
                filters?: readonly Readonly<
                    | { dataSize: ProgramNotificationsDatasizeFilter }
                    | {
                        memcmp:
                            | ProgramNotificationsMemcmpFilterBase58
                            | ProgramNotificationsMemcmpFilterBase64;
                    },
                >[];
            },
        > & Readonly<{ encoding: "base64+zstd" }>,
    ): Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • Parameters

    • programId: Address
    • config: Readonly<
          {
              commitment?: Commitment;
              filters?: readonly Readonly<
                  | { dataSize: ProgramNotificationsDatasizeFilter }
                  | {
                      memcmp:
                          | ProgramNotificationsMemcmpFilterBase58
                          | ProgramNotificationsMemcmpFilterBase64;
                  },
              >[];
          },
      > & Readonly<{ encoding: "base64+zstd" }>

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

  • programNotifications(
        programId: Address,
        config: Readonly<
            {
                commitment?: Commitment;
                filters?: readonly Readonly<
                    | { dataSize: ProgramNotificationsDatasizeFilter }
                    | {
                        memcmp:
                            | ProgramNotificationsMemcmpFilterBase58
                            | ProgramNotificationsMemcmpFilterBase64;
                    },
                >[];
            },
        > & Readonly<{ encoding: "jsonParsed" }>,
    ): Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • Parameters

    • programId: Address
    • config: Readonly<
          {
              commitment?: Commitment;
              filters?: readonly Readonly<
                  | { dataSize: ProgramNotificationsDatasizeFilter }
                  | {
                      memcmp:
                          | ProgramNotificationsMemcmpFilterBase58
                          | ProgramNotificationsMemcmpFilterBase64;
                  },
              >[];
          },
      > & Readonly<{ encoding: "jsonParsed" }>

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

  • programNotifications(
        programId: Address,
        config: Readonly<
            {
                commitment?: Commitment;
                filters?: readonly Readonly<
                    | { dataSize: ProgramNotificationsDatasizeFilter }
                    | {
                        memcmp:
                            | ProgramNotificationsMemcmpFilterBase58
                            | ProgramNotificationsMemcmpFilterBase64;
                    },
                >[];
            },
        > & Readonly<{ encoding: "base58" }>,
    ): Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • Parameters

    • programId: Address
    • config: Readonly<
          {
              commitment?: Commitment;
              filters?: readonly Readonly<
                  | { dataSize: ProgramNotificationsDatasizeFilter }
                  | {
                      memcmp:
                          | ProgramNotificationsMemcmpFilterBase58
                          | ProgramNotificationsMemcmpFilterBase64;
                  },
              >[];
          },
      > & Readonly<{ encoding: "base58" }>

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

  • programNotifications(
        programId: Address,
        config?: Readonly<
            {
                commitment?: Commitment;
                filters?: readonly Readonly<
                    | { dataSize: ProgramNotificationsDatasizeFilter }
                    | {
                        memcmp:
                            | ProgramNotificationsMemcmpFilterBase58
                            | ProgramNotificationsMemcmpFilterBase64;
                    },
                >[];
            },
        >,
    ): Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • Parameters

    • programId: Address
    • Optionalconfig: Readonly<
          {
              commitment?: Commitment;
              filters?: readonly Readonly<
                  | { dataSize: ProgramNotificationsDatasizeFilter }
                  | {
                      memcmp:
                          | ProgramNotificationsMemcmpFilterBase58
                          | ProgramNotificationsMemcmpFilterBase64;
                  },
              >[];
          },
      >

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