fix: restore GetCode to common interface for backward compatibility

starknet-io · Aug 30, 2022 · 52f8e61 · 52f8e61
1 parent 67d87fc
commit 52f8e61
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 5 deletions.
diff --git a/__tests__/defaultProvider.test.ts b/__tests__/defaultProvider.test.ts
@@ -46,6 +46,7 @@ describe('defaultProvider', () => {
     test(`getBlock(blockHash=${exampleBlockHash}, blockNumber=undefined)`, () => {
       return expect(testProvider.getBlock(exampleBlockHash)).resolves.not.toThrow();
     });
+
     test('getBlock(blockIdentifier=latest)', async () => {
       expect(exampleBlock).not.toBeNull();
 
@@ -250,13 +251,11 @@ describe('defaultProvider', () => {
       });
 
       describe('Contract methods', () => {
-        // let contractAddress: string;
         let deployResponse: DeployContractResponse;
         let declareResponse: DeclareContractResponse;
 
         beforeAll(async () => {
           deployResponse = await provider.deployContract({ contract: compiledErc20 });
-          // contractAddress = deployResponse.contract_address;
           declareResponse = await provider.declareContract({ contract: compiledErc20 });
           await Promise.all([
             provider.waitForTransaction(deployResponse.transaction_hash),

diff --git a/__tests__/sequencerProvider.test.ts b/__tests__/sequencerProvider.test.ts
@@ -7,7 +7,7 @@ import {
   getTestProvider,
 } from './fixtures';
 
-// This run only if Devnet Sequencer ?
+// Run only if Devnet Sequencer
 describeIfSequencer('SequencerProvider', () => {
   let provider: SequencerProvider;
   let customSequencerProvider: Provider;

diff --git a/src/provider/default.ts b/src/provider/default.ts
@@ -9,6 +9,7 @@ import {
   DeployContractResponse,
   EstimateFeeResponse,
   GetBlockResponse,
+  GetCodeResponse,
   GetTransactionReceiptResponse,
   GetTransactionResponse,
   Invocation,
@@ -102,6 +103,13 @@ export class Provider implements ProviderInterface {
     return this.provider.declareContract(payload);
   }
 
+  public async getCode(
+    contractAddress: string,
+    blockIdentifier?: BlockIdentifier
+  ): Promise<GetCodeResponse> {
+    return this.provider.getCode(contractAddress, blockIdentifier);
+  }
+
   public async waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void> {
     return this.provider.waitForTransaction(txHash, retryInterval);
   }

diff --git a/src/provider/interface.ts b/src/provider/interface.ts
@@ -9,6 +9,7 @@ import type {
   DeployContractResponse,
   EstimateFeeResponse,
   GetBlockResponse,
+  GetCodeResponse,
   GetTransactionReceiptResponse,
   GetTransactionResponse,
   Invocation,
@@ -41,6 +42,14 @@ export abstract class ProviderInterface {
    */
   public abstract getBlock(blockIdentifier: BlockIdentifier): Promise<GetBlockResponse>;
 
+  /**
+   * @deprecated The method should not be used
+   */
+  public abstract getCode(
+    contractAddress: string,
+    blockIdentifier?: BlockIdentifier
+  ): Promise<GetCodeResponse>;
+
   /**
    * Gets the contract class of the deployed contract.
    *

diff --git a/src/provider/rpc.ts b/src/provider/rpc.ts
@@ -8,6 +8,7 @@ import {
   DeployContractResponse,
   EstimateFeeResponse,
   GetBlockResponse,
+  GetCodeResponse,
   GetTransactionReceiptResponse,
   GetTransactionResponse,
   Invocation,
@@ -91,7 +92,7 @@ export class RpcProvider implements ProviderInterface {
 
   public async getBlockWithTxHashes(
     blockIdentifier: BlockIdentifier = 'pending'
-  ): Promise<RPC.getBlockWithTxHashesResponse> {
+  ): Promise<RPC.GetBlockWithTxHashesResponse> {
     const blockIdentifierGetter = new BlockIdentifierClass(blockIdentifier);
     return this.fetchEndpoint('starknet_getBlockWithTxHashes', [
       blockIdentifierGetter.getIdentifier(),
@@ -100,7 +101,7 @@ export class RpcProvider implements ProviderInterface {
 
   public async getBlockWithTxs(
     blockIdentifier: BlockIdentifier = 'pending'
-  ): Promise<RPC.getBlockWithTxs> {
+  ): Promise<RPC.GetBlockWithTxs> {
     const blockIdentifierGetter = new BlockIdentifierClass(blockIdentifier);
     return this.fetchEndpoint('starknet_getBlockWithTxs', [blockIdentifierGetter.getIdentifier()]);
   }
@@ -236,6 +237,13 @@ export class RpcProvider implements ProviderInterface {
     return this.responseParser.parseCallContractResponse(result);
   }
 
+  public async getCode(
+    _contractAddress: string,
+    _blockIdentifier?: BlockIdentifier
+  ): Promise<GetCodeResponse> {
+    throw new Error('RPC 0.1.0 does not implement getCode function');
+  }
+
   public async waitForTransaction(txHash: BigNumberish, retryInterval: number = 8000) {
     let onchain = false;
     let retries = 100;

diff --git a/src/types/provider.ts b/src/types/provider.ts
@@ -16,6 +16,11 @@ export interface GetBlockResponse {
   transactions: Array<string>;
 }
 
+export interface GetCodeResponse {
+  bytecode: string[];
+  // abi: string; // is not consistent between rpc and sequencer (is it?), therefore not included in the provider interface
+}
+
 export type GetTransactionResponse = InvokeTransactionResponse & DeclareTransactionResponse;
 
 export interface CommonTransactionResponse {