fix: rpc 0.1.0 getStorageAt

starknet-io · Aug 29, 2022 · c622913 · c622913
1 parent 744a988
commit c622913
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 18 deletions.
diff --git a/__tests__/defaultProvider.test.ts b/__tests__/defaultProvider.test.ts
@@ -138,7 +138,7 @@ describe('defaultProvider', () => {
 
   describeIfNotDevnet('Provider', () => {
     const provider = getTestProvider();
-    describe(`Provider methods`, () => {
+    describe(`Provider methods if not devnet`, () => {
       describe('getBlock', () => {
         test('pending', async () => {
           const latestBlock = await provider.getBlock();

diff --git a/src/provider/default.ts b/src/provider/default.ts
@@ -1,6 +1,5 @@
 import { StarknetChainId } from '../constants';
 import {
-  BlockTag,
   Call,
   CallContractResponse,
   ContractClass,
@@ -68,9 +67,9 @@ export class Provider implements ProviderInterface {
   public async getStorageAt(
     contractAddress: string,
     key: BigNumberish,
-    blockTagOrHash: BlockTag | BigNumberish = 'pending'
+    blockIdentifier: BlockIdentifier = 'pending'
   ): Promise<BigNumberish> {
-    return this.provider.getStorageAt(contractAddress, key, blockTagOrHash);
+    return this.provider.getStorageAt(contractAddress, key, blockIdentifier);
   }
 
   public async getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse> {

diff --git a/src/provider/interface.ts b/src/provider/interface.ts
@@ -1,6 +1,5 @@
 import { StarknetChainId } from '../constants';
 import type {
-  BlockTag,
   Call,
   CallContractResponse,
   ContractClass,
@@ -59,13 +58,13 @@ export abstract class ProviderInterface {
    *
    * @param contractAddress
    * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
-   * @param blockHashOrTag - block hash or tag (pending, latest)
+   * @param blockIdentifier - block identifier
    * @returns the value of the storage variable
    */
   public abstract getStorageAt(
     contractAddress: string,
     key: BigNumberish,
-    blockHashOrTag?: BlockTag | BigNumberish
+    blockIdentifier: BlockIdentifier
   ): Promise<BigNumberish>;
 
   /**

diff --git a/src/provider/rpc.ts b/src/provider/rpc.ts
@@ -1,6 +1,5 @@
 import { StarknetChainId } from '../constants';
 import {
-  BlockTag,
   Call,
   CallContractResponse,
   DeclareContractPayload,
@@ -113,13 +112,14 @@ export class RpcProvider implements ProviderInterface {
   public async getStorageAt(
     contractAddress: string,
     key: BigNumberish,
-    blockHashOrTag: BlockTag | BigNumberish = 'pending'
+    blockIdentifier: BlockIdentifier = 'pending'
   ): Promise<BigNumberish> {
     const parsedKey = toHex(toBN(key));
+    const blockIdentifierGetter = new BlockIdentifierClass(blockIdentifier);
     return this.fetchEndpoint('starknet_getStorageAt', [
       contractAddress,
       parsedKey,
-      blockHashOrTag,
+      blockIdentifierGetter.getIdentifier(),
     ]);
   }
 

diff --git a/src/provider/sequencer.ts b/src/provider/sequencer.ts
@@ -2,7 +2,6 @@ import urljoin from 'url-join';
 
 import { ONE, StarknetChainId, ZERO } from '../constants';
 import {
-  BlockTag,
   Call,
   CallContractResponse,
   ContractClass,
@@ -233,11 +232,11 @@ export class SequencerProvider implements ProviderInterface {
   public async getStorageAt(
     contractAddress: string,
     key: BigNumberish,
-    blockHashOrTag: BlockTag | BigNumberish = 'pending'
+    blockIdentifier: BlockIdentifier = 'pending'
   ): Promise<BigNumberish> {
     const parsedKey = toBN(key).toString(10);
     return this.fetchEndpoint('get_storage_at', {
-      blockIdentifier: blockHashOrTag,
+      blockIdentifier,
       contractAddress,
       key: parsedKey,
     });

diff --git a/src/types/api/openrpc.ts b/src/types/api/openrpc.ts
@@ -2,7 +2,7 @@
  * Starknet RPC version 0.1.0
  * starknet_api_openrpc version 0.31.0
  *
- * TypeScript Representation of OpenRpc protocol types
+ * TypeScript Representation of OpenRpc protocol types | responses
  */
 
 /**
@@ -145,4 +145,5 @@ type PENDING_BLOCK_WITH_TXS = BLOCK_BODY_WITH_TXS & {
 export namespace OPENRPC {
   export type getBlockWithTxHashesResponse = BLOCK_WITH_TX_HASHES | PENDING_BLOCK_WITH_TX_HASHES;
   export type getBlockWithTxs = BLOCK_WITH_TXS | PENDING_BLOCK_WITH_TXS;
+  export type GetStorageAtResponse = FELT;
 }
diff --git a/src/types/api/rpc.ts b/src/types/api/rpc.ts
@@ -49,7 +49,7 @@ export namespace RPC {
     transactions: string[];
   }; */
 
-  export type GetStorageAtResponse = string;
+  export type GetStorageAtResponse = OPENRPC.GetStorageAtResponse;
 
   export type GetTransactionReceiptResponse = {
     txn_hash: string;

diff --git a/www/docs/API/provider.md b/www/docs/API/provider.md
@@ -49,8 +49,8 @@ const provider = new starknet.Provider({
 
 These are also default options for the Provider constructor with `network: 'goerli-alpha'`.
 
-> **Note** 
-> 
+> **Note**
+>
 > `network` arguement should work in most cases. If you want to use sequencer arguement with `baseUrl`, you will not be able to use `network` field in the object.
 
 ## Methods
@@ -117,7 +117,7 @@ Gets the contract class of the deployed contract.
 
 <hr/>
 
-provider.**getStorageAt**(contractAddress, key, blockHashOrTag) => _Promise < string >_
+provider.**getStorageAt**(contractAddress, key, blockIdentifier) => _Promise < string >_
 
 Gets the contract's storage variable at a specific key.