xrpl
    Preparing search index...

    Interface ServerDefinitionsResponse

    Response expected from an ServerDefinitionsRequest.

    interface ServerDefinitionsResponse {
        api_version?: number;
        forwarded?: boolean;
        id: string | number;
        result: { hash: string } & (
            | {
                ACCOUNT_SET_FLAGS: Record<string, number>;
                FIELDS: [
                    string,
                    {
                        isSerialized: boolean;
                        isSigningField: boolean;
                        isVLEncoded: boolean;
                        nth: number;
                        type: string;
                    },
                ][];
                LEDGER_ENTRY_FLAGS: Record<string, Record<string, number>>;
                LEDGER_ENTRY_FORMATS: Record<
                    string,
                    { name: string; optionality: number }[],
                >;
                LEDGER_ENTRY_TYPES: Record<string, number>;
                TRANSACTION_FLAGS: Record<string, Record<string, number>>;
                TRANSACTION_FORMATS: Record<
                    string,
                    { name: string; optionality: number }[],
                >;
                TRANSACTION_RESULTS: Record<string, number>;
                TRANSACTION_TYPES: Record<string, number>;
                TYPES: Record<string, number>;
            }
            | {
                ACCOUNT_SET_FLAGS?: undefined;
                FIELDS?: undefined;
                LEDGER_ENTRY_FLAGS?: undefined;
                LEDGER_ENTRY_FORMATS?: undefined;
                LEDGER_ENTRY_TYPES?: undefined;
                TRANSACTION_FLAGS?: undefined;
                TRANSACTION_FORMATS?: undefined;
                TRANSACTION_RESULTS?: undefined;
                TRANSACTION_TYPES?: undefined;
                TYPES?: undefined;
            }
        );
        status?: string;
        type: string;
        warning?: "load";
        warnings?: ResponseWarning[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    api_version?: number
    forwarded?: boolean
    id: string | number
    result: { hash: string } & (
        | {
            ACCOUNT_SET_FLAGS: Record<string, number>;
            FIELDS: [
                string,
                {
                    isSerialized: boolean;
                    isSigningField: boolean;
                    isVLEncoded: boolean;
                    nth: number;
                    type: string;
                },
            ][];
            LEDGER_ENTRY_FLAGS: Record<string, Record<string, number>>;
            LEDGER_ENTRY_FORMATS: Record<
                string,
                { name: string; optionality: number }[],
            >;
            LEDGER_ENTRY_TYPES: Record<string, number>;
            TRANSACTION_FLAGS: Record<string, Record<string, number>>;
            TRANSACTION_FORMATS: Record<
                string,
                { name: string; optionality: number }[],
            >;
            TRANSACTION_RESULTS: Record<string, number>;
            TRANSACTION_TYPES: Record<string, number>;
            TYPES: Record<string, number>;
        }
        | {
            ACCOUNT_SET_FLAGS?: undefined;
            FIELDS?: undefined;
            LEDGER_ENTRY_FLAGS?: undefined;
            LEDGER_ENTRY_FORMATS?: undefined;
            LEDGER_ENTRY_TYPES?: undefined;
            TRANSACTION_FLAGS?: undefined;
            TRANSACTION_FORMATS?: undefined;
            TRANSACTION_RESULTS?: undefined;
            TRANSACTION_TYPES?: undefined;
            TYPES?: undefined;
        }
    )

    Type Declaration

    • hash: string
    • {
          ACCOUNT_SET_FLAGS: Record<string, number>;
          FIELDS: [
              string,
              {
                  isSerialized: boolean;
                  isSigningField: boolean;
                  isVLEncoded: boolean;
                  nth: number;
                  type: string;
              },
          ][];
          LEDGER_ENTRY_FLAGS: Record<string, Record<string, number>>;
          LEDGER_ENTRY_FORMATS: Record<
              string,
              { name: string; optionality: number }[],
          >;
          LEDGER_ENTRY_TYPES: Record<string, number>;
          TRANSACTION_FLAGS: Record<string, Record<string, number>>;
          TRANSACTION_FORMATS: Record<
              string,
              { name: string; optionality: number }[],
          >;
          TRANSACTION_RESULTS: Record<string, number>;
          TRANSACTION_TYPES: Record<string, number>;
          TYPES: Record<string, number>;
      }
      • ACCOUNT_SET_FLAGS: Record<string, number>

        Maps AccountSet flag names (asf flags) to their numeric values.

      • FIELDS: [
            string,
            {
                isSerialized: boolean;
                isSigningField: boolean;
                isVLEncoded: boolean;
                nth: number;
                type: string;
            },
        ][]
      • LEDGER_ENTRY_FLAGS: Record<string, Record<string, number>>

        Maps ledger entry type names to their flags and flag values.

      • LEDGER_ENTRY_FORMATS: Record<string, { name: string; optionality: number }[]>

        Describes the fields and their optionality for each ledger entry type, including common fields shared across all ledger entries.

      • LEDGER_ENTRY_TYPES: Record<string, number>
      • TRANSACTION_FLAGS: Record<string, Record<string, number>>

        Maps transaction type names to their supported flags and flag values.

      • TRANSACTION_FORMATS: Record<string, { name: string; optionality: number }[]>

        Describes the fields and their optionality for each transaction type, including common fields shared across all transactions.

      • TRANSACTION_RESULTS: Record<string, number>
      • TRANSACTION_TYPES: Record<string, number>
      • TYPES: Record<string, number>
    • {
          ACCOUNT_SET_FLAGS?: undefined;
          FIELDS?: undefined;
          LEDGER_ENTRY_FLAGS?: undefined;
          LEDGER_ENTRY_FORMATS?: undefined;
          LEDGER_ENTRY_TYPES?: undefined;
          TRANSACTION_FLAGS?: undefined;
          TRANSACTION_FORMATS?: undefined;
          TRANSACTION_RESULTS?: undefined;
          TRANSACTION_TYPES?: undefined;
          TYPES?: undefined;
      }
    status?: string
    type: string
    warning?: "load"
    warnings?: ResponseWarning[]