repair TypeScript test and client after query rename 'rewardsProvenance' -> 'stakePoolsPerformances'

Author: KtorZ

clients/TypeScript/packages/client/src/LedgerStateQuery/Client.ts

@@ -15,8 +15,8 @@ import {
   proposedProtocolParameters,
   protocolParameters,
   rewardAccountSummaries,
-  rewardsProvenance,
   stakePools,
+  stakePoolsPerformances,
   utxo
 } from './query'
 import {
@@ -73,8 +73,8 @@ export interface LedgerStateQueryClient {
     scripts?: AnyStakeCredential[],
     keys?: AnyStakeCredential[],
   }): ReturnType<typeof rewardAccountSummaries>
-  rewardsProvenance(): ReturnType<typeof rewardsProvenance>
   stakePools(filter?: { id: StakePoolId }[], includeStake?: boolean): ReturnType<typeof stakePools>
+  stakePoolsPerformances(): ReturnType<typeof stakePoolsPerformances>
   utxo(filter?: UtxoByOutputReferences | UtxoByAddresses): ReturnType<typeof utxo>
 }
 
@@ -188,12 +188,12 @@ export async function createLedgerStateQueryClient (
     rewardAccountSummaries (filter) {
       return rewardAccountSummaries(context, filter)
     },
-    rewardsProvenance () {
-      return rewardsProvenance(context)
-    },
     stakePools (filter, includeStake) {
       return stakePools(context, filter, includeStake)
     },
+    stakePoolsPerformances () {
+      return stakePoolsPerformances(context)
+    },
     utxo (filter) {
       return utxo(context, filter)
     },

clients/TypeScript/packages/client/src/LedgerStateQuery/query/index.ts

@@ -13,6 +13,6 @@ export { projectedRewards } from './projectedRewards'
 export { proposedProtocolParameters } from './proposedProtocolParameters'
 export { protocolParameters } from './protocolParameters'
 export { rewardAccountSummaries } from './rewardAccountSummaries'
-export { rewardsProvenance } from './rewardsProvenance'
 export { stakePools } from './stakePools'
+export { stakePoolsPerformances } from './stakePoolsPerformances'
 export { utxo } from './utxo'

clients/TypeScript/packages/client/src/LedgerStateQuery/query/rewardsProvenance.ts

@@ -0,0 +1,20 @@
+import { InteractionContext, Method } from '../../Connection'
+import { Ogmios, StakePoolsPerformances } from '@cardano-ogmios/schema'
+
+type Request = Ogmios['QueryLedgerStateStakePoolsPerformances']
+type Response = Ogmios['QueryLedgerStateStakePoolsPerformancesResponse']
+
+/**
+ * Get details about the stake pools performances of the previous epoch.
+ *
+ * @category LedgerStateQuery
+ */
+export function stakePoolsPerformances (context: InteractionContext): Promise<StakePoolsPerformances> {
+  return Method<Request, Response, StakePoolsPerformances>(
+    {
+      method: 'queryLedgerState/stakePoolsPerformances'
+    },
+    {},
+    context
+  )
+}

clients/TypeScript/packages/client/src/LedgerStateQuery/query/stakePoolsPerformances.ts

@@ -297,9 +297,9 @@ describe('Local state queries', () => {
         }
       })
     })
-    describe('rewardsProvenance', () => {
-      it('fetches rewards provenance for the ongoing epoch (new)', async () => {
-        const provenance = await LedgerStateQuery.rewardsProvenance(context)
+    describe('stakePoolsPerformances', () => {
+      it('fetches pools performance for the ongoing epoch (new)', async () => {
+        const provenance = await LedgerStateQuery.stakePoolsPerformances(context)
         expect(provenance).toBeDefined()
       })
     })

clients/TypeScript/packages/client/test/LedgerStateQuery.test.ts

@@ -10,7 +10,7 @@ import {
   GovernanceActionTreasuryWithdrawals,
   Metadata,
   RewardAccountSummaries,
-  RewardsProvenance,
+  StakePoolsPerformances,
   StakePool,
   Transaction,
   TransactionOutput
@@ -496,28 +496,32 @@ describe('util', () => {
 
       it('RewardAccountSummaries', () => {
         const json = `
-          {
-            "58e1b65718531b42494610c506cef10ff031fa817a8ff75c0ab180e7": {
+          [
+            {
+              "from": "verificationKey",
+              "credential": "58e1b65718531b42494610c506cef10ff031fa817a8ff75c0ab180e7",
               "rewards": { "ada": { "lovelace": 782 } }
             },
-            "eccbfb5c619673f0648a42cc2f822c81cbc34aee41274638e89a7af5": {
+            {
+              "from": "verificationKey",
+              "credential": "eccbfb5c619673f0648a42cc2f822c81cbc34aee41274638e89a7af5",
               "delegate": { "id": "pool1uzn3gvvcztplwua6qnk966elln264kzsq6q9kprmpqj5zytzn03" }
             },
-            "22c81cbc34aee41274638e89a7af5eccbfb5c619673f0648a42cc2f8": {
+            {
+              "from": "verificationKey",
+              "credential": "22c81cbc34aee41274638e89a7af5eccbfb5c619673f0648a42cc2f8",
               "delegate": { "id": "pool1uzn3gvvcztplwua6qnk966elln264kzsq6q9kprmpqj5zytzn03" },
               "rewards": { "ada": { "lovelace": 42 } }
             }
-          }
+          ]
         `
 
         const result = safeJSON.parse(json) as RewardAccountSummaries
-        const stakeAddr1 = '58e1b65718531b42494610c506cef10ff031fa817a8ff75c0ab180e7'
-        expect(typeof result[stakeAddr1].rewards.ada.lovelace).toEqual('bigint')
-        const stakeAddr2 = '22c81cbc34aee41274638e89a7af5eccbfb5c619673f0648a42cc2f8'
-        expect(typeof result[stakeAddr2].rewards.ada.lovelace).toEqual('bigint')
+        expect(typeof result[0].rewards.ada.lovelace).toEqual('bigint')
+        expect(typeof result[2].rewards.ada.lovelace).toEqual('bigint')
       })
 
-      it('IndividualPoolRewardsProvenance', () => {
+      it('IndividualStakePoolPerformances', () => {
         const json = `
           {
             "desiredNumberOfStakePools": 267,
@@ -541,7 +545,7 @@ describe('util', () => {
         `
 
         const poolId = 'pool1an9lkhrpjeelqey2gtxzlq3vs89uxjhwgyn5vw8gnfa02v6328u'
-        const result = safeJSON.parse(json) as RewardsProvenance
+        const result = safeJSON.parse(json) as StakePoolsPerformances
         expect(typeof result.totalRewardsInEpoch.ada.lovelace).toEqual('bigint')
         expect(typeof result.activeStakeInEpoch.ada.lovelace).toEqual('bigint')
         expect(typeof result.stakePools[poolId].stake.ada.lovelace).toEqual('bigint')

clients/TypeScript/packages/client/test/util.test.ts

@@ -67,9 +67,9 @@ import {
       scripts?: Schema.AnyStakeCredential[],
       keys?: Schema.AnyStakeCredential[]
     }) => LedgerStateQuery.rewardAccountSummaries(context, filters),
-    rewardsProvenance: () => LedgerStateQuery.rewardsProvenance(context),
     sizeOfMempool: () => MempoolMonitoring.sizeOfMempool(context),
     stakePools: () => LedgerStateQuery.stakePools(context),
+    stakePoolsPerformances: () => LedgerStateQuery.stakePoolsPerformances(context),
     submitTransaction: (
       bytes: string
     ) => TransactionSubmission.submitTransaction(context, bytes),