starknet 3.2.0 → 3.5.0

package/src/index.ts

@@ -1,8 +1,8 @@
 /**
  * Main
  */
-export * from './types';
 export * from './contract';
+export * from './types';
 export * from './provider';
 export * from './account';
 export * from './signer';

package/src/provider/default.ts

@@ -81,7 +81,7 @@ export class Provider implements ProviderInterface {
   }
 
   private getFetchMethod(endpoint: keyof Endpoints) {
-    const postMethodEndpoints = ['add_transaction', 'call_contract'];
+    const postMethodEndpoints = ['add_transaction', 'call_contract', 'estimate_fee'];
 
     return postMethodEndpoints.includes(endpoint) ? 'POST' : 'GET';
   }
@@ -167,20 +167,14 @@ export class Provider implements ProviderInterface {
    */
   public async callContract(
     { contractAddress, entrypoint, calldata = [] }: Call,
-    blockIdentifier: BlockIdentifier = null
+    options: { blockIdentifier: BlockIdentifier } = { blockIdentifier: null }
   ): Promise<CallContractResponse> {
-    return this.fetchEndpoint(
-      'call_contract',
-      {
-        blockIdentifier,
-      },
-      {
-        signature: [],
-        contract_address: contractAddress,
-        entry_point_selector: getSelectorFromName(entrypoint),
-        calldata,
-      }
-    );
+    return this.fetchEndpoint('call_contract', options, {
+      signature: [],
+      contract_address: contractAddress,
+      entry_point_selector: getSelectorFromName(entrypoint),
+      calldata,
+    });
   }
 
   /**
@@ -317,10 +311,8 @@ export class Provider implements ProviderInterface {
    * Invokes a function on starknet
    * @deprecated This method wont be supported as soon as fees are mandatory
    *
-   * @param contractAddress - target contract address for invoke
-   * @param entrypointSelector - target entrypoint selector for
-   * @param calldata - (optional, default []) calldata
-   * @param signature - (optional) signature to send along
+   * @param invocation
+   * @param _abi - (optional) signature to send along
    * @returns response from addTransaction
    */
   public invokeFunction(invocation: Invocation, _abi?: Abi): Promise<AddTransactionResponse> {
@@ -333,7 +325,18 @@ export class Provider implements ProviderInterface {
     });
   }
 
-  public async waitForTx(txHash: BigNumberish, retryInterval: number = 8000) {
+  public estimateFee(invocation: Invocation): Promise<any> {
+    return this.fetchEndpoint('estimate_fee', undefined, {
+      // TODO: change the TYPE of the call
+      type: 'INVOKE_FUNCTION',
+      contract_address: invocation.contractAddress,
+      entry_point_selector: getSelectorFromName(invocation.entrypoint),
+      calldata: bigNumberishArrayToDecimalStringArray(invocation.calldata ?? []),
+      signature: bigNumberishArrayToDecimalStringArray(invocation.signature ?? []),
+    });
+  }
+
+  public async waitForTransaction(txHash: BigNumberish, retryInterval: number = 8000) {
     let onchain = false;
     await wait(retryInterval);
 
@@ -355,4 +358,11 @@ export class Provider implements ProviderInterface {
       }
     }
   }
+
+  /**
+   * @deprecated use `waitForTransaction` instead
+   */
+  public async waitForTx(txHash: BigNumberish, retryInterval: number = 8000) {
+    return this.waitForTransaction(txHash, retryInterval);
+  }
 }

package/src/provider/interface.ts

@@ -40,7 +40,9 @@ export abstract class ProviderInterface {
    */
   public abstract callContract(
     invokeTransaction: Call,
-    blockIdentifier?: BlockIdentifier
+    options: {
+      blockIdentifier: BlockIdentifier;
+    }
   ): Promise<CallContractResponse>;
 
   /**
@@ -137,5 +139,10 @@ export abstract class ProviderInterface {
    */
   public abstract invokeFunction(invocation: Invocation): Promise<AddTransactionResponse>;
 
-  public abstract waitForTx(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+  public abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+
+  /**
+   * @deprecated use `waitForTransaction` instead
+   */
+  public abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
 }

package/src/types/api.ts

@@ -67,6 +67,11 @@ export type Endpoints = {
     REQUEST: CallContractTransaction;
     RESPONSE: CallContractResponse;
   };
+  estimate_fee: {
+    QUERY: never;
+    REQUEST: Transaction;
+    RESPONSE: EstimateFeeResponse;
+  };
 };
 
 export type GetContractAddressesResponse = {
@@ -168,6 +173,8 @@ export type TransactionReceipt = {
   l2_to_l1_messages: string[];
   events: string[];
 };
+// TODO: Add response data
+export type EstimateFeeResponse = {};
 
 export type RawArgs = {
   [inputName: string]: string | string[] | { type: 'struct'; [k: string]: BigNumberish };

package/src/types/contract.ts

@@ -0,0 +1,5 @@
+export type AsyncContractFunction<T = any> = (...args: Array<any>) => Promise<T>;
+export type ContractFunction = (...args: Array<any>) => any;
+export interface Result extends Array<any> {
+  [key: string]: any;
+}

package/src/types/index.ts

@@ -1,3 +1,4 @@
 export * from './lib';
 export * from './api';
 export * from './signer';
+export * from './contract';

package/src/types/lib.ts

@@ -45,7 +45,7 @@ export type FunctionAbi = {
   name: string;
   outputs: AbiEntry[];
   stateMutability?: 'view';
-  type: 'function';
+  type: 'function' | 'constructor';
 };
 
 export type StructAbi = {
@@ -70,3 +70,14 @@ export type CompiledContract = {
 export type CompressedCompiledContract = Omit<CompiledContract, 'program'> & {
   program: CompressedProgram;
 };
+
+export type Struct = {
+  type: 'struct';
+  [k: string]: BigNumberish;
+};
+export type Args = {
+  [inputName: string]: BigNumberish | BigNumberish[] | ParsedStruct | ParsedStruct[];
+};
+export type ParsedStruct = {
+  [key: string]: BigNumberish | ParsedStruct;
+};

package/src/utils/transaction.ts

@@ -1,5 +1,4 @@
-import { ParsedStruct } from '../contract';
-import { Call } from '../types';
+import { Call, ParsedStruct } from '../types';
 import { getSelectorFromName } from './hash';
 import { BigNumberish, bigNumberishArrayToDecimalStringArray, toBN } from './number';
 

package/types/api.d.ts

@@ -66,6 +66,11 @@ export declare type Endpoints = {
     REQUEST: CallContractTransaction;
     RESPONSE: CallContractResponse;
   };
+  estimate_fee: {
+    QUERY: never;
+    REQUEST: Transaction;
+    RESPONSE: EstimateFeeResponse;
+  };
 };
 export declare type GetContractAddressesResponse = {
   Starknet: string;
@@ -155,6 +160,7 @@ export declare type TransactionReceipt = {
   l2_to_l1_messages: string[];
   events: string[];
 };
+export declare type EstimateFeeResponse = {};
 export declare type RawArgs = {
   [inputName: string]:
     | string

package/types/contract.d.ts

@@ -0,0 +1,5 @@
+export declare type AsyncContractFunction<T = any> = (...args: Array<any>) => Promise<T>;
+export declare type ContractFunction = (...args: Array<any>) => any;
+export interface Result extends Array<any> {
+  [key: string]: any;
+}

package/types/contract.js

@@ -0,0 +1,2 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });

package/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from './lib';
 export * from './api';
 export * from './signer';
+export * from './contract';

package/types/index.js

@@ -26,3 +26,4 @@ Object.defineProperty(exports, '__esModule', { value: true });
 __exportStar(require('./lib'), exports);
 __exportStar(require('./api'), exports);
 __exportStar(require('./signer'), exports);
+__exportStar(require('./contract'), exports);

package/types/lib.d.ts

@@ -40,7 +40,7 @@ export declare type FunctionAbi = {
   name: string;
   outputs: AbiEntry[];
   stateMutability?: 'view';
-  type: 'function';
+  type: 'function' | 'constructor';
 };
 export declare type StructAbi = {
   members: (AbiEntry & {
@@ -62,3 +62,13 @@ export declare type CompiledContract = {
 export declare type CompressedCompiledContract = Omit<CompiledContract, 'program'> & {
   program: CompressedProgram;
 };
+export declare type Struct = {
+  type: 'struct';
+  [k: string]: BigNumberish;
+};
+export declare type Args = {
+  [inputName: string]: BigNumberish | BigNumberish[] | ParsedStruct | ParsedStruct[];
+};
+export declare type ParsedStruct = {
+  [key: string]: BigNumberish | ParsedStruct;
+};

package/utils/transaction.d.ts

@@ -1,5 +1,4 @@
-import { ParsedStruct } from '../contract';
-import { Call } from '../types';
+import { Call, ParsedStruct } from '../types';
 /**
  * Transforms a list of Calls, each with their own calldata, into
  * two arrays: one with the entrypoints, and one with the concatenated calldata.

package/contract.d.ts

@@ -1,98 +0,0 @@
-import { Provider } from './provider';
-import { BlockIdentifier } from './provider/utils';
-import { Abi, Signature, StructAbi } from './types';
-import { BigNumberish } from './utils/number';
-export declare type Struct = {
-  type: 'struct';
-  [k: string]: BigNumberish;
-};
-export declare type ParsedStruct = {
-  [key: string]: BigNumberish | ParsedStruct;
-};
-export declare type Args = {
-  [inputName: string]: BigNumberish | BigNumberish[] | ParsedStruct | ParsedStruct[];
-};
-export declare class Contract {
-  connectedTo: string | null;
-  abi: Abi;
-  structs: {
-    [name: string]: StructAbi;
-  };
-  provider: Provider;
-  /**
-   * Contract class to handle contract methods
-   *
-   * @param abi - Abi of the contract object
-   * @param address (optional) - address to connect to
-   */
-  constructor(abi: Abi, address?: string | null, provider?: Provider);
-  /**
-   * Saves the address of the contract deployed on network that will be used for interaction
-   *
-   * @param address - address of the contract
-   * @returns Contract
-   */
-  connect(address: string): Contract;
-  /**
-   * Validates if all arguments that are passed to the method are corresponding to the ones in the abi
-   *
-   * @param type - type of the method
-   * @param method  - name of the method
-   * @param args - arguments that are passed to the method
-   */
-  private validateMethodAndArgs;
-  /**
-   * Deep parse of the object that has been passed to the method
-   *
-   * @param element - element that needs to be parsed
-   * @param type  - name of the method
-   * @return {string | string[]} - parsed arguments in format that contract is expecting
-   */
-  private parseCalldataObject;
-  /**
-   * Parse of the response elements that are converted to Object (Struct) by using the abi
-   *
-   * @param responseIterator - iterator of the response
-   * @param type - type of the struct
-   * @return {BigNumberish | ParsedStruct} - parsed arguments in format that contract is expecting
-   */
-  private parseResponseStruct;
-  /**
-   * Parse one field of the calldata by using input field from the abi for that method
-   *
-   * @param args - value of the field
-   * @param input  - input(field) information from the abi that will be used to parse the data
-   * @return {string | string[]} - parsed arguments in format that contract is expecting
-   */
-  private parsCalldataField;
-  /**
-   * Parse the calldata by using input fields from the abi for that method
-   *
-   * @param args - arguments passed the the method
-   * @param inputs  - list of inputs(fields) that are in the abi
-   * @return {Calldata} - parsed arguments in format that contract is expecting
-   */
-  private compileCalldata;
-  /**
-   * Parse elements of the response and structuring them into one field by using output property from the abi for that method
-   *
-   * @param responseIterator - iterator of the response
-   * @param output  - output(field) information from the abi that will be used to parse the data
-   * @return - parsed response corresponding to the abi structure of the field
-   */
-  private parseResponseField;
-  /**
-   * Parse elements of the response array and structuring them into response object
-   *
-   * @param method - method name
-   * @param response  - response from the method
-   * @return - parsed response corresponding to the abi
-   */
-  private parseResponse;
-  invoke(
-    method: string,
-    args?: Args,
-    signature?: Signature
-  ): Promise<import('./types').AddTransactionResponse>;
-  call(method: string, args?: Args, blockIdentifier?: BlockIdentifier): Promise<Args>;
-}

package/dist/contract.d.ts

@@ -1,94 +0,0 @@
-import { Provider } from './provider';
-import { BlockIdentifier } from './provider/utils';
-import { Abi, Signature, StructAbi } from './types';
-import { BigNumberish } from './utils/number';
-export declare type Struct = {
-    type: 'struct';
-    [k: string]: BigNumberish;
-};
-export declare type ParsedStruct = {
-    [key: string]: BigNumberish | ParsedStruct;
-};
-export declare type Args = {
-    [inputName: string]: BigNumberish | BigNumberish[] | ParsedStruct | ParsedStruct[];
-};
-export declare class Contract {
-    connectedTo: string | null;
-    abi: Abi;
-    structs: {
-        [name: string]: StructAbi;
-    };
-    provider: Provider;
-    /**
-     * Contract class to handle contract methods
-     *
-     * @param abi - Abi of the contract object
-     * @param address (optional) - address to connect to
-     */
-    constructor(abi: Abi, address?: string | null, provider?: Provider);
-    /**
-     * Saves the address of the contract deployed on network that will be used for interaction
-     *
-     * @param address - address of the contract
-     * @returns Contract
-     */
-    connect(address: string): Contract;
-    /**
-     * Validates if all arguments that are passed to the method are corresponding to the ones in the abi
-     *
-     * @param type - type of the method
-     * @param method  - name of the method
-     * @param args - arguments that are passed to the method
-     */
-    private validateMethodAndArgs;
-    /**
-     * Deep parse of the object that has been passed to the method
-     *
-     * @param element - element that needs to be parsed
-     * @param type  - name of the method
-     * @return {string | string[]} - parsed arguments in format that contract is expecting
-     */
-    private parseCalldataObject;
-    /**
-     * Parse of the response elements that are converted to Object (Struct) by using the abi
-     *
-     * @param responseIterator - iterator of the response
-     * @param type - type of the struct
-     * @return {BigNumberish | ParsedStruct} - parsed arguments in format that contract is expecting
-     */
-    private parseResponseStruct;
-    /**
-     * Parse one field of the calldata by using input field from the abi for that method
-     *
-     * @param args - value of the field
-     * @param input  - input(field) information from the abi that will be used to parse the data
-     * @return {string | string[]} - parsed arguments in format that contract is expecting
-     */
-    private parsCalldataField;
-    /**
-     * Parse the calldata by using input fields from the abi for that method
-     *
-     * @param args - arguments passed the the method
-     * @param inputs  - list of inputs(fields) that are in the abi
-     * @return {Calldata} - parsed arguments in format that contract is expecting
-     */
-    private compileCalldata;
-    /**
-     * Parse elements of the response and structuring them into one field by using output property from the abi for that method
-     *
-     * @param responseIterator - iterator of the response
-     * @param output  - output(field) information from the abi that will be used to parse the data
-     * @return - parsed response corresponding to the abi structure of the field
-     */
-    private parseResponseField;
-    /**
-     * Parse elements of the response array and structuring them into response object
-     *
-     * @param method - method name
-     * @param response  - response from the method
-     * @return - parsed response corresponding to the abi
-     */
-    private parseResponse;
-    invoke(method: string, args?: Args, signature?: Signature): Promise<import("./types").AddTransactionResponse>;
-    call(method: string, args?: Args, blockIdentifier?: BlockIdentifier): Promise<Args>;
-}