feat: implement new interface on contract class

src/account/default.ts

@@ -38,7 +38,7 @@ export class Account extends Provider implements AccountInterface {
  public async getNonce(): Promise<string> {
  const { result } = await this.callContract({
  contractAddress: this.address,
- entryPointSelector: 'get_nonce',
+ entrypoint: 'get_nonce',
  calldata: [],
  });
  return toHex(toBN(result[0]));
@@ -64,8 +64,9 @@ export class Account extends Provider implements AccountInterface {
 
  const calldata = fromCallsToExecuteCalldataWithNonce(transactions, nonce);
  const fetchedEstimate = await super.getEstimateFee(
- { contractAddress: this.address, entryPointSelector: '__execute__', calldata, signature },
- blockIdentifier
+ { contractAddress: this.address, entrypoint: '__execute__', calldata },
+ blockIdentifier,
+ signature
  );
 
  const suggestedMaxFee = estimatedFeeToMaxFee(fetchedEstimate.overallFee);
@@ -159,7 +160,7 @@ export class Account extends Provider implements AccountInterface {
  try {
  await this.callContract({
  contractAddress: this.address,
- entryPointSelector: 'is_valid_signature',
+ entrypoint: 'is_valid_signature',
  calldata: compileCalldata({
  hash: toBN(hash).toString(),
  signature: signature.map((x) => toBN(x).toString()),

src/account/interface.ts

@@ -1,6 +1,14 @@
 import { ProviderInterface } from '../provider';
 import { SignerInterface } from '../signer';
-import { Abi, Call, InvocationsDetails, InvokeFunctionResponse, Signature } from '../types';
+import {
+ Abi,
+ Call,
+ EstimateFee,
+ EstimateFeeDetails,
+ InvocationsDetails,
+ InvokeFunctionResponse,
+ Signature,
+} from '../types';
 import { BigNumberish } from '../utils/number';
 import { TypedData } from '../utils/typedData/types';
 
@@ -9,6 +17,22 @@ export abstract class AccountInterface extends ProviderInterface {
 
  public abstract signer: SignerInterface;
 
+ /**
+ * Estimate Fee for a method on starknet
+ *
+ * @param invocation the invocation object containing:
+ * - contractAddress - the address of the contract
+ * - entrypoint - the entrypoint of the contract
+ * - calldata - (defaults to []) the calldata
+ * - signature - (defaults to []) the signature
+ *
+ * @returns response from addTransaction
+ */
+ public abstract estimateFee(
+ calls: Call | Call[],
+ estimateFeeDetails?: EstimateFeeDetails
+ ): Promise<EstimateFee>;
+
  /**
  * Invoke execute function in account contract
  *

src/contract/default.ts

@@ -7,13 +7,13 @@ import { BlockIdentifier } from '../provider/utils';
 import {
  Abi,
  AbiEntry,
- AddTransactionResponse,
  Args,
  AsyncContractFunction,
  Calldata,
  ContractFunction,
  FunctionAbi,
  Invocation,
+ InvokeFunctionResponse,
  Overrides,
  ParsedStruct,
  Result,
@@ -97,7 +97,7 @@ export class Contract implements ContractInterface {
 
  address: string;
 
- providerOrAccount: ProviderInterface | AccountInterface;
+ providerOrAccount!: ProviderInterface | AccountInterface;
 
  deployTransactionHash?: string;
 
@@ -544,7 +544,7 @@ export class Contract implements ContractInterface {
  method: string,
  args: Array<any> = [],
  options: Overrides = {}
- ): Promise<AddTransactionResponse> {
+ ): Promise<InvokeFunctionResponse> {
  // ensure contract is connected
  assert(this.address !== null, 'contract isnt connected to an address');
  // validate method and args
@@ -578,6 +578,7 @@ export class Contract implements ContractInterface {
  });
  }
 
+ // TODO: throw warning
  return this.providerOrAccount.invokeFunction({
  ...invocation,
  signature: options.signature || [],
@@ -609,13 +610,12 @@ export class Contract implements ContractInterface {
  calldata,
  entrypoint: method,
  },
- { blockIdentifier }
+ blockIdentifier
  )
  .then((x) => this.parseResponse(method, x.result));
  }
 
  public async estimate(method: string, args: Array<any> = []) {
- // TODO; remove error as soon as estimate fees are supported
  // ensure contract is connected
  assert(this.address !== null, 'contract isnt connected to an address');
 

src/provider/default.ts

@@ -1,18 +1,19 @@
 import { StarknetChainId } from '../constants';
 import {
+ Call,
  CallContractResponse,
  DeclareContractPayload,
  DeclareContractResponse,
  DeployContractPayload,
  DeployContractResponse,
  EstimateFeeResponse,
- FunctionCall,
  GetBlockResponse,
  GetTransactionReceiptResponse,
  GetTransactionResponse,
  Invocation,
  InvocationsDetails,
  InvokeFunctionResponse,
+ Signature,
 } from '../types';
 import { BigNumberish } from '../utils/number';
 import { GatewayProvider, GatewayProviderOptions } from './gateway';
@@ -52,10 +53,11 @@ export class Provider implements ProviderInterface {
  }
 
  public async getEstimateFee(
- request: FunctionCall,
- blockIdentifier: BlockIdentifier
+ request: Call,
+ blockIdentifier: BlockIdentifier,
+ signature?: Signature
  ): Promise<EstimateFeeResponse> {
- return this.provider.getEstimateFee(request, blockIdentifier);
+ return this.provider.getEstimateFee(request, blockIdentifier, signature);
  }
 
  public async getStorageAt(
@@ -75,7 +77,7 @@ export class Provider implements ProviderInterface {
  }
 
  public async callContract(
- request: FunctionCall,
+ request: Call,
  blockIdentifier: BlockIdentifier = 'pending'
  ): Promise<CallContractResponse> {
  return this.provider.callContract(request, blockIdentifier);

src/provider/gateway.ts

@@ -2,14 +2,14 @@ import urljoin from 'url-join';
 
 import { ONE, StarknetChainId, ZERO } from '../constants';
 import {
+ Call,
  CallContractResponse,
  CompiledContract,
  DeclareContractPayload,
  DeclareContractResponse,
  DeployContractPayload,
  DeployContractResponse,
  EstimateFeeResponse,
- FunctionCall,
  Gateway,
  GetBlockResponse,
  GetContractAddressesResponse,
@@ -20,6 +20,7 @@ import {
  Invocation,
  InvocationsDetails,
  InvokeFunctionResponse,
+ Signature,
 } from '../types';
 import { getSelectorFromName } from '../utils/hash';
 import { parse, parseAlwaysAsBig, stringify } from '../utils/json';
@@ -205,7 +206,7 @@ export class GatewayProvider implements ProviderInterface {
  }
 
  public async callContract(
- { contractAddress, entryPointSelector, calldata = [] }: FunctionCall,
+ { contractAddress, entrypoint: entryPointSelector, calldata = [] }: Call,
  blockIdentifier: BlockIdentifier = 'pending'
  ): Promise<CallContractResponse> {
  return this.fetchEndpoint(
@@ -322,17 +323,17 @@ export class GatewayProvider implements ProviderInterface {
  }
 
  public async getEstimateFee(
- request: FunctionCall,
+ call: Call,
  blockIdentifier: BlockIdentifier = 'pending',
- signature?: Array<string>
+ signature?: Signature
  ): Promise<EstimateFeeResponse> {
  return this.fetchEndpoint(
  'estimate_fee',
  { blockIdentifier },
  {
- contract_address: request.contractAddress,
- entry_point_selector: getSelectorFromName(request.entryPointSelector),
- calldata: bigNumberishArrayToDecimalStringArray(request.calldata ?? []),
+ contract_address: call.contractAddress,
+ entry_point_selector: getSelectorFromName(call.entrypoint),
+ calldata: bigNumberishArrayToDecimalStringArray(call.calldata ?? []),
  signature: bigNumberishArrayToDecimalStringArray(signature || []),
  }
  ).then(this.responseParser.parseFeeEstimateResponse);

src/provider/interface.ts

@@ -1,18 +1,19 @@
 import { StarknetChainId } from '../constants';
 import type {
+ Call,
  CallContractResponse,
  DeclareContractPayload,
  DeclareContractResponse,
  DeployContractPayload,
  DeployContractResponse,
  EstimateFeeResponse,
- FunctionCall,
  GetBlockResponse,
  GetTransactionReceiptResponse,
  GetTransactionResponse,
  Invocation,
  InvocationsDetails,
  InvokeFunctionResponse,
+ Signature,
 } from '../types';
 import type { BigNumberish } from '../utils/number';
 import { BlockIdentifier } from './utils';
@@ -28,7 +29,7 @@ export abstract class ProviderInterface {
  * @returns the result of the function on the smart contract.
  */
  public abstract callContract(
- request: FunctionCall,
+ request: Call,
  blockIdentifier?: BlockIdentifier
  ): Promise<CallContractResponse>;
 
@@ -122,12 +123,13 @@ export abstract class ProviderInterface {
  */
  public abstract invokeFunction(
  invocation: Invocation,
- details: InvocationsDetails
+ details?: InvocationsDetails
  ): Promise<InvokeFunctionResponse>;
 
  public abstract getEstimateFee(
- request: FunctionCall,
- blockIdentifier: BlockIdentifier
+ request: Call,
+ blockIdentifier: BlockIdentifier,
+ signature?: Signature
  ): Promise<EstimateFeeResponse>;
 
  public abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;

src/provider/rpc.ts

@@ -2,21 +2,22 @@ import fetch from 'cross-fetch';
 
 import { StarknetChainId } from '../constants';
 import {
+ Call,
  CallContractResponse,
  CompiledContract,
  DeclareContractPayload,
  DeclareContractResponse,
  DeployContractPayload,
  DeployContractResponse,
  EstimateFeeResponse,
- FunctionCall,
  GetBlockResponse,
  GetTransactionReceiptResponse,
  GetTransactionResponse,
  Invocation,
  InvocationsDetails,
  InvokeFunctionResponse,
  RPC,
+ Signature,
 } from '../types';
 import { getSelectorFromName } from '../utils/hash';
 import { parse, stringify } from '../utils/json';
@@ -135,10 +136,11 @@ export class RPCProvider implements ProviderInterface {
  }
 
  public async getEstimateFee(
- request: FunctionCall,
- blockIdentifier: BlockIdentifier = 'pending'
+ call: Call,
+ blockIdentifier: BlockIdentifier = 'pending',
+ _signature: Signature = []
  ): Promise<EstimateFeeResponse> {
- const parsedCalldata = request.calldata.map((data) => {
+ const parsedCalldata = call.calldata?.map((data) => {
  if (typeof data === 'string' && isHex(data as string)) {
  return data;
  }
@@ -147,8 +149,8 @@ export class RPCProvider implements ProviderInterface {
 
  return this.fetchEndpoint('starknet_estimateFee', [
  {
- contract_address: request.contractAddress,
- entry_point_selector: getSelectorFromName(request.entryPointSelector),
+ contract_address: call.contractAddress,
+ entry_point_selector: getSelectorFromName(call.entrypoint),
  calldata: parsedCalldata,
  },
  blockIdentifier,
@@ -223,10 +225,10 @@ export class RPCProvider implements ProviderInterface {
  }
 
  public async callContract(
- request: FunctionCall,
+ call: Call,
  blockIdentifier: BlockIdentifier = 'pending'
  ): Promise<CallContractResponse> {
- const parsedCalldata = request.calldata.map((data) => {
+ const parsedCalldata = call.calldata?.map((data) => {
  if (typeof data === 'string' && isHex(data as string)) {
  return data;
  }
@@ -235,8 +237,8 @@ export class RPCProvider implements ProviderInterface {
 
  const result = await this.fetchEndpoint('starknet_call', [
  {
- contract_address: request.contractAddress,
- entry_point_selector: getSelectorFromName(request.entryPointSelector),
+ contract_address: call.contractAddress,
+ entry_point_selector: getSelectorFromName(call.entrypoint),
  calldata: parsedCalldata,
  },
  blockIdentifier,