feat: support new operation UpdateConsensusKey for Lima

re #2065

packages/taquito/src/batch/rpc-batch-provider.ts

@@ -13,6 +13,7 @@ import {
   createTxRollupBatchOperation,
   createTransferTicketOperation,
   createIncreasePaidStorageOperation,
+  createUpdateConsensusKeyOperation,
 } from '../contract/prepare';
 import { BatchOperation } from '../operations/batch-operation';
 import { OperationEmitter } from '../operations/operation-emitter';
@@ -31,6 +32,7 @@ import {
   TxRollupBatchParams,
   TransferTicketParams,
   IncreasePaidStorageParams,
+  UpdateConsensusKeyParams,
 } from '../operations/types';
 import { OpKind } from '@taquito/rpc';
 import { ContractMethodObject } from '../contract/contract-methods/contract-method-object-param';
@@ -173,6 +175,17 @@ export class OperationBatch extends OperationEmitter {
     return this;
   }
 
+  /**
+   *
+   * @description Add an operation to update consensus key to the batch
+   *
+   * @param params UpdateConsensusKey operation parameter
+   */
+  withUpdateConsensusKey(params: UpdateConsensusKeyParams) {
+    this.operations.push({ kind: OpKind.UPDATE_CONSENSUS_KEY, ...params });
+    return this;
+  }
+
   /**
    *
    * @description Add an operation to originate a rollup to the batch
@@ -223,6 +236,10 @@ export class OperationBatch extends OperationEmitter {
         return createIncreasePaidStorageOperation({
           ...param,
         });
+      case OpKind.UPDATE_CONSENSUS_KEY:
+        return createUpdateConsensusKeyOperation({
+          ...param,
+        });
       case OpKind.TX_ROLLUP_ORIGINATION:
         return createTxRollupOriginationOperation({
           ...param,
@@ -267,6 +284,9 @@ export class OperationBatch extends OperationEmitter {
         case OpKind.INCREASE_PAID_STORAGE:
           this.withIncreasePaidStorage(param);
           break;
+        case OpKind.UPDATE_CONSENSUS_KEY:
+          this.withUpdateConsensusKey(param);
+          break;
         case OpKind.TX_ROLLUP_ORIGINATION:
           this.withTxRollupOrigination(param);
           break;

packages/taquito/src/contract/interface.ts

@@ -19,11 +19,13 @@ import {
   TxRollupOriginateParams,
   TxRollupBatchParams,
   IncreasePaidStorageParams,
+  UpdateConsensusKeyParams,
   TransferTicketParams,
 } from '../operations/types';
 import { ContractAbstraction, ContractStorageType, DefaultContractType } from './contract';
 import { TxRollupBatchOperation } from '../operations/tx-rollup-batch-operation';
 import { IncreasePaidStorageOperation } from '../operations/increase-paid-storage-operation';
+import { UpdateConsensusKeyOperation } from '../operations/update-consensus-key-operation';
 import { TransferTicketOperation } from '../operations/transfer-ticket-operation';
 
 export type ContractSchema = Schema | unknown;
@@ -195,6 +197,16 @@ export interface ContractProvider extends StorageProvider {
    */
   increasePaidStorage(params: IncreasePaidStorageParams): Promise<IncreasePaidStorageOperation>;
 
+  /**
+   *
+   * @description Update the consensus key of the signing delegate to pk
+   *
+   * @returns An operation handle with the result from the rpc node
+   *
+   * @param params UpdateConsensusKey operation parameter
+   */
+  updateConsensusKey(params: UpdateConsensusKeyParams): Promise<UpdateConsensusKeyOperation>;
+
   /**
    *
    * @description Originate a new tx rollup. Will sign and inject an operation using the current context

packages/taquito/src/contract/prepare.ts

@@ -21,6 +21,8 @@ import {
   RPCTransferTicketOperation,
   IncreasePaidStorageParams,
   RPCIncreasePaidStorageOperation,
+  UpdateConsensusKeyParams,
+  RPCUpdateConsensusKeyOperation,
 } from '../operations/types';
 import { DEFAULT_FEE, DEFAULT_GAS_LIMIT, DEFAULT_STORAGE_LIMIT } from '../constants';
 import { format } from '@taquito/utils';
@@ -264,3 +266,20 @@ export const createIncreasePaidStorageOperation = async ({
     destination,
   } as RPCIncreasePaidStorageOperation;
 };
+
+export const createUpdateConsensusKeyOperation = async ({
+  source,
+  fee,
+  gasLimit,
+  storageLimit,
+  pk,
+}: UpdateConsensusKeyParams) => {
+  return {
+    kind: OpKind.UPDATE_CONSENSUS_KEY,
+    source,
+    fee,
+    gas_limit: gasLimit,
+    storage_limit: storageLimit,
+    pk,
+  } as RPCUpdateConsensusKeyOperation;
+};

packages/taquito/src/contract/rpc-contract-provider.ts

@@ -25,6 +25,7 @@ import {
   TxRollupBatchParams,
   TransferTicketParams,
   IncreasePaidStorageParams,
+  UpdateConsensusKeyParams,
 } from '../operations/types';
 import { DefaultContractType, ContractStorageType, ContractAbstraction } from './contract';
 import { InvalidDelegationSource, RevealOperationError } from './errors';
@@ -40,6 +41,7 @@ import {
   createTxRollupBatchOperation,
   createTransferTicketOperation,
   createIncreasePaidStorageOperation,
+  createUpdateConsensusKeyOperation,
 } from './prepare';
 import { smartContractAbstractionSemantic } from './semantic';
 import {
@@ -54,6 +56,7 @@ import { TxRollupOriginationOperation } from '../operations/tx-rollup-originatio
 import { TxRollupBatchOperation } from '../operations/tx-rollup-batch-operation';
 import { TransferTicketOperation } from '../operations/transfer-ticket-operation';
 import { IncreasePaidStorageOperation } from '../operations/increase-paid-storage-operation';
+import { UpdateConsensusKeyOperation } from '../operations/update-consensus-key-operation';
 
 export class RpcContractProvider
   extends OperationEmitter
@@ -521,6 +524,38 @@ export class RpcContractProvider
     );
   }
 
+  /**
+   *
+   * @description Update the consensus key of the signing delegate to pk
+   *
+   * @returns An operation handle with the result from the rpc node
+   *
+   * @param params updateConsensusKey operation parameter
+   */
+  async updateConsensusKey(params: UpdateConsensusKeyParams) {
+    const publicKeyHash = await this.signer.publicKeyHash();
+    const estimate = await this.estimate(
+      params,
+      this.estimator.updateConsensusKey.bind(this.estimator)
+    );
+    const operation = await createUpdateConsensusKeyOperation({
+      ...params,
+      ...estimate,
+    });
+    const ops = await this.addRevealOperationIfNeeded(operation, publicKeyHash);
+    const prepared = await this.prepareOperation({ operation: ops, source: publicKeyHash });
+    const opBytes = await this.forge(prepared);
+    const { hash, context, forgedBytes, opResponse } = await this.signAndInject(opBytes);
+    return new UpdateConsensusKeyOperation(
+      hash,
+      operation,
+      publicKeyHash,
+      forgedBytes,
+      opResponse,
+      context
+    );
+  }
+
   /**
    *
    * @description Originate a new tx rollup. Will sign and inject an operation using the current context

packages/taquito/src/estimate/estimate-provider-interface.ts

@@ -12,6 +12,7 @@ import {
   TxRollupBatchParams,
   TransferTicketParams,
   IncreasePaidStorageParams,
+  UpdateConsensusKeyParams,
 } from '../operations/types';
 import { Estimate } from './estimate';
 
@@ -98,6 +99,16 @@ export interface EstimationProvider {
    */
   increasePaidStorage(params: IncreasePaidStorageParams): Promise<Estimate>;
 
+  /**
+   *
+   * @description Estimate gasLimit, storageLimit and fees for an update consensus key operation
+   *
+   * @returns An estimation of gasLimit, storageLimit, and fees for the operation
+   *
+   * @param Estimate
+   */
+  updateConsensusKey(params: UpdateConsensusKeyParams): Promise<Estimate>;
+
   /**
    *
    * @description Estimate gasLimit, storageLimit and fees for a tx rollup origination operation

packages/taquito/src/estimate/rpc-estimate-provider.ts

@@ -22,6 +22,7 @@ import {
   TxRollupBatchParams,
   TransferTicketParams,
   IncreasePaidStorageParams,
+  UpdateConsensusKeyParams,
 } from '../operations/types';
 import { Estimate, EstimateProperties } from './estimate';
 import { EstimationProvider } from '../estimate/estimate-provider-interface';
@@ -36,6 +37,7 @@ import {
   createTxRollupBatchOperation,
   createTransferTicketOperation,
   createIncreasePaidStorageOperation,
+  createUpdateConsensusKeyOperation,
 } from '../contract/prepare';
 import {
   validateAddress,
@@ -452,6 +454,14 @@ export class RPCEstimateProvider extends OperationEmitter implements EstimationP
             })
           );
           break;
+        case OpKind.UPDATE_CONSENSUS_KEY:
+          operations.push(
+            await createUpdateConsensusKeyOperation({
+              ...param,
+              ...mergeLimits(param, DEFAULT_PARAMS),
+            })
+          );
+          break;
         default:
           throw new InvalidOperationKindError((params as any).kind);
       }
@@ -591,6 +601,37 @@ export class RPCEstimateProvider extends OperationEmitter implements EstimationP
     return Estimate.createEstimateInstanceFromProperties(estimateProperties);
   }
 
+  /**
+   *
+   * @description Estimate gasLimit, storageLimit, and fees for an updateConsensusKey operation
+   *
+   * @returns An estimation of gasLimit, storageLimit, and fees for the operation
+   *
+   * @param params updateConsensusKey operation parameters
+   */
+  async updateConsensusKey(params: UpdateConsensusKeyParams) {
+    const { fee, storageLimit, gasLimit, ...rest } = params;
+    const pkh = (await this.getKeys()).publicKeyHash;
+
+    const protocolConstants = await this.context.readProvider.getProtocolConstants('head');
+    const DEFAULT_PARAMS = await this.getAccountLimits(pkh, protocolConstants);
+    const op = await createUpdateConsensusKeyOperation({
+      ...rest,
+      ...mergeLimits({ fee, storageLimit, gasLimit }, DEFAULT_PARAMS),
+    });
+    const isRevealNeeded = await this.isRevealOpNeeded([op], pkh);
+    const ops = isRevealNeeded ? await this.addRevealOp([op], pkh) : op;
+    const estimateProperties = await this.prepareEstimate(
+      { operation: ops, source: pkh },
+      protocolConstants,
+      pkh
+    );
+    if (isRevealNeeded) {
+      estimateProperties.shift();
+    }
+    return Estimate.createEstimateInstanceFromProperties(estimateProperties);
+  }
+
   /**
    *
    * @description Estimate gasLimit, storageLimit and fees for a rollup origination operation

packages/taquito/src/operations/types.ts

@@ -17,6 +17,7 @@ export type ParamsWithKind =
   | withKind<ActivationParams, OpKind.ACTIVATION>
   | withKind<RegisterGlobalConstantParams, OpKind.REGISTER_GLOBAL_CONSTANT>
   | withKind<IncreasePaidStorageParams, OpKind.INCREASE_PAID_STORAGE>
+  | withKind<UpdateConsensusKeyParams, OpKind.UPDATE_CONSENSUS_KEY>
   | withKind<TxRollupOriginateParams, OpKind.TX_ROLLUP_ORIGINATION>
   | withKind<TxRollupBatchParams, OpKind.TX_ROLLUP_SUBMIT_BATCH>
   | withKind<TransferTicketParams, OpKind.TRANSFER_TICKET>;
@@ -54,6 +55,7 @@ export type RPCOpWithFee =
   | RPCRevealOperation
   | RPCRegisterGlobalConstantOperation
   | RPCIncreasePaidStorageOperation
+  | RPCUpdateConsensusKeyOperation
   | RPCTxRollupOriginationOperation
   | RPCTxRollupBatchOperation
   | RPCTransferTicketOperation;
@@ -64,6 +66,7 @@ export type RPCOpWithSource =
   | RPCRevealOperation
   | RPCRegisterGlobalConstantOperation
   | RPCIncreasePaidStorageOperation
+  | RPCUpdateConsensusKeyOperation
   | RPCTxRollupOriginationOperation
   | RPCTxRollupBatchOperation
   | RPCTransferTicketOperation;
@@ -425,6 +428,29 @@ export interface RPCIncreasePaidStorageOperation {
   destination: string;
 }
 
+/**
+ * @description Parameters for the updateConsensusKey method
+ */
+export interface UpdateConsensusKeyParams {
+  source?: string;
+  fee?: number;
+  gasLimit?: number;
+  storageLimit?: number;
+  pk: string;
+}
+
+/**
+ * @description RPC updateConsensusKey operation
+ */
+export interface RPCUpdateConsensusKeyOperation {
+  kind: OpKind.UPDATE_CONSENSUS_KEY;
+  source: string;
+  fee: number;
+  gas_limit: number;
+  storage_limit: number;
+  pk: string;
+}
+
 export type RPCOperation =
   | RPCOriginationOperation
   | RPCTransferOperation
@@ -435,7 +461,8 @@ export type RPCOperation =
   | RPCTxRollupOriginationOperation
   | RPCTxRollupBatchOperation
   | RPCTransferTicketOperation
-  | RPCIncreasePaidStorageOperation;
+  | RPCIncreasePaidStorageOperation
+  | RPCUpdateConsensusKeyOperation;
 
 export type PrepareOperationParams = {
   operation: RPCOperation | RPCOperation[];