Add FinalizationCommitteeParameters Update

Concordium · Sep 15, 2023 · 783d921 · 783d921
1 parent e540055
commit 783d921
Show file tree

Hide file tree

Showing 14 changed files with 387 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 ### Added
 
 -   Support for block energy limit chain update.
+-   Support for finalization committee parameters chain update.
 
 ## 1.5.0
 

diff --git a/app/features/ledger/ConcordiumLedgerClient.ts b/app/features/ledger/ConcordiumLedgerClient.ts
@@ -23,6 +23,7 @@ import {
     CooldownParameters,
     PoolParameters,
     BlockEnergyLimit,
+    FinalizationCommitteeParameters,
 } from '~/utils/types';
 import { pipe } from '~/utils/basicHelpers';
 
@@ -351,4 +352,18 @@ export default class ConcordiumLedgerClient {
             )
         );
     }
+
+    signFinalizationCommitteeParameters(
+        transaction: UpdateInstruction<FinalizationCommitteeParameters>,
+        serializedPayload: Buffer,
+        path: number[]
+    ): Promise<Buffer> {
+        return toBuffer(
+            window.ledger.signFinalizationCommitteeParameters(
+                transaction,
+                serializedPayload,
+                path
+            )
+        );
+    }
 }
diff --git a/app/features/ledger/ConcordiumLedgerClientMain.ts b/app/features/ledger/ConcordiumLedgerClientMain.ts
@@ -44,6 +44,7 @@ import {
     CooldownParameters,
     PoolParameters,
     BlockEnergyLimit,
+    FinalizationCommitteeParameters,
 } from '~/utils/types';
 import { AccountPathInput, getAccountPath } from './Path';
 import getAppAndVersion, { AppAndVersion } from './GetAppAndVersion';
@@ -415,6 +416,20 @@ export default class ConcordiumLedgerClientMain {
         );
     }
 
+    signFinalizationCommitteeParameters(
+        transaction: UpdateInstruction<FinalizationCommitteeParameters>,
+        serializedPayload: Buffer,
+        path: number[]
+    ): Promise<Buffer> {
+        return signUpdateTransaction(
+            this.transport,
+            0x46,
+            path,
+            transaction,
+            serializedPayload
+        );
+    }
+
     getAppAndVersion(): Promise<AppAndVersion> {
         return getAppAndVersion(this.transport);
     }

diff --git a/app/pages/multisig/menu/MultiSignatureCreateProposalList.tsx b/app/pages/multisig/menu/MultiSignatureCreateProposalList.tsx
@@ -136,6 +136,12 @@ const updateInstructionTypes: TypeTuple[] = [
         'Update block energy limit',
         hasConsensusUpdateProtocol,
     ],
+    [
+        TransactionTypes.UpdateInstruction,
+        UpdateType.FinalizationCommitteeParameters,
+        'Update finalization committee parameters',
+        hasConsensusUpdateProtocol,
+    ],
 ];
 
 /**

diff --git a/.../multisig/updates/FinalizationCommitteeParameters/FinalizationCommitteeParametersShow.tsx b/.../multisig/updates/FinalizationCommitteeParameters/FinalizationCommitteeParametersShow.tsx
@@ -0,0 +1,36 @@
+import React from 'react';
+import { RewardFractionField } from '../common/RewardFractionField/RewardFractionField';
+import { fieldDisplays } from './util';
+import Label from '~/components/Label';
+import { FinalizationCommitteeParameters } from '~/utils/types';
+
+interface PoolParametersShowProps {
+    parameters: FinalizationCommitteeParameters;
+    title: string;
+}
+
+export default function ShowFinalizationCommitteeParameters({
+    parameters: {
+        minFinalizers,
+        maxFinalizers,
+        relativeStakeThresholdFraction,
+    },
+    title,
+}: PoolParametersShowProps): JSX.Element {
+    return (
+        <section className="mB40">
+            <h3>{title}</h3>
+            <div>
+                <Label className="mB5">{fieldDisplays.minFinalizers}:</Label>
+                <div className="body3 mono mB10">{minFinalizers}</div>
+                <Label className="mB5">{fieldDisplays.maxFinalizers}:</Label>
+                <div className="body3 mono mB10">{maxFinalizers}</div>
+                <RewardFractionField
+                    label={fieldDisplays.relativeStakeThresholdFraction}
+                    value={relativeStakeThresholdFraction}
+                    disabled
+                />
+            </div>
+        </section>
+    );
+}
diff --git a/.../multisig/updates/FinalizationCommitteeParameters/FinalizationCommitteeParametersView.tsx b/.../multisig/updates/FinalizationCommitteeParameters/FinalizationCommitteeParametersView.tsx
@@ -0,0 +1,45 @@
+import React from 'react';
+import { isChainParametersV0, isChainParametersV1 } from '@concordium/web-sdk';
+import Loading from '~/cross-app-components/Loading';
+import { FinalizationCommitteeParameters } from '~/utils/types';
+import withChainData, { ChainData } from '~/utils/withChainData';
+import ShowFinalizationCommitteeParameters from './FinalizationCommitteeParametersShow';
+import { getCurrentFinalizationCommitteeParameters } from './util';
+
+interface Props extends ChainData {
+    finalizationCommitteeParameters: FinalizationCommitteeParameters;
+}
+
+/**
+ * Displays an overview of a baker stake threshold.
+ */
+export default withChainData(function FinalizationCommitteeParametersView({
+    finalizationCommitteeParameters,
+    chainParameters,
+}: Props) {
+    if (!chainParameters) {
+        return <Loading inline />;
+    }
+
+    if (
+        isChainParametersV0(chainParameters) ||
+        isChainParametersV1(chainParameters)
+    ) {
+        throw new Error('Connected node used outdated chainParameters format');
+    }
+
+    const current = getCurrentFinalizationCommitteeParameters(chainParameters);
+
+    return (
+        <>
+            <ShowFinalizationCommitteeParameters
+                parameters={current}
+                title="Current finalization committee parameters"
+            />
+            <ShowFinalizationCommitteeParameters
+                parameters={finalizationCommitteeParameters}
+                title="New finalization committee parameters"
+            />
+        </>
+    );
+});
diff --git a/...ultisig/updates/FinalizationCommitteeParameters/UpdateFinalizationCommitteeParameters.tsx b/...ultisig/updates/FinalizationCommitteeParameters/UpdateFinalizationCommitteeParameters.tsx
@@ -0,0 +1,92 @@
+import React from 'react';
+import { isChainParametersV0, isChainParametersV1 } from '@concordium/web-sdk';
+import { EqualRecord } from '~/utils/types';
+import { UpdateProps } from '~/utils/transactionTypes';
+import Form from '~/components/Form/';
+import { mustBeAnInteger, requiredMessage, enterHere } from '../common/util';
+import {
+    FinalizationCommitteeParametersFields,
+    fieldDisplays,
+    getCurrentFinalizationCommitteeParameters,
+} from './util';
+import ShowFinalizationCommitteeParameters from './FinalizationCommitteeParametersShow';
+import { FormRewardFractionField as FractionFieldForm } from '../common/RewardFractionField/RewardFractionField';
+
+const fieldNames: EqualRecord<FinalizationCommitteeParametersFields> = {
+    minFinalizers: 'minFinalizers',
+    maxFinalizers: 'maxFinalizers',
+    relativeStakeThresholdFraction: 'relativeStakeThresholdFraction',
+};
+
+const UINT32_MAX = 2 ** 32 - 1; // UInt32 upper bound
+
+const validationRules = (name: string) => ({
+    required: requiredMessage(name),
+    min: {
+        value: 1,
+        message: `${name} must be positive`,
+    },
+    max: {
+        value: UINT32_MAX,
+        message: `${name} may not exceed ${UINT32_MAX}`,
+    },
+    validate: {
+        mustBeAnInteger,
+    },
+});
+
+/**
+ * Component for creating an update block energy limit transaction.
+ */
+export default function UpdateFinalizationCommitteeParametersFields({
+    defaults,
+    chainParameters,
+}: UpdateProps): JSX.Element | null {
+    if (
+        isChainParametersV0(chainParameters) ||
+        isChainParametersV1(chainParameters)
+    ) {
+        throw new Error('Connected node used outdated chainParameters format');
+    }
+
+    const current = getCurrentFinalizationCommitteeParameters(chainParameters);
+
+    return (
+        <div>
+            <ShowFinalizationCommitteeParameters
+                parameters={current}
+                title="Current finalization committee parameters"
+            />
+            <h3>New finalization committee parameters</h3>
+            <Form.Input
+                className="body2 mB5"
+                name={fieldNames.minFinalizers}
+                defaultValue={
+                    defaults.minFinalizers || current.minFinalizers.toString()
+                }
+                label={`New ${fieldDisplays.minFinalizers}`}
+                placeholder={enterHere(fieldDisplays.minFinalizers)}
+                rules={validationRules(fieldDisplays.minFinalizers)}
+            />
+            <Form.Input
+                className="body2"
+                name={fieldNames.maxFinalizers}
+                defaultValue={
+                    defaults.maxFinalizers || current.maxFinalizers.toString()
+                }
+                label={`New ${fieldDisplays.maxFinalizers}`}
+                placeholder={enterHere(fieldDisplays.maxFinalizers)}
+                rules={validationRules(fieldDisplays.maxFinalizers)}
+            />
+            <FractionFieldForm
+                label={fieldDisplays.relativeStakeThresholdFraction}
+                name={fieldNames.relativeStakeThresholdFraction}
+                className="mV20"
+                defaultValue={
+                    defaults.relativeStakeThresholdFraction ||
+                    current.relativeStakeThresholdFraction.toString()
+                }
+            />
+        </div>
+    );
+}
diff --git a/app/pages/multisig/updates/FinalizationCommitteeParameters/util.ts b/app/pages/multisig/updates/FinalizationCommitteeParameters/util.ts
@@ -0,0 +1,26 @@
+import { ChainParametersV2 } from '@concordium/common-sdk';
+import updateConstants from '~/constants/updateConstants.json';
+
+export interface FinalizationCommitteeParametersFields {
+    minFinalizers: number;
+    maxFinalizers: number;
+    relativeStakeThresholdFraction: number;
+}
+
+export const fieldDisplays = {
+    minFinalizers: 'Minimum number of finalizers',
+    maxFinalizers: 'Maximum number of finalizers',
+    relativeStakeThresholdFraction: 'Relative stake threshold fraction',
+};
+
+export function getCurrentFinalizationCommitteeParameters(
+    chainParameters: ChainParametersV2
+): FinalizationCommitteeParametersFields {
+    return {
+        relativeStakeThresholdFraction:
+            chainParameters.finalizerRelativeStakeThreshold *
+            updateConstants.rewardFractionResolution,
+        minFinalizers: chainParameters.minimumFinalizers,
+        maxFinalizers: chainParameters.maximumFinalizers,
+    };
+}
diff --git a/app/preload/ledger/ledger.ts b/app/preload/ledger/ledger.ts
@@ -30,6 +30,7 @@ import {
     CooldownParameters,
     PoolParameters,
     BlockEnergyLimit,
+    FinalizationCommitteeParameters,
 } from '~/utils/types';
 import { LedgerCommands } from '~/preload/preloadTypes';
 
@@ -289,6 +290,17 @@ export default function exposedMethods(
                 keypath
             );
         },
+        signFinalizationCommitteeParameters: (
+            transaction: UpdateInstruction<FinalizationCommitteeParameters>,
+            serializedPayload: Buffer,
+            keypath: number[]
+        ) => {
+            return getLedgerClient().signFinalizationCommitteeParameters(
+                transaction,
+                serializedPayload,
+                keypath
+            );
+        },
         getAppAndVersion: () => getLedgerClient().getAppAndVersion(),
         subscribe: () => subscribeLedger(eventEmitter),
         closeTransport,

diff --git a/app/preload/preloadLedgerTypes.ts b/app/preload/preloadLedgerTypes.ts
@@ -25,6 +25,7 @@ import {
     CooldownParameters,
     PoolParameters,
     BlockEnergyLimit,
+    FinalizationCommitteeParameters,
 } from '~/utils/types';
 import { AppAndVersion } from '../features/ledger/GetAppAndVersion';
 import { AccountPathInput } from '../features/ledger/Path';
@@ -109,6 +110,7 @@ type LedgerCommands = {
     signCooldownParameters: SignUpdate<CooldownParameters>;
     signPoolParameters: SignUpdate<PoolParameters>;
     signBlockEnergyLimit: SignUpdate<BlockEnergyLimit>;
+    signFinalizationCommitteeParameters: SignUpdate<FinalizationCommitteeParameters>;
     signHigherLevelKeysUpdate: SignKeyUpdate<HigherLevelKeyUpdate>;
     signAuthorizationKeysUpdate: SignVersionedKeyUpdate<AuthorizationKeysUpdate>;
     getAppAndVersion: () => Promise<AppAndVersion>;

diff --git a/app/utils/UpdateSerialization.ts b/app/utils/UpdateSerialization.ts
@@ -35,6 +35,7 @@ import {
     CommissionRanges,
     AuthorizationKeysUpdateType,
     BlockEnergyLimit,
+    FinalizationCommitteeParameters,
 } from './types';
 
 /**
@@ -64,6 +65,7 @@ export enum OnChainUpdateType {
     UpdateTimeParameters = 16,
     UpdateMintDistributionV1 = 17,
     UpdateBlockEnergyLimit = 20,
+    UpdateFinalizationCommitteeParameters = 22,
 }
 
 /**
@@ -222,6 +224,22 @@ export function serializeBlockEnergyLimit(blockEnergyLimit: BlockEnergyLimit) {
     return serializedBlockEnergyLimit;
 }
 
+/**
+ * Serializes a FinalizationCommitteeParameters to the byte format expected
+ * by the chain.
+ */
+export function serializeFinalizationCommitteeParameters(
+    finalizationCommitteeParameters: FinalizationCommitteeParameters
+) {
+    return Buffer.concat([
+        encodeWord32(finalizationCommitteeParameters.minFinalizers),
+        encodeWord32(finalizationCommitteeParameters.maxFinalizers),
+        encodeWord32(
+            finalizationCommitteeParameters.relativeStakeThresholdFraction
+        ),
+    ]);
+}
+
 /**
  * Serializes an ElectionDifficulty to bytes.
  */
@@ -594,6 +612,8 @@ function mapUpdateTypeToOnChainUpdateType(type: UpdateType): OnChainUpdateType {
             return OnChainUpdateType.UpdateMintDistributionV1;
         case UpdateType.BlockEnergyLimit:
             return OnChainUpdateType.UpdateBlockEnergyLimit;
+        case UpdateType.FinalizationCommitteeParameters:
+            return OnChainUpdateType.UpdateFinalizationCommitteeParameters;
         default:
             throw new Error(`An invalid update type was given: ${type}`);
     }