Merge pull request #637 from notV4l/634-contract-class-types

ContractClass types responses

__tests__/cairo1.test.ts

@@ -22,16 +22,17 @@ import {
   compiledComplexSierra,
   compiledHelloSierra,
   compiledHelloSierraCasm,
+  describeIfDevnet,
   describeIfDevnetSequencer,
   describeIfSequencerTestnet2,
   getTestAccount,
   getTestProvider,
 } from './fixtures';
 import { initializeMatcher } from './schema';
 
-describeIfDevnetSequencer('Cairo 1 Devnet Sequencer', () => {
-  describe('Sequencer API &  Contract interactions', () => {
-    const provider = getTestProvider() as SequencerProvider;
+describeIfDevnet('Cairo 1 Devnet', () => {
+  describe('API &  Contract interactions', () => {
+    const provider = getTestProvider();
     const account = getTestAccount(provider);
     let dd: DeclareDeployUDCResponse;
     let cairo1Contract: Contract;
@@ -59,11 +60,6 @@ describeIfDevnetSequencer('Cairo 1 Devnet Sequencer', () => {
       expect(deploy).toHaveProperty('address');
     });
 
-    test('getCompiledClassByClassHash', async () => {
-      const compiledClass = await provider.getCompiledClassByClassHash(dd.deploy.classHash);
-      expect(compiledClass).toMatchSchemaRef('CompiledClass');
-    });
-
     test('GetClassByHash', async () => {
       const classResponse = await provider.getClassByHash(dd.deploy.classHash);
       expect(classResponse).toMatchSchemaRef('SierraContractClass');
@@ -410,10 +406,19 @@ describeIfDevnetSequencer('Cairo 1 Devnet Sequencer', () => {
       expect(callDataFromObject).toStrictEqual(expectedResult);
       expect(callDataFromArray).toStrictEqual(expectedResult);
     });
+
+    describeIfDevnetSequencer('Sequencer only', () => {
+      test('getCompiledClassByClassHash', async () => {
+        const compiledClass = await (provider as SequencerProvider).getCompiledClassByClassHash(
+          dd.deploy.classHash
+        );
+        expect(compiledClass).toMatchSchemaRef('CompiledClass');
+      });
+    });
   });
 
   describe('Cairo1 Account contract', () => {
-    const provider = getTestProvider() as SequencerProvider;
+    const provider = getTestProvider();
     const account = getTestAccount(provider);
     let accountC1: Account;
 

src/provider/default.ts

@@ -5,7 +5,7 @@ import {
   BlockIdentifier,
   Call,
   CallContractResponse,
-  ContractClass,
+  ContractClassResponse,
   DeclareContractResponse,
   DeclareContractTransaction,
   DeployAccountContractTransaction,
@@ -21,7 +21,6 @@ import {
   InvokeFunctionResponse,
   Nonce,
   ProviderOptions,
-  RPC,
   RpcProviderOptions,
   SequencerProviderOptions,
   SimulateTransactionResponse,
@@ -72,7 +71,7 @@ export class Provider implements ProviderInterface {
   public async getClassAt(
     contractAddress: string,
     blockIdentifier?: BlockIdentifier
-  ): Promise<ContractClass | RPC.ContractClass> {
+  ): Promise<ContractClassResponse> {
     return this.provider.getClassAt(contractAddress, blockIdentifier);
   }
 
@@ -83,7 +82,7 @@ export class Provider implements ProviderInterface {
     return this.provider.getClassHashAt(contractAddress, blockIdentifier);
   }
 
-  public getClassByHash(classHash: string): Promise<ContractClass | RPC.ContractClass> {
+  public getClassByHash(classHash: string): Promise<ContractClassResponse> {
     return this.provider.getClassByHash(classHash);
   }
 

src/provider/interface.ts

@@ -5,7 +5,7 @@ import type {
   BlockIdentifier,
   Call,
   CallContractResponse,
-  ContractClass,
+  ContractClassResponse,
   DeclareContractResponse,
   DeclareContractTransaction,
   DeployAccountContractPayload,
@@ -21,7 +21,6 @@ import type {
   InvocationsDetailsWithNonce,
   InvokeFunctionResponse,
   Nonce,
-  RPC,
   SimulateTransactionResponse,
   StateUpdateResponse,
   Storage,
@@ -76,7 +75,7 @@ export abstract class ProviderInterface {
   public abstract getClassAt(
     contractAddress: string,
     blockIdentifier?: BlockIdentifier
-  ): Promise<ContractClass | RPC.ContractClass>;
+  ): Promise<ContractClassResponse>;
 
   /**
    * Returns the class hash deployed under the given address.
@@ -96,7 +95,7 @@ export abstract class ProviderInterface {
    * @param classHash - class hash
    * @returns Contract class of compiled contract
    */
-  public abstract getClassByHash(classHash: string): Promise<ContractClass | RPC.ContractClass>;
+  public abstract getClassByHash(classHash: string): Promise<ContractClassResponse>;
 
   /**
    * Gets the nonce of a contract with respect to a specific block

src/provider/rpc.ts

@@ -6,6 +6,7 @@ import {
   BlockIdentifier,
   Call,
   CallContractResponse,
+  ContractClassResponse,
   DeclareContractResponse,
   DeclareContractTransaction,
   DeployAccountContractTransaction,
@@ -215,27 +216,30 @@ export class RpcProvider implements ProviderInterface {
     return this.fetchEndpoint('starknet_getTransactionReceipt', { transaction_hash: txHash });
   }
 
-  public async getClassByHash(classHash: RPC.Felt): Promise<RPC.ContractClass> {
+  public async getClassByHash(classHash: RPC.Felt): Promise<ContractClassResponse> {
     return this.getClass(classHash);
   }
 
   public async getClass(
     classHash: RPC.Felt,
     blockIdentifier: BlockIdentifier = this.blockIdentifier
-  ): Promise<RPC.ContractClass> {
+  ): Promise<ContractClassResponse> {
     const block_id = new Block(blockIdentifier).identifier;
-    return this.fetchEndpoint('starknet_getClass', { class_hash: classHash, block_id });
+    return this.fetchEndpoint('starknet_getClass', {
+      class_hash: classHash,
+      block_id,
+    }).then(this.responseParser.parseContractClassResponse);
   }
 
   public async getClassAt(
     contractAddress: string,
     blockIdentifier: BlockIdentifier = this.blockIdentifier
-  ): Promise<RPC.ContractClass> {
+  ): Promise<ContractClassResponse> {
     const block_id = new Block(blockIdentifier).identifier;
     return this.fetchEndpoint('starknet_getClassAt', {
       block_id,
       contract_address: contractAddress,
-    });
+    }).then(this.responseParser.parseContractClassResponse);
   }
 
   public async getCode(

src/provider/sequencer.ts

@@ -10,7 +10,7 @@ import {
   Call,
   CallContractResponse,
   CallL1Handler,
-  ContractClass,
+  ContractClassResponse,
   DeclareContractResponse,
   DeclareContractTransaction,
   DeployAccountContractTransaction,
@@ -48,7 +48,7 @@ import {
 } from '../utils/hash';
 import { parse, parseAlwaysAsBig, stringify } from '../utils/json';
 import { getDecimalString, getHexString, getHexStringArray, toBigInt, toHex } from '../utils/num';
-import { parseContract, wait } from '../utils/provider';
+import { wait } from '../utils/provider';
 import { SequencerAPIResponseParser } from '../utils/responseParser/sequencer';
 import { randomAddress, signatureToDecimalArray } from '../utils/stark';
 import { buildUrl } from '../utils/url';
@@ -314,14 +314,9 @@ export class SequencerProvider implements ProviderInterface {
   public async getClassAt(
     contractAddress: string,
     blockIdentifier: BlockIdentifier = this.blockIdentifier
-  ): Promise<ContractClass> {
+  ): Promise<ContractClassResponse> {
     return this.fetchEndpoint('get_full_contract', { blockIdentifier, contractAddress }).then(
-      (res) => {
-        if (isSierra(res)) {
-          return this.responseParser.parseSierraContractClassResponse(res);
-        }
-        return parseContract(res);
-      }
+      this.responseParser.parseContractClassResponse
     );
   }
 
@@ -335,13 +330,10 @@ export class SequencerProvider implements ProviderInterface {
   public async getClassByHash(
     classHash: string,
     blockIdentifier: BlockIdentifier = this.blockIdentifier
-  ): Promise<ContractClass> {
-    return this.fetchEndpoint('get_class_by_hash', { classHash, blockIdentifier }).then((res) => {
-      if (isSierra(res)) {
-        return this.responseParser.parseSierraContractClassResponse(res);
-      }
-      return parseContract(res);
-    });
+  ): Promise<ContractClassResponse> {
+    return this.fetchEndpoint('get_class_by_hash', { classHash, blockIdentifier }).then(
+      this.responseParser.parseContractClassResponse
+    );
   }
 
   public async getCompiledClassByClassHash(

src/types/api/rpc.ts

@@ -25,7 +25,6 @@ export namespace RPC {
   export type Traces = OPENRPC.Traces;
   export type BlockHash = OPENRPC.BlockHash;
   export type BlockHashAndNumber = OPENRPC.BlockHashAndNumber;
-  export type GetClassResponse = OPENRPC.ContractClass;
   export type EstimateFeeResponse = OPENRPC.EstimatedFee;
   export type GetBlockWithTxHashesResponse = OPENRPC.BlockWithTxHashes;
   export type GetBlockWithTxs = OPENRPC.BlockWithTxs;

src/types/lib/contract/sierra.ts

@@ -28,10 +28,7 @@ export type CompiledSierra = {
  * format produced after compressing 'sierra_program', stringifies 'abi' property and omit sierra_program_debug_info
  * CompressedCompiledSierra
  */
-export type SierraContractClass = Omit<
-  CompiledSierra,
-  'sierra_program' | 'abi' | 'sierra_program_debug_info'
-> & {
+export type SierraContractClass = Omit<CompiledSierra, 'abi' | 'sierra_program_debug_info'> & {
   sierra_program: string;
   abi: string;
 };

src/types/provider/response.ts

@@ -6,9 +6,11 @@
 import { RPC } from '../api/rpc';
 import { Sequencer } from '../api/sequencer';
 import {
+  Abi,
   AllowArray,
   ByteCode,
   Call,
+  ContractClass,
   DeclareContractPayload,
   DeployAccountContractPayload,
   RawCalldata,
@@ -169,3 +171,5 @@ export interface StateUpdateResponse {
     deprecated_declared_classes?: RPC.DeprecatedDeclaredClasses; // RPC Only
   };
 }
+
+export type ContractClassResponse = Omit<ContractClass, 'abi'> & { abi?: Abi };

src/utils/hash.ts

@@ -191,22 +191,23 @@ function nullSkipReplacer(key: string, value: any) {
   return value === null ? undefined : value;
 }
 
+// about 10x to 100x faster using array to build string
 export function formatSpaces(json: string) {
   let insideQuotes = false;
-  let newString = '';
+  const newString = [];
   // eslint-disable-next-line no-restricted-syntax
   for (const char of json) {
-    if (char === '"' && newString.endsWith('\\') === false) {
+    if (char === '"' && (newString.length > 0 && newString.slice(-1)[0] === '\\') === false) {
       insideQuotes = !insideQuotes;
     }
     if (insideQuotes) {
-      newString += char;
+      newString.push(char);
     } else {
       // eslint-disable-next-line no-nested-ternary
-      newString += char === ':' ? ': ' : char === ',' ? ', ' : char;
+      newString.push(char === ':' ? ': ' : char === ',' ? ', ' : char);
     }
   }
-  return newString;
+  return newString.join('');
 }
 
 export default function computeHintedClassHash(compiledContract: LegacyCompiledContract) {

src/utils/responseParser/rpc.ts

@@ -4,6 +4,7 @@
  */
 import {
   CallContractResponse,
+  ContractClassResponse,
   EstimateFeeResponse,
   EstimateFeeResponseBulk,
   GetBlockResponse,
@@ -92,4 +93,11 @@ export class RPCResponseParser
       };
     });
   }
+
+  public parseContractClassResponse(res: RPC.ContractClass): ContractClassResponse {
+    return {
+      ...res,
+      abi: typeof res.abi === 'string' ? JSON.parse(res.abi) : res.abi,
+    };
+  }
 }

src/utils/responseParser/sequencer.ts

@@ -2,8 +2,11 @@
  * Map Sequencer Response to common interface response
  * Intersection (sequencer response ∩ (∪ rpc responses))
  */
+
 import {
   CallContractResponse,
+  CompiledContract,
+  ContractClassResponse,
   DeclareContractResponse,
   DeployContractResponse,
   EstimateFeeResponse,
@@ -14,11 +17,12 @@ import {
   HexCalldata,
   InvokeFunctionResponse,
   Sequencer,
-  SierraContractClass,
   SimulateTransactionResponse,
   StateUpdateResponse,
 } from '../../types';
+import { isSierra } from '../contract';
 import { toBigInt } from '../num';
+import { parseContract } from '../provider';
 import { estimatedFeeToMaxFee } from '../stark';
 import { ResponseParser } from '.';
 
@@ -199,11 +203,11 @@ export class SequencerAPIResponseParser extends ResponseParser {
     };
   }
 
-  // TODO: Define response as new type as it diff from ContractClass
-  public parseSierraContractClassResponse(res: any): SierraContractClass {
+  public parseContractClassResponse(res: CompiledContract): ContractClassResponse {
+    const response = isSierra(res) ? res : parseContract(res);
     return {
-      ...res,
-      abi: JSON.parse(res.abi),
+      ...response,
+      abi: typeof response.abi === 'string' ? JSON.parse(response.abi) : response.abi,
     };
   }
 }