feat: add specific response types for ledger_entry request variants

packages/xrpl/src/models/ledger/LedgerEntry.ts

@@ -6,6 +6,7 @@ import Check from './Check'
 import Credential from './Credential'
 import Delegate from './Delegate'
 import DepositPreauth from './DepositPreauth'
+import DID from './DID'
 import DirectoryNode from './DirectoryNode'
 import Escrow from './Escrow'
 import FeeSettings from './FeeSettings'
@@ -33,6 +34,7 @@ type LedgerEntry =
   | Credential
   | Delegate
   | DepositPreauth
+  | DID
   | DirectoryNode
   | Escrow
   | FeeSettings

packages/xrpl/src/models/methods/index.ts

@@ -2,6 +2,27 @@
 /* eslint-disable max-lines -- There is a lot to export */
 /* eslint-disable prettier/prettier -- Required here to keep formatting in line */
 import type { APIVersion, DEFAULT_API_VERSION } from '../common'
+import type {
+  AccountRoot,
+  AMM,
+  Bridge,
+  Check,
+  Credential,
+  Delegate,
+  DepositPreauth,
+  DID,
+  DirectoryNode,
+  Escrow,
+  MPToken,
+  MPTokenIssuance,
+  NFTokenPage,
+  Offer,
+  PayChannel,
+  RippleState,
+  Ticket,
+  XChainOwnedClaimID,
+  XChainOwnedCreateAccountClaimID,
+} from '../ledger'
 
 import {
   AccountChannelsRequest,
@@ -108,7 +129,30 @@ import {
   LedgerDataRequest,
   LedgerDataResponse,
 } from './ledgerData'
-import { LedgerEntryRequest, LedgerEntryResponse } from './ledgerEntry'
+import {
+  LedgerEntryRequest,
+  LedgerEntryResponse,
+  LedgerEntryAccountRootRequest,
+  LedgerEntryAMMRequest,
+  LedgerEntryBridgeAccountRequest,
+  LedgerEntryBridgeRequest,
+  LedgerEntryCheckRequest,
+  LedgerEntryCredentialRequest,
+  LedgerEntryDelegateRequest,
+  LedgerEntryDepositPreauthRequest,
+  LedgerEntryDIDRequest,
+  LedgerEntryDirectoryRequest,
+  LedgerEntryEscrowRequest,
+  LedgerEntryMPTokenIssuanceRequest,
+  LedgerEntryMPTokenRequest,
+  LedgerEntryNFTokenPageRequest,
+  LedgerEntryOfferRequest,
+  LedgerEntryPayChannelRequest,
+  LedgerEntryRippleStateRequest,
+  LedgerEntryTicketRequest,
+  LedgerEntryXChainOwnedClaimIDRequest,
+  LedgerEntryXChainOwnedCreateAccountClaimIDRequest,
+} from './ledgerEntry'
 import { ManifestRequest, ManifestResponse } from './manifest'
 import { NFTBuyOffersRequest, NFTBuyOffersResponse } from './nftBuyOffers'
 import {
@@ -412,6 +456,46 @@ export type RequestResponseMap<
   ? LedgerCurrentResponse
   : T extends LedgerDataRequest
   ? LedgerDataResponse
+  : T extends LedgerEntryAccountRootRequest
+  ? LedgerEntryResponse<AccountRoot>
+  : T extends LedgerEntryAMMRequest
+  ? LedgerEntryResponse<AMM>
+  : T extends LedgerEntryBridgeAccountRequest
+  ? LedgerEntryResponse<Bridge>
+  : T extends LedgerEntryBridgeRequest
+  ? LedgerEntryResponse<Bridge>
+  : T extends LedgerEntryCheckRequest
+  ? LedgerEntryResponse<Check>
+  : T extends LedgerEntryCredentialRequest
+  ? LedgerEntryResponse<Credential>
+  : T extends LedgerEntryDelegateRequest
+  ? LedgerEntryResponse<Delegate>
+  : T extends LedgerEntryDepositPreauthRequest
+  ? LedgerEntryResponse<DepositPreauth>
+  : T extends LedgerEntryDIDRequest
+  ? LedgerEntryResponse<DID>
+  : T extends LedgerEntryDirectoryRequest
+  ? LedgerEntryResponse<DirectoryNode>
+  : T extends LedgerEntryEscrowRequest
+  ? LedgerEntryResponse<Escrow>
+  : T extends LedgerEntryMPTokenIssuanceRequest
+  ? LedgerEntryResponse<MPTokenIssuance>
+  : T extends LedgerEntryMPTokenRequest
+  ? LedgerEntryResponse<MPToken>
+  : T extends LedgerEntryNFTokenPageRequest
+  ? LedgerEntryResponse<NFTokenPage>
+  : T extends LedgerEntryOfferRequest
+  ? LedgerEntryResponse<Offer>
+  : T extends LedgerEntryPayChannelRequest
+  ? LedgerEntryResponse<PayChannel>
+  : T extends LedgerEntryRippleStateRequest
+  ? LedgerEntryResponse<RippleState>
+  : T extends LedgerEntryTicketRequest
+  ? LedgerEntryResponse<Ticket>
+  : T extends LedgerEntryXChainOwnedClaimIDRequest
+  ? LedgerEntryResponse<XChainOwnedClaimID>
+  : T extends LedgerEntryXChainOwnedCreateAccountClaimIDRequest
+  ? LedgerEntryResponse<XChainOwnedCreateAccountClaimID>
   : T extends LedgerEntryRequest
   ? LedgerEntryResponse
   : T extends SimulateBinaryRequest
@@ -567,6 +651,26 @@ export {
   LedgerDataLedgerState,
   LedgerEntryRequest,
   LedgerEntryResponse,
+  LedgerEntryAccountRootRequest,
+  LedgerEntryAMMRequest,
+  LedgerEntryBridgeRequest,
+  LedgerEntryBridgeAccountRequest,
+  LedgerEntryCheckRequest,
+  LedgerEntryCredentialRequest,
+  LedgerEntryDelegateRequest,
+  LedgerEntryDepositPreauthRequest,
+  LedgerEntryDIDRequest,
+  LedgerEntryDirectoryRequest,
+  LedgerEntryEscrowRequest,
+  LedgerEntryMPTokenIssuanceRequest,
+  LedgerEntryMPTokenRequest,
+  LedgerEntryNFTokenPageRequest,
+  LedgerEntryOfferRequest,
+  LedgerEntryPayChannelRequest,
+  LedgerEntryRippleStateRequest,
+  LedgerEntryTicketRequest,
+  LedgerEntryXChainOwnedClaimIDRequest,
+  LedgerEntryXChainOwnedCreateAccountClaimIDRequest,
   // transaction methods with types
   SimulateRequest,
   SimulateResponse,

packages/xrpl/src/models/methods/ledgerEntry.ts

@@ -230,6 +230,88 @@ export interface LedgerEntryRequest extends BaseRequest, LookupByLedgerRequest {
   }
 }
 
+export interface LedgerEntryAccountRootRequest extends LedgerEntryRequest {
+  account_root: Required<LedgerEntryRequest>['account_root']
+}
+
+export interface LedgerEntryAMMRequest extends LedgerEntryRequest {
+  amm: Required<LedgerEntryRequest>['amm']
+}
+
+export interface LedgerEntryBridgeAccountRequest extends LedgerEntryRequest {
+  bridge_account: Required<LedgerEntryRequest>['bridge_account']
+}
+
+export interface LedgerEntryBridgeRequest extends LedgerEntryRequest {
+  bridge: Required<LedgerEntryRequest>['bridge']
+}
+
+export interface LedgerEntryCheckRequest extends LedgerEntryRequest {
+  check: Required<LedgerEntryRequest>['check']
+}
+
+export interface LedgerEntryCredentialRequest extends LedgerEntryRequest {
+  credential: Required<LedgerEntryRequest>['credential']
+}
+
+export interface LedgerEntryDelegateRequest extends LedgerEntryRequest {
+  delegate: Required<LedgerEntryRequest>['delegate']
+}
+
+export interface LedgerEntryDepositPreauthRequest extends LedgerEntryRequest {
+  deposit_preauth: Required<LedgerEntryRequest>['deposit_preauth']
+}
+
+export interface LedgerEntryDIDRequest extends LedgerEntryRequest {
+  did: Required<LedgerEntryRequest>['did']
+}
+
+export interface LedgerEntryDirectoryRequest extends LedgerEntryRequest {
+  directory: Required<LedgerEntryRequest>['directory']
+}
+
+export interface LedgerEntryEscrowRequest extends LedgerEntryRequest {
+  escrow: Required<LedgerEntryRequest>['escrow']
+}
+
+export interface LedgerEntryMPTokenIssuanceRequest extends LedgerEntryRequest {
+  mpt_issuance: Required<LedgerEntryRequest>['mpt_issuance']
+}
+
+export interface LedgerEntryMPTokenRequest extends LedgerEntryRequest {
+  mptoken: Required<LedgerEntryRequest>['mptoken']
+}
+
+export interface LedgerEntryNFTokenPageRequest extends LedgerEntryRequest {
+  nft_page: Required<LedgerEntryRequest>['nft_page']
+}
+
+export interface LedgerEntryOfferRequest extends LedgerEntryRequest {
+  offer: Required<LedgerEntryRequest>['offer']
+}
+
+export interface LedgerEntryPayChannelRequest extends LedgerEntryRequest {
+  payment_channel: Required<LedgerEntryRequest>['payment_channel']
+}
+
+export interface LedgerEntryRippleStateRequest extends LedgerEntryRequest {
+  ripple_state: Required<LedgerEntryRequest>['ripple_state']
+}
+
+export interface LedgerEntryTicketRequest extends LedgerEntryRequest {
+  ticket: Required<LedgerEntryRequest>['ticket']
+}
+
+// eslint-disable-next-line max-len -- Disable for interface declaration.
+export interface LedgerEntryXChainOwnedClaimIDRequest extends LedgerEntryRequest {
+  xchain_owned_claim_id: Required<LedgerEntryRequest>['xchain_owned_claim_id']
+}
+
+// eslint-disable-next-line max-len -- Disable for interface declaration.
+export interface LedgerEntryXChainOwnedCreateAccountClaimIDRequest extends LedgerEntryRequest {
+  xchain_owned_create_account_claim_id: Required<LedgerEntryRequest>['xchain_owned_create_account_claim_id']
+}
+
 /**
  * Response expected from a {@link LedgerEntryRequest}.
  *

packages/xrpl/test/integration/transactions/clawback.test.ts

@@ -10,7 +10,6 @@ import {
   MPTokenIssuanceCreateFlags,
   MPTokenAuthorize,
   TransactionMetadata,
-  LedgerEntryResponse,
 } from '../../../src'
 import serverUrl from '../serverUrl'
 import {
@@ -162,18 +161,17 @@ describe('Clawback', function () {
 
       await testTransaction(testContext.client, paymentTx, testContext.wallet)
 
-      let ledgerEntryResponse: LedgerEntryResponse =
-        await testContext.client.request({
-          command: 'ledger_entry',
-          mptoken: {
-            mpt_issuance_id: mptID!,
-            account: wallet2.classicAddress,
-          },
-        })
+      let ledgerEntryResponse = await testContext.client.request({
+        command: 'ledger_entry',
+        mptoken: {
+          mpt_issuance_id: mptID!,
+          account: wallet2.classicAddress,
+        },
+      })
 
       assert.equal(
-        // @ts-expect-error: Known issue with unknown object type
-        ledgerEntryResponse.result.node.MPTAmount,
+        // @ts-expect-error: string type assertion to MPTAmount field
+        ledgerEntryResponse.result.node.MPTAmount as string,
         '9223372036854775807',
       )
 
@@ -198,8 +196,8 @@ describe('Clawback', function () {
       })
 
       assert.equal(
-        // @ts-expect-error: Known issue with unknown object type
-        ledgerEntryResponse.result.node.MPTAmount,
+        // @ts-expect-error: string type assertion to MPTAmount field
+        ledgerEntryResponse.result.node.MPTAmount as string,
         '9223372036854775307',
       )
     },

packages/xrpl/test/integration/transactions/delegateSet.test.ts

@@ -3,12 +3,10 @@ import { assert } from 'chai'
 import {
   AccountSet,
   DelegateSet,
-  LedgerEntryResponse,
   Payment,
   Wallet,
   xrpToDrops,
 } from '../../../src'
-import { Delegate } from '../../../src/models/ledger'
 import serverUrl from '../serverUrl'
 import {
   setupClient,
@@ -51,15 +49,14 @@ describe('DelegateSet', function () {
       await testTransaction(testContext.client, delegateTx, alice)
 
       // Verify Delegate ledger entry
-      const ledgerEntryRes: LedgerEntryResponse =
-        await testContext.client.request({
-          command: 'ledger_entry',
-          delegate: {
-            account: alice.address,
-            authorize: bob.address,
-          },
-        })
-      const delegateLedgerEntry = ledgerEntryRes.result.node as Delegate
+      const ledgerEntryRes = await testContext.client.request({
+        command: 'ledger_entry',
+        delegate: {
+          account: alice.address,
+          authorize: bob.address,
+        },
+      })
+      const delegateLedgerEntry = ledgerEntryRes.result.node!
       assert.equal(delegateLedgerEntry.LedgerEntryType, 'Delegate')
       assert.equal(delegateLedgerEntry.Account, alice.address)
       assert.equal(delegateLedgerEntry.Authorize, bob.address)

packages/xrpl/test/integration/transactions/permissionedDEX.test.ts

@@ -232,7 +232,7 @@ describe('PermissionedDEX', function () {
             seq: offerCreateTxResponse.result.tx_json.Sequence as number,
           },
         })
-      ).result.node as Offer
+      ).result.node!
 
       assert.equal(offerLedgerObject.LedgerEntryType, 'Offer')
       assert.equal(offerLedgerObject.DomainID, permDomainLedgerObject.index)
@@ -259,7 +259,7 @@ describe('PermissionedDEX', function () {
       })
 
       assert.equal(
-        (ledgerEntryResponse.result.node as DirectoryNode).index,
+        ledgerEntryResponse.result.node?.index,
         offerLedgerObject.BookDirectory,
       )
       assert.equal(