starknet 3.13.0 → 3.13.1

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [3.13.1](https://github.com/0xs34n/starknet.js/compare/v3.13.0...v3.13.1) (2022-06-14)
+
+### Bug Fixes
+
+- account estimate fee interface ([51e8cf6](https://github.com/0xs34n/starknet.js/commit/51e8cf6858acd5aed003f8f1c4d755088684f134))
+
 # [3.13.0](https://github.com/0xs34n/starknet.js/compare/v3.12.3...v3.13.0) (2022-06-14)
 
 ### Bug Fixes

package/account/default.d.ts

@@ -1,5 +1,4 @@
 import { Provider, ProviderInterface } from '../provider';
-import { BlockIdentifier } from '../provider/utils';
 import { SignerInterface } from '../signer';
 import {
   Abi,
@@ -10,7 +9,7 @@ import {
   Signature,
   Transaction,
 } from '../types';
-import { EstimateFee } from '../types/account';
+import { EstimateFee, EstimateFeeDetails } from '../types/account';
 import { BigNumberish } from '../utils/number';
 import { TypedData } from '../utils/typedData';
 import { AccountInterface } from './interface';
@@ -25,13 +24,7 @@ export declare class Account extends Provider implements AccountInterface {
   getNonce(): Promise<string>;
   estimateFee(
     calls: Call | Call[],
-    {
-      nonce: providedNonce,
-      blockIdentifier,
-    }?: {
-      nonce?: BigNumberish;
-      blockIdentifier?: BlockIdentifier;
-    }
+    { nonce: providedNonce, blockIdentifier }?: EstimateFeeDetails
   ): Promise<EstimateFee>;
   /**
    * Invoke execute function in account contract

package/account/interface.d.ts

@@ -5,11 +5,10 @@ import {
   AddTransactionResponse,
   Call,
   DeployContractPayload,
-  Invocation,
   InvocationsDetails,
   Signature,
 } from '../types';
-import { EstimateFee } from '../types/account';
+import { EstimateFee, EstimateFeeDetails } from '../types/account';
 import { BigNumberish } from '../utils/number';
 import { TypedData } from '../utils/typedData/types';
 export declare abstract class AccountInterface extends ProviderInterface {
@@ -40,7 +39,10 @@ export declare abstract class AccountInterface extends ProviderInterface {
    *
    * @returns response from addTransaction
    */
-  abstract estimateFee(invocation: Invocation): Promise<EstimateFee>;
+  abstract estimateFee(
+    calls: Call | Call[],
+    estimateFeeDetails?: EstimateFeeDetails
+  ): Promise<EstimateFee>;
   /**
    * Invoke execute function in account contract
    *

package/contract/default.d.ts

@@ -148,6 +148,6 @@ export declare class Contract implements ContractInterface {
       blockIdentifier?: BlockIdentifier;
     }
   ): Promise<Result>;
-  estimate(method: string, args?: Array<any>): Promise<import('../types/account').EstimateFee>;
+  estimate(method: string, args?: Array<any>): Promise<import('../types').EstimateFee>;
   populate(method: string, args?: Array<any>): Invocation;
 }

package/dist/account/default.d.ts

@@ -1,8 +1,7 @@
 import { Provider, ProviderInterface } from '../provider';
-import { BlockIdentifier } from '../provider/utils';
 import { SignerInterface } from '../signer';
 import { Abi, AddTransactionResponse, Call, InvocationsDetails, KeyPair, Signature, Transaction } from '../types';
-import { EstimateFee } from '../types/account';
+import { EstimateFee, EstimateFeeDetails } from '../types/account';
 import { BigNumberish } from '../utils/number';
 import { TypedData } from '../utils/typedData';
 import { AccountInterface } from './interface';
@@ -11,10 +10,7 @@ export declare class Account extends Provider implements AccountInterface {
     signer: SignerInterface;
     constructor(provider: ProviderInterface, address: string, keyPairOrSigner: KeyPair | SignerInterface);
     getNonce(): Promise<string>;
-    estimateFee(calls: Call | Call[], { nonce: providedNonce, blockIdentifier, }?: {
-        nonce?: BigNumberish;
-        blockIdentifier?: BlockIdentifier;
-    }): Promise<EstimateFee>;
+    estimateFee(calls: Call | Call[], { nonce: providedNonce, blockIdentifier }?: EstimateFeeDetails): Promise<EstimateFee>;
     /**
      * Invoke execute function in account contract
      *

package/dist/account/interface.d.ts

@@ -1,7 +1,7 @@
 import { ProviderInterface } from '../provider';
 import { SignerInterface } from '../signer';
-import { Abi, AddTransactionResponse, Call, DeployContractPayload, Invocation, InvocationsDetails, Signature } from '../types';
-import { EstimateFee } from '../types/account';
+import { Abi, AddTransactionResponse, Call, DeployContractPayload, InvocationsDetails, Signature } from '../types';
+import { EstimateFee, EstimateFeeDetails } from '../types/account';
 import { BigNumberish } from '../utils/number';
 import { TypedData } from '../utils/typedData/types';
 export declare abstract class AccountInterface extends ProviderInterface {
@@ -29,7 +29,7 @@ export declare abstract class AccountInterface extends ProviderInterface {
      *
      * @returns response from addTransaction
      */
-    abstract estimateFee(invocation: Invocation): Promise<EstimateFee>;
+    abstract estimateFee(calls: Call | Call[], estimateFeeDetails?: EstimateFeeDetails): Promise<EstimateFee>;
     /**
      * Invoke execute function in account contract
      *

package/dist/contract/default.d.ts

@@ -119,6 +119,6 @@ export declare class Contract implements ContractInterface {
     call(method: string, args?: Array<any>, { blockIdentifier, }?: {
         blockIdentifier?: BlockIdentifier;
     }): Promise<Result>;
-    estimate(method: string, args?: Array<any>): Promise<import("../types/account").EstimateFee>;
+    estimate(method: string, args?: Array<any>): Promise<import("../types").EstimateFee>;
     populate(method: string, args?: Array<any>): Invocation;
 }

package/dist/provider/default.d.ts

@@ -85,9 +85,9 @@ export declare class Provider implements ProviderInterface {
      */
     getTransactionStatus(txHash: BigNumberish): Promise<GetTransactionStatusResponse>;
     /**
-     * Gets the transaction receipt from a tx hash or tx id.
+     * Gets the transaction receipt from a tx hash.
      *
-     * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L104-L111)
+     * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/167b28bcd940fd25ea3816204fa882a0b0a49603/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L183)
      *
      * @param txHash
      * @returns the transaction receipt object

package/dist/provider/default.js

@@ -321,9 +321,9 @@ var Provider = /** @class */ (function () {
         });
     };
     /**
-     * Gets the transaction receipt from a tx hash or tx id.
+     * Gets the transaction receipt from a tx hash.
      *
-     * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L104-L111)
+     * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/167b28bcd940fd25ea3816204fa882a0b0a49603/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L183)
      *
      * @param txHash
      * @returns the transaction receipt object

package/dist/provider/interface.d.ts

@@ -74,6 +74,14 @@ export declare abstract class ProviderInterface {
      * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
      */
     abstract getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
+    /**
+     * Gets the transaction receipt from a tx hash.
+     *
+     * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/167b28bcd940fd25ea3816204fa882a0b0a49603/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L183)
+     *
+     * @param txHash
+     * @returns the transaction receipt object
+     */
     abstract getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse>;
     /**
      * Deploys a given compiled contract (json) to starknet

package/dist/types/account.d.ts

@@ -1,5 +1,11 @@
 import BN from 'bn.js';
+import { BlockIdentifier } from '../provider/utils';
+import { BigNumberish } from '../utils/number';
 import { EstimateFeeResponse } from './api';
 export interface EstimateFee extends EstimateFeeResponse {
     suggestedMaxFee: BN;
 }
+export interface EstimateFeeDetails {
+    nonce?: BigNumberish;
+    blockIdentifier?: BlockIdentifier;
+}

package/dist/types/index.d.ts

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

package/dist/types/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./lib"), exports);
 __exportStar(require("./api"), exports);
 __exportStar(require("./signer"), exports);
 __exportStar(require("./contract"), exports);
+__exportStar(require("./account"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "3.13.0",
+  "version": "3.13.1",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/provider/default.d.ts

@@ -122,9 +122,9 @@ export declare class Provider implements ProviderInterface {
    */
   getTransactionStatus(txHash: BigNumberish): Promise<GetTransactionStatusResponse>;
   /**
-   * Gets the transaction receipt from a tx hash or tx id.
+   * Gets the transaction receipt from a tx hash.
    *
-   * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L104-L111)
+   * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/167b28bcd940fd25ea3816204fa882a0b0a49603/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L183)
    *
    * @param txHash
    * @returns the transaction receipt object

package/provider/default.js

@@ -478,9 +478,9 @@ var Provider = /** @class */ (function () {
     });
   };
   /**
-   * Gets the transaction receipt from a tx hash or tx id.
+   * Gets the transaction receipt from a tx hash.
    *
-   * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L104-L111)
+   * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/167b28bcd940fd25ea3816204fa882a0b0a49603/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L183)
    *
    * @param txHash
    * @returns the transaction receipt object

package/provider/interface.d.ts

@@ -96,6 +96,14 @@ export declare abstract class ProviderInterface {
    * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
    */
   abstract getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
+  /**
+   * Gets the transaction receipt from a tx hash.
+   *
+   * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/167b28bcd940fd25ea3816204fa882a0b0a49603/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L183)
+   *
+   * @param txHash
+   * @returns the transaction receipt object
+   */
   abstract getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse>;
   /**
    * Deploys a given compiled contract (json) to starknet

package/src/account/default.ts

@@ -2,7 +2,6 @@ import assert from 'minimalistic-assert';
 
 import { ZERO } from '../constants';
 import { Provider, ProviderInterface } from '../provider';
-import { BlockIdentifier } from '../provider/utils';
 import { Signer, SignerInterface } from '../signer';
 import {
   Abi,
@@ -15,7 +14,7 @@ import {
   Signature,
   Transaction,
 } from '../types';
-import { EstimateFee } from '../types/account';
+import { EstimateFee, EstimateFeeDetails } from '../types/account';
 import { sign } from '../utils/ellipticCurve';
 import {
   computeHashOnElements,
@@ -56,10 +55,7 @@ export class Account extends Provider implements AccountInterface {
 
   public async estimateFee(
     calls: Call | Call[],
-    {
-      nonce: providedNonce,
-      blockIdentifier = 'pending',
-    }: { nonce?: BigNumberish; blockIdentifier?: BlockIdentifier } = {}
+    { nonce: providedNonce, blockIdentifier = 'pending' }: EstimateFeeDetails = {}
   ): Promise<EstimateFee> {
     const transactions = Array.isArray(calls) ? calls : [calls];
     const nonce = providedNonce ?? (await this.getNonce());

package/src/account/interface.ts

@@ -5,11 +5,10 @@ import {
   AddTransactionResponse,
   Call,
   DeployContractPayload,
-  Invocation,
   InvocationsDetails,
   Signature,
 } from '../types';
-import { EstimateFee } from '../types/account';
+import { EstimateFee, EstimateFeeDetails } from '../types/account';
 import { BigNumberish } from '../utils/number';
 import { TypedData } from '../utils/typedData/types';
 
@@ -44,7 +43,10 @@ export abstract class AccountInterface extends ProviderInterface {
    *
    * @returns response from addTransaction
    */
-  public abstract estimateFee(invocation: Invocation): Promise<EstimateFee>;
+  public abstract estimateFee(
+    calls: Call | Call[],
+    estimateFeeDetails?: EstimateFeeDetails
+  ): Promise<EstimateFee>;
 
   /**
    * Invoke execute function in account contract

package/src/provider/default.ts

@@ -272,14 +272,13 @@ export class Provider implements ProviderInterface {
   }
 
   /**
-   * Gets the transaction receipt from a tx hash or tx id.
+   * Gets the transaction receipt from a tx hash.
    *
-   * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L104-L111)
+   * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/167b28bcd940fd25ea3816204fa882a0b0a49603/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L183)
    *
    * @param txHash
    * @returns the transaction receipt object
    */
-
   public async getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse> {
     const txHashHex = toHex(toBN(txHash));
     return this.fetchEndpoint('get_transaction_receipt', { transactionHash: txHashHex });

package/src/provider/interface.ts

@@ -109,6 +109,14 @@ export abstract class ProviderInterface {
    */
   public abstract getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
 
+  /**
+   * Gets the transaction receipt from a tx hash.
+   *
+   * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/167b28bcd940fd25ea3816204fa882a0b0a49603/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L183)
+   *
+   * @param txHash
+   * @returns the transaction receipt object
+   */
   public abstract getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse>;
 
   /**

package/src/types/account.ts

@@ -1,7 +1,14 @@
 import BN from 'bn.js';
 
+import { BlockIdentifier } from '../provider/utils';
+import { BigNumberish } from '../utils/number';
 import { EstimateFeeResponse } from './api';
 
 export interface EstimateFee extends EstimateFeeResponse {
   suggestedMaxFee: BN;
 }
+
+export interface EstimateFeeDetails {
+  nonce?: BigNumberish;
+  blockIdentifier?: BlockIdentifier;
+}

package/src/types/index.ts

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

package/types/account.d.ts

@@ -1,6 +1,12 @@
 import BN from 'bn.js';
 
+import { BlockIdentifier } from '../provider/utils';
+import { BigNumberish } from '../utils/number';
 import { EstimateFeeResponse } from './api';
 export interface EstimateFee extends EstimateFeeResponse {
   suggestedMaxFee: BN;
 }
+export interface EstimateFeeDetails {
+  nonce?: BigNumberish;
+  blockIdentifier?: BlockIdentifier;
+}

package/types/index.d.ts

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

package/types/index.js

@@ -31,3 +31,4 @@ __exportStar(require('./lib'), exports);
 __exportStar(require('./api'), exports);
 __exportStar(require('./signer'), exports);
 __exportStar(require('./contract'), exports);
+__exportStar(require('./account'), exports);

package/www/docs/API/provider.md

@@ -131,11 +131,11 @@ Gets the status of a transaction.
 
 <hr/>
 
-provider.**getTransactionReceipt**(txHash, txId) => _Promise < TransactionReceipt >_
+provider.**getTransactionReceipt**(txHash) => _Promise < TransactionReceiptResponse >_
 
 Gets the status of a transaction.
 
-###### _TransactionReceipt_
+###### _TransactionReceiptResponse_
 
 ```
 {