2599 oxford2 supports attestation (#2775)

* feat: supports attesation along side endorsement re #2599 * feat: the rest of files of supports attesation along side endorsement * test: fix protocol logic in integration-tests/rpc-nodes.spec.ts * test: addressed pr comments of naming * test: updated contract-estimation-tests.spec.ts assertions
ecadlabs · Jan 5, 2024 · 4a0a6e8 · 4a0a6e8
1 parent cd1f805
commit 4a0a6e8
Show file tree

Hide file tree

Showing 24 changed files with 371 additions and 70 deletions.
diff --git a/cspell.json b/cspell.json
@@ -69,7 +69,10 @@
     "oxfordnet",
     "oxheadalpha",
     "Pkhfrom",
+    "preattestation",
     "precommit",
+    "preendorsement",
+    "preendorsements",
     "prevalidated",
     "prevalidation",
     "println",

diff --git a/docs/consensus_key.md b/docs/consensus_key.md
@@ -3,7 +3,7 @@ title: Consensus Keys
 author: Davis Sawali & Hui-An Yang
 ---
 
-The "consensus key" feature allows bakers to use a different key, called the consensus key. It will allow for baking and signing consensus operations (i.e. pre-endorsements and endorsements). For more detailed information on consensus keys, refer to [this documentation](https://tezos.gitlab.io/protocols/015_lima.html?highlight=update%20consensus%20key#consensus-key)
+The "consensus key" feature allows bakers to use a different key, called the consensus key. It will allow for baking and signing consensus operations (i.e. preattestation/preendorsements and attestation/endorsements). For more detailed information on consensus keys, refer to [this documentation](https://tezos.gitlab.io/protocols/015_lima.html?highlight=update%20consensus%20key#consensus-key)
 
 Starting from Lima protocol, these 2 new operations will be available:
 

diff --git a/example/example-streamer-custom-retry-logic.ts b/example/example-streamer-custom-retry-logic.ts
@@ -20,6 +20,10 @@ async function example() {
       ) as any
   }));
 
+  const bakerAttestationFilter = {
+    and: [{ source: 'tz2TSvNTh2epDMhZHrw73nV9piBX7kLZ9K9m' }, { kind: 'attestation' }]
+  }
+
   const bakerEndorsementFilter = {
     and: [{ source: 'tz2TSvNTh2epDMhZHrw73nV9piBX7kLZ9K9m' }, { kind: 'endorsement' }]
   }
@@ -29,7 +33,7 @@ async function example() {
   }
 
   tezos.stream.subscribeOperation({
-    or: [bakerEndorsementFilter, bakerDelegation]
+    or: [bakerAttestationFilter, bakerEndorsementFilter, bakerDelegation]
   })
 }
 

diff --git a/example/example-streamer.ts b/example/example-streamer.ts
@@ -6,6 +6,10 @@ async function example() {
   tezos.setStreamProvider(tezos.getFactory(PollingSubscribeProvider)({ shouldObservableSubscriptionRetry: true, pollingIntervalMilliseconds: 15000 }));
   try {
 
+    const bakerAttestationFilter = {
+      and: [{ source: 'tz1bQMn5xYFbX6geRxqvuAiTywsCtNywawxH' }, { kind: 'attestation' }]
+    }
+
     const bakerEndorsementFilter = {
       and: [{ source: 'tz1bQMn5xYFbX6geRxqvuAiTywsCtNywawxH' }, { kind: 'endorsement' }]
     }
@@ -15,7 +19,7 @@ async function example() {
     }
 
     const sub = tezos.stream.subscribeOperation({
-      or: [bakerEndorsementFilter, bakerDelegation]
+      or: [bakerAttestationFilter, bakerEndorsementFilter, bakerDelegation]
     })
 
     sub.on('data', console.log)

diff --git a/integration-tests/data/allTestsCases.ts b/integration-tests/data/allTestsCases.ts
@@ -48,36 +48,18 @@ interface TestCase {
   expected?: object;
 }
 
-export const nairobiCases: TestCase[] = [
+export const oxfordCases: TestCase[] = [
   {
-    name: 'Set deposits limit 1000000',
+    name: 'Attestation',
     operation: {
       branch: 'BLzyjjHKEKMULtvkpSHxuZxx6ei6fpntH2BTkYZiLgs8zLVstvX',
       contents: [
         {
-          kind: OpKind.SET_DEPOSITS_LIMIT,
-          counter: '1',
-          source: 'tz1QZ6KY7d3BuZDT1d19dUxoQrtFPN2QJ3hn',
-          fee: '10000',
-          gas_limit: '10',
-          storage_limit: '10',
-          limit: '1000000',
-        },
-      ],
-    },
-  },
-  {
-    name: 'Unset deposits limit',
-    operation: {
-      branch: 'BLzyjjHKEKMULtvkpSHxuZxx6ei6fpntH2BTkYZiLgs8zLVstvX',
-      contents: [
-        {
-          kind: OpKind.SET_DEPOSITS_LIMIT,
-          counter: '1',
-          source: 'tz1QZ6KY7d3BuZDT1d19dUxoQrtFPN2QJ3hn',
-          fee: '10000',
-          gas_limit: '10',
-          storage_limit: '10'
+          kind: OpKind.ATTESTATION,
+          slot: 0,
+          level: 66299,
+          round: 5,
+          block_payload_hash: 'vh3FEkypvxUYLwjGYd2Sme7aWyfX8npDsqxcL6imVpBWnAZeNn2n',
         },
       ],
     },
@@ -134,6 +116,40 @@ export const commonCases: TestCase[] = [
       ],
     },
   },
+
+  {
+    name: 'Set deposits limit 1000000',
+    operation: {
+      branch: 'BLzyjjHKEKMULtvkpSHxuZxx6ei6fpntH2BTkYZiLgs8zLVstvX',
+      contents: [
+        {
+          kind: OpKind.SET_DEPOSITS_LIMIT,
+          counter: '1',
+          source: 'tz1QZ6KY7d3BuZDT1d19dUxoQrtFPN2QJ3hn',
+          fee: '10000',
+          gas_limit: '10',
+          storage_limit: '10',
+          limit: '1000000',
+        },
+      ],
+    },
+  },
+  {
+    name: 'Unset deposits limit',
+    operation: {
+      branch: 'BLzyjjHKEKMULtvkpSHxuZxx6ei6fpntH2BTkYZiLgs8zLVstvX',
+      contents: [
+        {
+          kind: OpKind.SET_DEPOSITS_LIMIT,
+          counter: '1',
+          source: 'tz1QZ6KY7d3BuZDT1d19dUxoQrtFPN2QJ3hn',
+          fee: '10000',
+          gas_limit: '10',
+          storage_limit: '10'
+        },
+      ],
+    },
+  },
   {
     name: 'Seed nonce revelation',
     operation: {
@@ -1171,21 +1187,6 @@ export const commonCases: TestCase[] = [
       ],
     },
   },
-  {
-    name: 'Endorsement',
-    operation: {
-      branch: 'BLzyjjHKEKMULtvkpSHxuZxx6ei6fpntH2BTkYZiLgs8zLVstvX',
-      contents: [
-        {
-          kind: OpKind.ENDORSEMENT,
-          slot: 0,
-          level: 66299,
-          round: 5,
-          block_payload_hash: 'vh3FEkypvxUYLwjGYd2Sme7aWyfX8npDsqxcL6imVpBWnAZeNn2n',
-        },
-      ],
-    },
-  },
   {
     name: `Origination of a contract that contains the instructions SUB_MUTEZ`,
     operation: {

diff --git a/integration-tests/local-forging.spec.ts b/integration-tests/local-forging.spec.ts
@@ -1,16 +1,17 @@
 import { CONFIGS } from "./config";
-import { commonCases, nairobiCases } from './data/allTestsCases';
+import { commonCases, oxfordCases } from './data/allTestsCases';
 import { LocalForger, ProtocolsHash } from '@taquito/local-forging'
 import { Protocols, TezosToolkit } from "@taquito/taquito";
+import { ProtoGreaterOrEqual } from '@taquito/michel-codec'
 
 CONFIGS().forEach(({ rpc, protocol }) => {
   const Tezos = new TezosToolkit(rpc);
-  const nairobinet = protocol === Protocols.PtNairobi ? it : it.skip;
+  const oxfordAndAlpha = ProtoGreaterOrEqual(protocol, Protocols.ProxfordY) ? test : test.skip
 
   describe(`Test local forger: ${rpc}`, () => {
     // all protocols
-    nairobiCases.forEach(({ name, operation, expected }) => {
-      nairobinet(`Verify that .forge for local forge will return same result as for network forge for rpc: ${name} (${rpc})`, async () => {
+    oxfordCases.forEach(({ name, operation, expected }) => {
+      oxfordAndAlpha(`Verify that .forge for local forge will return same result as for network forge for rpc: ${name} (${rpc})`, async () => {
         const localForger = new LocalForger(protocol as unknown as ProtocolsHash);
         const result = await localForger.forge(operation);
         const rpcResult = await Tezos.rpc.forgeOperations(operation);

diff --git a/integration-tests/rpc-nodes.spec.ts b/integration-tests/rpc-nodes.spec.ts
@@ -21,7 +21,7 @@ CONFIGS().forEach(
   }) => {
     const Tezos = lib;
     const unrestrictedRPCNode = rpc.endsWith("ecadinfra.com") ? test.skip : test;
-    const oxfordAndAlpha = ProtoGreaterOrEqual(protocol, Protocols.ProxfordY) ? test : test.skip
+    const oxfordAndAlpha = ProtoGreaterOrEqual(protocol, Protocols.ProxfordY) ? test : test.skip;
 
     let ticketContract: DefaultContractType;
 
@@ -166,6 +166,19 @@ CONFIGS().forEach(
           expect(bakingRights[0].priority).toBeUndefined();
         });
 
+        unrestrictedRPCNode('Verify that rpcClient.getAttestationRights retrieves the list of delegates allowed to attest a block', async () => {
+          const attestationRights = await rpcClient.getAttestationRights();
+          expect(attestationRights).toBeDefined();
+          expect(attestationRights[0].delegates).toBeDefined();
+          expect(attestationRights[0].delegates![0].delegate).toBeDefined();
+          expect(typeof attestationRights[0].delegates![0].delegate).toEqual('string');
+          expect(attestationRights[0].delegates![0].attestation_power).toBeDefined();
+          expect(typeof attestationRights[0].delegates![0].attestation_power).toEqual('number');
+          expect(attestationRights[0].delegates![0].first_slot).toBeDefined();
+          expect(typeof attestationRights[0].delegates![0].first_slot).toEqual('number');
+          expect(attestationRights[0].delegate).toBeUndefined();
+        });
+
         unrestrictedRPCNode('Verify that rpcClient.getEndorsingRights retrieves the list of delegates allowed to endorse a block', async () => {
           const endorsingRights = await rpcClient.getEndorsingRights();
           expect(endorsingRights).toBeDefined();
@@ -448,7 +461,7 @@ CONFIGS().forEach(
         });
 
         it('Verify that rpcClient.getPendingOperations v1 will retrieve the pending operations in mempool with property applied', async () => {
-          const pendingOperations = await rpcClient.getPendingOperations({ version: '1'}) as PendingOperationsV1;
+          const pendingOperations = await rpcClient.getPendingOperations({ version: '1' }) as PendingOperationsV1;
           expect(pendingOperations).toBeDefined();
           expect(pendingOperations.applied).toBeInstanceOf(Array);
           expect(pendingOperations.refused).toBeInstanceOf(Array);

diff --git a/packages/taquito-contracts-library/src/rpc-wrapper.ts b/packages/taquito-contracts-library/src/rpc-wrapper.ts
@@ -17,6 +17,8 @@ import {
   DelegateResponse,
   DelegatesResponse,
   VotingInfoResponse,
+  AttestationRightsQueryArguments,
+  AttestationRightsResponse,
   EndorsingRightsQueryArguments,
   EndorsingRightsResponse,
   EntrypointsResponse,
@@ -172,6 +174,12 @@ export class RpcWrapperContractsLibrary implements RpcClientInterface {
   ): Promise<BakingRightsResponse> {
     return this.rpc.getBakingRights(args, { block });
   }
+  async getAttestationRights(
+    args: AttestationRightsQueryArguments,
+    { block }: RPCOptions = defaultRPCOptions
+  ): Promise<AttestationRightsResponse> {
+    return this.rpc.getAttestationRights(args, { block });
+  }
   async getEndorsingRights(
     args: EndorsingRightsQueryArguments,
     { block }: RPCOptions = defaultRPCOptions

diff --git a/packages/taquito-local-forging/src/constants.ts b/packages/taquito-local-forging/src/constants.ts
@@ -42,6 +42,7 @@ export enum CODEC {
   OP_ORIGINATION = 'origination',
   OP_BALLOT = 'ballot',
   OP_FAILING_NOOP = 'failing_noop',
+  OP_ATTESTATION = 'attestation',
   OP_ENDORSEMENT = 'endorsement',
   OP_SEED_NONCE_REVELATION = 'seed_nonce_revelation',
   OP_REVEAL = 'reveal',
@@ -237,7 +238,7 @@ export const kindMapping: { [key: number]: string } = {
   0x6c: 'transaction',
   0x6d: 'origination',
   0x06: 'ballot',
-  0x15: 'endorsement',
+  0x15: 'attestation',
   0x01: 'seed_nonce_revelation',
   0x05: 'proposals',
   0x6f: 'register_global_constant',

diff --git a/packages/taquito-local-forging/src/decoder.ts b/packages/taquito-local-forging/src/decoder.ts
@@ -31,6 +31,7 @@ import {
   ActivationSchema,
   BallotSchema,
   DelegationSchema,
+  AttestationSchema,
   EndorsementSchema,
   IncreasePaidStorageSchema,
   UpdateConsensusKeySchema,
@@ -99,6 +100,8 @@ decoders[CODEC.OP_TRANSACTION] = (val: Uint8ArrayConsumer) =>
 decoders[CODEC.OP_ORIGINATION] = (val: Uint8ArrayConsumer) =>
   schemaDecoder(decoders)(OriginationSchema)(val);
 decoders[CODEC.OP_BALLOT] = (val: Uint8ArrayConsumer) => schemaDecoder(decoders)(BallotSchema)(val);
+decoders[CODEC.OP_ATTESTATION] = (val: Uint8ArrayConsumer) =>
+  schemaDecoder(decoders)(AttestationSchema)(val);
 decoders[CODEC.OP_ENDORSEMENT] = (val: Uint8ArrayConsumer) =>
   schemaDecoder(decoders)(EndorsementSchema)(val);
 decoders[CODEC.OP_SEED_NONCE_REVELATION] = (val: Uint8ArrayConsumer) =>

diff --git a/packages/taquito-local-forging/src/encoder.ts b/packages/taquito-local-forging/src/encoder.ts
@@ -31,6 +31,7 @@ import {
   ActivationSchema,
   BallotSchema,
   DelegationSchema,
+  AttestationSchema,
   EndorsementSchema,
   IncreasePaidStorageSchema,
   UpdateConsensusKeySchema,
@@ -91,6 +92,7 @@ encoders[CODEC.OP_DELEGATION] = (val: any) => schemaEncoder(encoders)(Delegation
 encoders[CODEC.OP_TRANSACTION] = (val: any) => schemaEncoder(encoders)(TransactionSchema)(val);
 encoders[CODEC.OP_ORIGINATION] = (val: any) => schemaEncoder(encoders)(OriginationSchema)(val);
 encoders[CODEC.OP_BALLOT] = (val: any) => schemaEncoder(encoders)(BallotSchema)(val);
+encoders[CODEC.OP_ATTESTATION] = (val: any) => schemaEncoder(encoders)(AttestationSchema)(val);
 encoders[CODEC.OP_ENDORSEMENT] = (val: any) => schemaEncoder(encoders)(EndorsementSchema)(val);
 encoders[CODEC.OP_SEED_NONCE_REVELATION] = (val: any) =>
   schemaEncoder(encoders)(SeedNonceRevelationSchema)(val);

diff --git a/packages/taquito-local-forging/src/schema/operation.ts b/packages/taquito-local-forging/src/schema/operation.ts
@@ -65,6 +65,13 @@ export const BallotSchema = {
   ballot: CODEC.BALLOT_STATEMENT,
 };
 
+export const AttestationSchema = {
+  slot: CODEC.INT16,
+  level: CODEC.INT32,
+  round: CODEC.INT32,
+  block_payload_hash: CODEC.BLOCK_PAYLOAD_HASH,
+};
+
 export const EndorsementSchema = {
   slot: CODEC.INT16,
   level: CODEC.INT32,

diff --git a/packages/taquito-local-forging/src/validator.ts b/packages/taquito-local-forging/src/validator.ts
@@ -10,6 +10,7 @@ import {
   ProposalsSchema,
   RevealSchema,
   RegisterGlobalConstantSchema,
+  AttestationSchema,
   EndorsementSchema,
   TransferTicketSchema,
   IncreasePaidStorageSchema,
@@ -29,6 +30,7 @@ type OperationKind =
   | OpKind.TRANSACTION
   | OpKind.ORIGINATION
   | OpKind.BALLOT
+  | OpKind.ATTESTATION
   | OpKind.ENDORSEMENT
   | OpKind.SEED_NONCE_REVELATION
   | OpKind.PROPOSALS
@@ -49,6 +51,7 @@ const OperationKindMapping = {
   transaction: TransactionSchema,
   origination: OriginationSchema,
   ballot: BallotSchema,
+  attestation: AttestationSchema,
   endorsement: EndorsementSchema,
   seed_nonce_revelation: SeedNonceRevelationSchema,
   proposals: ProposalsSchema,

diff --git a/packages/taquito-rpc/src/opkind.ts b/packages/taquito-rpc/src/opkind.ts
@@ -4,12 +4,17 @@ export enum OpKind {
   REVEAL = 'reveal',
   TRANSACTION = 'transaction',
   ACTIVATION = 'activate_account',
+  ATTESTATION = 'attestation',
   ENDORSEMENT = 'endorsement',
+  PREATTESTATION = 'preattestation',
   PREENDORSEMENT = 'preendorsement',
   SET_DEPOSITS_LIMIT = 'set_deposits_limit',
+  DOUBLE_PREATTESTATION_EVIDENCE = 'double_preattestation_evidence',
   DOUBLE_PREENDORSEMENT_EVIDENCE = 'double_preendorsement_evidence',
+  ATTESTATION_WITH_SLOT = 'attestation_with_slot',
   ENDORSEMENT_WITH_SLOT = 'endorsement_with_slot',
   SEED_NONCE_REVELATION = 'seed_nonce_revelation',
+  DOUBLE_ATTESTATION_EVIDENCE = 'double_attestation_evidence',
   DOUBLE_ENDORSEMENT_EVIDENCE = 'double_endorsement_evidence',
   DOUBLE_BAKING_EVIDENCE = 'double_baking_evidence',
   PROPOSALS = 'proposals',

diff --git a/packages/taquito-rpc/src/rpc-client-interface.ts b/packages/taquito-rpc/src/rpc-client-interface.ts
@@ -17,6 +17,8 @@ import {
   CurrentQuorumResponse,
   DelegateResponse,
   DelegatesResponse,
+  AttestationRightsQueryArguments,
+  AttestationRightsResponse,
   EndorsingRightsQueryArguments,
   EndorsingRightsResponse,
   EntrypointsResponse,
@@ -84,6 +86,10 @@ export interface RpcClientInterface {
     args: BakingRightsQueryArguments,
     options?: RPCOptions
   ): Promise<BakingRightsResponse>;
+  getAttestationRights(
+    args: AttestationRightsQueryArguments,
+    options?: RPCOptions
+  ): Promise<AttestationRightsResponse>;
   getEndorsingRights(
     args: EndorsingRightsQueryArguments,
     options?: RPCOptions
@@ -150,6 +156,7 @@ export enum RPCMethodName {
   GET_DELEGATE = 'getDelegate',
   GET_DELEGATES = 'getDelegates',
   GET_VOTING_INFO = 'getVotingInfo',
+  GET_ATTESTATION_RIGHTS = 'getAttestationRights',
   GET_ENDORSING_RIGHTS = 'getEndorsingRights',
   GET_ENTRYPOINTS = 'getEntrypoints',
   GET_LIVE_BLOCKS = 'getLiveBlocks',