Merge pull request #1538 from input-output-hk/feat/lw-11530-txbuild-drep-retirement-should-prevent-withdraw-rewards

Feat/lw 11530 txbuild drep retirement should prevent withdraw rewards

Author: mchappell

.github/workflows/continuous-integration-blockfrost-e2e.yaml

@@ -14,6 +14,8 @@ env:
   TEST_CLIENT_ASSET_PROVIDER_PARAMS: '{"baseUrl":"http://localhost:3015"}'
   TEST_CLIENT_CHAIN_HISTORY_PROVIDER: 'blockfrost'
   TEST_CLIENT_CHAIN_HISTORY_PROVIDER_PARAMS: '{"baseUrl":"http://localhost:3015"}'
+  TEST_CLIENT_DREP_PROVIDER: 'blockfrost'
+  TEST_CLIENT_DREP_PROVIDER_PARAMS: '{"baseUrl":"http://localhost:3015"}'
   TEST_CLIENT_HANDLE_PROVIDER: 'http'
   TEST_CLIENT_HANDLE_PROVIDER_PARAMS: '{"baseUrl":"http://localhost:4011/"}'
   TEST_CLIENT_NETWORK_INFO_PROVIDER: 'blockfrost'

.github/workflows/continuous-integration-e2e.yaml

@@ -14,6 +14,8 @@ env:
   TEST_CLIENT_ASSET_PROVIDER_PARAMS: '{"baseUrl":"http://localhost:4014/"}'
   TEST_CLIENT_CHAIN_HISTORY_PROVIDER: 'ws'
   TEST_CLIENT_CHAIN_HISTORY_PROVIDER_PARAMS: '{"baseUrl":"http://localhost:4000/"}'
+  TEST_CLIENT_DREP_PROVIDER: 'blockfrost'
+  TEST_CLIENT_DREP_PROVIDER_PARAMS: '{"baseUrl":"http://localhost:3015"}'
   TEST_CLIENT_HANDLE_PROVIDER: 'http'
   TEST_CLIENT_HANDLE_PROVIDER_PARAMS: '{"baseUrl":"http://localhost:4011/"}'
   TEST_CLIENT_NETWORK_INFO_PROVIDER: 'ws'

packages/core/src/Cardano/types/DelegationsAndRewards.ts

@@ -1,4 +1,5 @@
-import { DelegateRepresentative } from './Governance';
+import { AlwaysAbstain, AlwaysNoConfidence } from './Governance';
+import { DRepInfo } from '../../Provider';
 import { Lovelace } from './Value';
 import { Metadatum } from './AuxiliaryData';
 import { PoolId, PoolIdHex, StakePool } from './StakePool';
@@ -24,7 +25,7 @@ export enum StakeCredentialStatus {
   Unregistered = 'UNREGISTERED'
 }
 
-export type DRepDelegatee = { delegateRepresentative: DelegateRepresentative };
+export type DRepDelegatee = { delegateRepresentative: DRepInfo | AlwaysAbstain | AlwaysNoConfidence };
 
 export interface RewardAccountInfo {
   address: RewardAccount;

packages/core/src/Cardano/types/Governance.ts

@@ -1,5 +1,6 @@
 import * as Crypto from '@cardano-sdk/crypto';
 import { Credential, CredentialType, RewardAccount } from '../Address';
+import { DRepInfo } from '../../Provider';
 import { EpochNo, Fraction, ProtocolVersion, TransactionId } from '.';
 import { Lovelace } from './Value';
 import { ProtocolParametersUpdateConway } from './ProtocolParameters';
@@ -187,10 +188,14 @@ export type AlwaysNoConfidence = {
 
 export type DelegateRepresentative = Credential | AlwaysAbstain | AlwaysNoConfidence;
 
-export const isDRepCredential = (deleg: DelegateRepresentative): deleg is Credential => !('__typename' in deleg);
+export const isDrepInfo = (drep: DelegateRepresentative | DRepInfo): drep is DRepInfo =>
+  'id' in drep && 'active' in drep;
 
-export const isDRepAlwaysAbstain = (deleg: DelegateRepresentative): deleg is AlwaysAbstain =>
-  !isDRepCredential(deleg) && deleg.__typename === 'AlwaysAbstain';
+export const isDRepCredential = (deleg: DelegateRepresentative | DRepInfo): deleg is Credential =>
+  'type' in deleg && 'hash' in deleg;
 
-export const isDRepAlwaysNoConfidence = (deleg: DelegateRepresentative): deleg is AlwaysNoConfidence =>
-  !isDRepCredential(deleg) && deleg.__typename === 'AlwaysNoConfidence';
+export const isDRepAlwaysAbstain = (deleg: DelegateRepresentative | DRepInfo): deleg is AlwaysAbstain =>
+  '__typename' in deleg && deleg.__typename === 'AlwaysAbstain';
+
+export const isDRepAlwaysNoConfidence = (deleg: DelegateRepresentative | DRepInfo): deleg is AlwaysNoConfidence =>
+  '__typename' in deleg && deleg.__typename === 'AlwaysNoConfidence';

packages/e2e/.env.example

@@ -14,6 +14,8 @@ TEST_CLIENT_ASSET_PROVIDER=http
 TEST_CLIENT_ASSET_PROVIDER_PARAMS='{"baseUrl":"http://localhost:4014/"}'
 TEST_CLIENT_CHAIN_HISTORY_PROVIDER=ws
 TEST_CLIENT_CHAIN_HISTORY_PROVIDER_PARAMS='{"baseUrl":"http://localhost:4000/"}'
+TEST_CLIENT_DREP_PROVIDER='blockfrost'
+TEST_CLIENT_DREP_PROVIDER_PARAMS='{"baseUrl":"http://localhost:3015"}'
 TEST_CLIENT_HANDLE_PROVIDER=http
 TEST_CLIENT_HANDLE_PROVIDER_PARAMS='{"baseUrl":"http://localhost:4011/"}'
 TEST_CLIENT_NETWORK_INFO_PROVIDER=ws

packages/e2e/README.md

@@ -160,6 +160,8 @@ KEY_MANAGEMENT_PROVIDER=inMemory
 KEY_MANAGEMENT_PARAMS='{"accountIndex": 0, "chainId":{"networkId": 0, "networkMagic": 888}, "passphrase":"some_passphrase","mnemonic":""}'
 TEST_CLIENT_ASSET_PROVIDER=http
 TEST_CLIENT_ASSET_PROVIDER_PARAMS='{"baseUrl":"http://localhost:4000"}'
+TEST_CLIENT_DREP_PROVIDER='blockfrost'
+TEST_CLIENT_DREP_PROVIDER_PARAMS='{"baseUrl":"http://localhost:3015"}'
 TEST_CLIENT_CHAIN_HISTORY_PROVIDER=http
 TEST_CLIENT_CHAIN_HISTORY_PROVIDER_PARAMS='{"baseUrl":"http://localhost:4000"}'
 TEST_CLIENT_NETWORK_INFO_PROVIDER=http

packages/e2e/src/environment.ts

@@ -92,6 +92,8 @@ const validators = {
   TEST_CLIENT_ASSET_PROVIDER_PARAMS: providerParams(),
   TEST_CLIENT_CHAIN_HISTORY_PROVIDER: str(),
   TEST_CLIENT_CHAIN_HISTORY_PROVIDER_PARAMS: providerParams(),
+  TEST_CLIENT_DREP_PROVIDER: str({ choices: ['blockfrost'] }),
+  TEST_CLIENT_DREP_PROVIDER_PARAMS: providerParams(),
   TEST_CLIENT_HANDLE_PROVIDER: str(),
   TEST_CLIENT_HANDLE_PROVIDER_PARAMS: providerParams(),
   TEST_CLIENT_NETWORK_INFO_PROVIDER: str(),
@@ -145,6 +147,8 @@ export const walletVariables = [
   'TEST_CLIENT_ASSET_PROVIDER_PARAMS',
   'TEST_CLIENT_CHAIN_HISTORY_PROVIDER',
   'TEST_CLIENT_CHAIN_HISTORY_PROVIDER_PARAMS',
+  'TEST_CLIENT_DREP_PROVIDER',
+  'TEST_CLIENT_DREP_PROVIDER_PARAMS',
   'TEST_CLIENT_HANDLE_PROVIDER',
   'TEST_CLIENT_HANDLE_PROVIDER_PARAMS',
   'KEY_MANAGEMENT_PARAMS',

packages/e2e/src/factories.ts

@@ -18,6 +18,7 @@ import {
   AssetProvider,
   Cardano,
   ChainHistoryProvider,
+  DRepProvider,
   HandleProvider,
   NetworkInfoProvider,
   ProviderFactory,
@@ -39,6 +40,7 @@ import {
   BlockfrostAssetProvider,
   BlockfrostChainHistoryProvider,
   BlockfrostClient,
+  BlockfrostDRepProvider,
   BlockfrostNetworkInfoProvider,
   BlockfrostRewardsProvider,
   BlockfrostTxSubmitProvider,
@@ -81,6 +83,7 @@ export type CreateKeyAgent = (dependencies: KeyAgentDependencies) => Promise<Asy
 export const keyManagementFactory = new ProviderFactory<CreateKeyAgent>();
 export const assetProviderFactory = new ProviderFactory<AssetProvider>();
 export const chainHistoryProviderFactory = new ProviderFactory<ChainHistoryProvider>();
+export const drepProviderFactory = new ProviderFactory<DRepProvider>();
 export const networkInfoProviderFactory = new ProviderFactory<NetworkInfoProvider>();
 export const rewardsProviderFactory = new ProviderFactory<RewardsProvider>();
 export const txSubmitProviderFactory = new ProviderFactory<TxSubmitProvider>();
@@ -181,6 +184,19 @@ chainHistoryProviderFactory.register(BLOCKFROST_PROVIDER, async (params: any, lo
   });
 });
 
+drepProviderFactory.register(BLOCKFROST_PROVIDER, async (params: any, logger): Promise<DRepProvider> => {
+  if (params.baseUrl === undefined) throw new Error(`${BlockfrostDRepProvider.name}: ${MISSING_URL_PARAM}`);
+
+  return new Promise<DRepProvider>(async (resolve) => {
+    resolve(
+      new BlockfrostDRepProvider(
+        new BlockfrostClient({ baseUrl: params.baseUrl }, { rateLimiter: { schedule: (task) => task() } }),
+        logger
+      )
+    );
+  });
+});
+
 networkInfoProviderFactory.register(
   HTTP_PROVIDER,
   async (params: any, logger: Logger): Promise<NetworkInfoProvider> => {
@@ -483,6 +499,11 @@ export const getWallet = async (props: GetWalletProps) => {
       env.TEST_CLIENT_CHAIN_HISTORY_PROVIDER_PARAMS,
       logger
     ),
+    drepProvider: await drepProviderFactory.create(
+      env.TEST_CLIENT_DREP_PROVIDER,
+      env.TEST_CLIENT_DREP_PROVIDER_PARAMS,
+      logger
+    ),
     handleProvider: await handleProviderFactory.create(
       env.TEST_CLIENT_HANDLE_PROVIDER,
       env.TEST_CLIENT_HANDLE_PROVIDER_PARAMS,
@@ -571,6 +592,11 @@ export const getSharedWallet = async (props: GetSharedWalletProps) => {
       env.TEST_CLIENT_CHAIN_HISTORY_PROVIDER_PARAMS,
       logger
     ),
+    drepProvider: await drepProviderFactory.create(
+      env.TEST_CLIENT_DREP_PROVIDER,
+      env.TEST_CLIENT_DREP_PROVIDER_PARAMS,
+      logger
+    ),
     handleProvider: await handleProviderFactory.create(
       env.TEST_CLIENT_HANDLE_PROVIDER,
       env.TEST_CLIENT_HANDLE_PROVIDER_PARAMS,

packages/e2e/src/scripts/generate-dotenv.sh

@@ -40,6 +40,9 @@ TEST_CLIENT_ASSET_PROVIDER=http
 TEST_CLIENT_ASSET_PROVIDER_PARAMS='{\"baseUrl\":\"${url}\"}'
 TEST_CLIENT_CHAIN_HISTORY_PROVIDER=ws
 TEST_CLIENT_CHAIN_HISTORY_PROVIDER_PARAMS='{\"baseUrl\":\"${url}\"}'
+TEST_CLIENT_DREP_PROVIDER: 'blockfrost'
+# TODO: use blockfrost URL
+TEST_CLIENT_DREP_PROVIDER_PARAMS: '{"baseUrl":"http://localhost:3015"}'
 TEST_CLIENT_HANDLE_PROVIDER=http
 TEST_CLIENT_HANDLE_PROVIDER_PARAMS='{\"baseUrl\":\"${url}\"}'
 TEST_CLIENT_NETWORK_INFO_PROVIDER=ws

packages/e2e/test/load-test-custom/wallet-init/wallet-init.test.ts

@@ -16,6 +16,7 @@ import {
   assetProviderFactory,
   bip32Ed25519Factory,
   chainHistoryProviderFactory,
+  drepProviderFactory,
   getEnv,
   getLoadTestScheduler,
   keyManagementFactory,
@@ -55,6 +56,11 @@ const getProviders = async () => ({
     env.TEST_CLIENT_CHAIN_HISTORY_PROVIDER_PARAMS,
     logger
   ),
+  drepProvider: await drepProviderFactory.create(
+    env.TEST_CLIENT_DREP_PROVIDER,
+    env.TEST_CLIENT_DREP_PROVIDER_PARAMS,
+    logger
+  ),
   networkInfoProvider: await networkInfoProviderFactory.create(
     env.TEST_CLIENT_NETWORK_INFO_PROVIDER,
     env.TEST_CLIENT_NETWORK_INFO_PROVIDER_PARAMS,