starknet 3.10.0 → 3.10.1

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [3.10.1](https://github.com/seanjameshan/starknet.js/compare/v3.10.0...v3.10.1) (2022-04-20)
+
+### Bug Fixes
+
+- **account:** function documentation fix ([34a9779](https://github.com/seanjameshan/starknet.js/commit/34a977953c2bfea53f9cd1157809919b1dd2ed04))
+- **contractFactory:** wrong prop type ([598bcd0](https://github.com/seanjameshan/starknet.js/commit/598bcd0d589c00e2219522d4a342316598678d4e))
+- **contract:** recursion function name fix ([803b6dc](https://github.com/seanjameshan/starknet.js/commit/803b6dcf5cad5cdfd8258a53e176bcd96300cef3))
+- typings ([1fadf41](https://github.com/seanjameshan/starknet.js/commit/1fadf418b04d96ced8d994b35699f40be9a8c898))
+- **utils:** adding transaction utils to the utils export ([6429179](https://github.com/seanjameshan/starknet.js/commit/642917922a5d5278e8c575a2b4ffd60fff53cf42))
+
 # [3.10.0](https://github.com/seanjameshan/starknet.js/compare/v3.9.0...v3.10.0) (2022-04-20)
 
 ### Bug Fixes

package/account/default.d.ts

@@ -1,4 +1,4 @@
-import { Provider } from '../provider';
+import { Provider, ProviderInterface } from '../provider';
 import { BlockIdentifier } from '../provider/utils';
 import { SignerInterface } from '../signer';
 import {
@@ -16,8 +16,12 @@ import { TypedData } from '../utils/typedData';
 import { AccountInterface } from './interface';
 export declare class Account extends Provider implements AccountInterface {
   address: string;
-  private signer;
-  constructor(provider: Provider, address: string, keyPairOrSigner: KeyPair | SignerInterface);
+  signer: SignerInterface;
+  constructor(
+    provider: ProviderInterface,
+    address: string,
+    keyPairOrSigner: KeyPair | SignerInterface
+  );
   getNonce(): Promise<string>;
   estimateFee(
     calls: Call | Call[],
@@ -64,7 +68,8 @@ export declare class Account extends Provider implements AccountInterface {
    */
   hashMessage(typedData: TypedData): Promise<string>;
   /**
-   * Verify a signature of a JSON object
+   * Verify a signature of a given hash
+   * @warning This method is not recommended, use verifyMessage instead
    *
    * @param hash - JSON object to be verified
    * @param signature - signature of the JSON object
@@ -73,8 +78,7 @@ export declare class Account extends Provider implements AccountInterface {
    */
   verifyMessageHash(hash: BigNumberish, signature: Signature): Promise<boolean>;
   /**
-   * Verify a signature of a given hash
-   * @warning This method is not recommended, use verifyMessage instead
+   * Verify a signature of a JSON object
    *
    * @param hash - hash to be verified
    * @param signature - signature of the hash

package/account/default.js

@@ -510,7 +510,8 @@ var Account = /** @class */ (function (_super) {
     });
   };
   /**
-   * Verify a signature of a JSON object
+   * Verify a signature of a given hash
+   * @warning This method is not recommended, use verifyMessage instead
    *
    * @param hash - JSON object to be verified
    * @param signature - signature of the JSON object
@@ -550,8 +551,7 @@ var Account = /** @class */ (function (_super) {
     });
   };
   /**
-   * Verify a signature of a given hash
-   * @warning This method is not recommended, use verifyMessage instead
+   * Verify a signature of a JSON object
    *
    * @param hash - hash to be verified
    * @param signature - signature of the hash

package/account/interface.d.ts

@@ -1,4 +1,5 @@
 import { ProviderInterface } from '../provider';
+import { SignerInterface } from '../signer';
 import {
   Abi,
   AddTransactionResponse,
@@ -13,6 +14,7 @@ import { BigNumberish } from '../utils/number';
 import { TypedData } from '../utils/typedData/types';
 export declare abstract class AccountInterface extends ProviderInterface {
   abstract address: string;
+  abstract signer: SignerInterface;
   /**
    * Deploys a given compiled contract (json) to starknet
    *

package/contract/contractFactory.d.ts

@@ -1,15 +1,15 @@
-import { Account } from '../account';
-import { Provider } from '../provider';
+import { AccountInterface } from '../account';
+import { ProviderInterface } from '../provider';
 import { Abi, CompiledContract, RawCalldata } from '../types';
 import { BigNumberish } from '../utils/number';
 import { Contract } from './default';
 export declare class ContractFactory {
   abi: Abi;
   compiledContract: CompiledContract;
-  providerOrAccount: Provider | Account;
+  providerOrAccount: ProviderInterface | AccountInterface;
   constructor(
     compiledContract: CompiledContract,
-    providerOrAccount?: Provider | Account,
+    providerOrAccount?: ProviderInterface | AccountInterface,
     abi?: Abi
   );
   /**
@@ -25,7 +25,7 @@ export declare class ContractFactory {
    *
    * @param providerOrAccount - new Provider or Account to attach to
    */
-  connect(providerOrAccount: Provider | Account): ContractFactory;
+  connect(providerOrAccount: ProviderInterface | AccountInterface): ContractFactory;
   /**
    * Attaches current abi and provider or account to the new address
    *

package/contract/default.js

@@ -522,7 +522,7 @@ var Contract = /** @class */ (function () {
       if (member.type === 'felt') {
         return acc + 1;
       }
-      return acc + _this.structMemberNum(member.type);
+      return acc + _this.calculateStructMembers(member.type);
     }, 0);
   };
   /**

package/dist/account/default.d.ts

@@ -1,4 +1,4 @@
-import { Provider } from '../provider';
+import { Provider, ProviderInterface } from '../provider';
 import { BlockIdentifier } from '../provider/utils';
 import { SignerInterface } from '../signer';
 import { Abi, AddTransactionResponse, Call, EstimateFeeResponse, InvocationsDetails, KeyPair, Signature, Transaction } from '../types';
@@ -7,8 +7,8 @@ import { TypedData } from '../utils/typedData';
 import { AccountInterface } from './interface';
 export declare class Account extends Provider implements AccountInterface {
     address: string;
-    private signer;
-    constructor(provider: Provider, address: string, keyPairOrSigner: KeyPair | SignerInterface);
+    signer: SignerInterface;
+    constructor(provider: ProviderInterface, address: string, keyPairOrSigner: KeyPair | SignerInterface);
     getNonce(): Promise<string>;
     estimateFee(calls: Call | Call[], { nonce: providedNonce, blockIdentifier, }?: {
         nonce?: BigNumberish;
@@ -45,7 +45,8 @@ export declare class Account extends Provider implements AccountInterface {
      */
     hashMessage(typedData: TypedData): Promise<string>;
     /**
-     * Verify a signature of a JSON object
+     * Verify a signature of a given hash
+     * @warning This method is not recommended, use verifyMessage instead
      *
      * @param hash - JSON object to be verified
      * @param signature - signature of the JSON object
@@ -54,8 +55,7 @@ export declare class Account extends Provider implements AccountInterface {
      */
     verifyMessageHash(hash: BigNumberish, signature: Signature): Promise<boolean>;
     /**
-     * Verify a signature of a given hash
-     * @warning This method is not recommended, use verifyMessage instead
+     * Verify a signature of a JSON object
      *
      * @param hash - hash to be verified
      * @param signature - signature of the hash

package/dist/account/default.js

@@ -340,7 +340,8 @@ var Account = /** @class */ (function (_super) {
         });
     };
     /**
-     * Verify a signature of a JSON object
+     * Verify a signature of a given hash
+     * @warning This method is not recommended, use verifyMessage instead
      *
      * @param hash - JSON object to be verified
      * @param signature - signature of the JSON object
@@ -374,8 +375,7 @@ var Account = /** @class */ (function (_super) {
         });
     };
     /**
-     * Verify a signature of a given hash
-     * @warning This method is not recommended, use verifyMessage instead
+     * Verify a signature of a JSON object
      *
      * @param hash - hash to be verified
      * @param signature - signature of the hash

package/dist/account/interface.d.ts

@@ -1,9 +1,11 @@
 import { ProviderInterface } from '../provider';
+import { SignerInterface } from '../signer';
 import { Abi, AddTransactionResponse, Call, DeployContractPayload, EstimateFeeResponse, Invocation, InvocationsDetails, Signature } from '../types';
 import { BigNumberish } from '../utils/number';
 import { TypedData } from '../utils/typedData/types';
 export declare abstract class AccountInterface extends ProviderInterface {
     abstract address: string;
+    abstract signer: SignerInterface;
     /**
      * Deploys a given compiled contract (json) to starknet
      *

package/dist/contract/contractFactory.d.ts

@@ -1,13 +1,13 @@
-import { Account } from '../account';
-import { Provider } from '../provider';
+import { AccountInterface } from '../account';
+import { ProviderInterface } from '../provider';
 import { Abi, CompiledContract, RawCalldata } from '../types';
 import { BigNumberish } from '../utils/number';
 import { Contract } from './default';
 export declare class ContractFactory {
     abi: Abi;
     compiledContract: CompiledContract;
-    providerOrAccount: Provider | Account;
-    constructor(compiledContract: CompiledContract, providerOrAccount?: Provider | Account, abi?: Abi);
+    providerOrAccount: ProviderInterface | AccountInterface;
+    constructor(compiledContract: CompiledContract, providerOrAccount?: ProviderInterface | AccountInterface, abi?: Abi);
     /**
      * Deploys contract and returns new instance of the Contract
      *
@@ -21,7 +21,7 @@ export declare class ContractFactory {
      *
      * @param providerOrAccount - new Provider or Account to attach to
      */
-    connect(providerOrAccount: Provider | Account): ContractFactory;
+    connect(providerOrAccount: ProviderInterface | AccountInterface): ContractFactory;
     /**
      * Attaches current abi and provider or account to the new address
      *

package/dist/contract/default.js

@@ -383,7 +383,7 @@ var Contract = /** @class */ (function () {
             if (member.type === 'felt') {
                 return acc + 1;
             }
-            return acc + _this.structMemberNum(member.type);
+            return acc + _this.calculateStructMembers(member.type);
         }, 0);
     };
     /**

package/dist/index.d.ts

@@ -14,6 +14,7 @@ export * as encode from './utils/encode';
 export * as hash from './utils/hash';
 export * as json from './utils/json';
 export * as number from './utils/number';
+export * as transaction from './utils/transaction';
 export * as stark from './utils/stark';
 export * as ec from './utils/ellipticCurve';
 export * as uint256 from './utils/uint256';

package/dist/index.js

@@ -22,7 +22,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.typedData = exports.shortString = exports.uint256 = exports.ec = exports.stark = exports.number = exports.json = exports.hash = exports.encode = exports.constants = void 0;
+exports.typedData = exports.shortString = exports.uint256 = exports.ec = exports.stark = exports.transaction = exports.number = exports.json = exports.hash = exports.encode = exports.constants = void 0;
 /**
  * Main
  */
@@ -39,6 +39,7 @@ exports.encode = __importStar(require("./utils/encode"));
 exports.hash = __importStar(require("./utils/hash"));
 exports.json = __importStar(require("./utils/json"));
 exports.number = __importStar(require("./utils/number"));
+exports.transaction = __importStar(require("./utils/transaction"));
 exports.stark = __importStar(require("./utils/stark"));
 exports.ec = __importStar(require("./utils/ellipticCurve"));
 exports.uint256 = __importStar(require("./utils/uint256"));

package/dist/provider/default.d.ts

@@ -14,7 +14,7 @@ export declare class Provider implements ProviderInterface {
     feederGatewayUrl: string;
     gatewayUrl: string;
     chainId: StarknetChainId;
-    constructor(optionsOrProvider?: ProviderOptions | Provider);
+    constructor(optionsOrProvider?: ProviderOptions | ProviderInterface);
     protected static getNetworkFromName(name: NetworkName): "https://alpha-mainnet.starknet.io" | "https://alpha4.starknet.io";
     protected static getChainIdFromBaseUrl(baseUrl: string): StarknetChainId;
     private getFetchUrl;

package/dist/provider/default.js

@@ -74,6 +74,7 @@ var hash_1 = require("../utils/hash");
 var json_1 = require("../utils/json");
 var number_1 = require("../utils/number");
 var stark_1 = require("../utils/stark");
+var interface_1 = require("./interface");
 var utils_1 = require("./utils");
 function wait(delay) {
     return new Promise(function (res) { return setTimeout(res, delay); });
@@ -91,7 +92,7 @@ var Provider = /** @class */ (function () {
     function Provider(optionsOrProvider) {
         if (optionsOrProvider === void 0) { optionsOrProvider = { network: 'goerli-alpha' }; }
         var _a;
-        if (optionsOrProvider instanceof Provider) {
+        if (optionsOrProvider instanceof interface_1.ProviderInterface) {
             this.baseUrl = optionsOrProvider.baseUrl;
             this.feederGatewayUrl = optionsOrProvider.feederGatewayUrl;
             this.gatewayUrl = optionsOrProvider.gatewayUrl;

package/index.d.ts

@@ -14,6 +14,7 @@ export * as encode from './utils/encode';
 export * as hash from './utils/hash';
 export * as json from './utils/json';
 export * as number from './utils/number';
+export * as transaction from './utils/transaction';
 export * as stark from './utils/stark';
 export * as ec from './utils/ellipticCurve';
 export * as uint256 from './utils/uint256';

package/index.js

@@ -49,6 +49,7 @@ exports.typedData =
   exports.uint256 =
   exports.ec =
   exports.stark =
+  exports.transaction =
   exports.number =
   exports.json =
   exports.hash =
@@ -71,6 +72,7 @@ exports.encode = __importStar(require('./utils/encode'));
 exports.hash = __importStar(require('./utils/hash'));
 exports.json = __importStar(require('./utils/json'));
 exports.number = __importStar(require('./utils/number'));
+exports.transaction = __importStar(require('./utils/transaction'));
 exports.stark = __importStar(require('./utils/stark'));
 exports.ec = __importStar(require('./utils/ellipticCurve'));
 exports.uint256 = __importStar(require('./utils/uint256'));

package/package.json

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

package/provider/default.d.ts

@@ -31,7 +31,7 @@ export declare class Provider implements ProviderInterface {
   feederGatewayUrl: string;
   gatewayUrl: string;
   chainId: StarknetChainId;
-  constructor(optionsOrProvider?: ProviderOptions | Provider);
+  constructor(optionsOrProvider?: ProviderOptions | ProviderInterface);
   protected static getNetworkFromName(
     name: NetworkName
   ): 'https://alpha-mainnet.starknet.io' | 'https://alpha4.starknet.io';

package/provider/default.js

@@ -180,6 +180,7 @@ var hash_1 = require('../utils/hash');
 var json_1 = require('../utils/json');
 var number_1 = require('../utils/number');
 var stark_1 = require('../utils/stark');
+var interface_1 = require('./interface');
 var utils_1 = require('./utils');
 function wait(delay) {
   return new Promise(function (res) {
@@ -205,7 +206,7 @@ var Provider = /** @class */ (function () {
       optionsOrProvider = { network: 'goerli-alpha' };
     }
     var _a;
-    if (optionsOrProvider instanceof Provider) {
+    if (optionsOrProvider instanceof interface_1.ProviderInterface) {
       this.baseUrl = optionsOrProvider.baseUrl;
       this.feederGatewayUrl = optionsOrProvider.feederGatewayUrl;
       this.gatewayUrl = optionsOrProvider.gatewayUrl;

package/src/account/default.ts

@@ -1,7 +1,7 @@
 import assert from 'minimalistic-assert';
 
 import { ZERO } from '../constants';
-import { Provider } from '../provider';
+import { Provider, ProviderInterface } from '../provider';
 import { BlockIdentifier } from '../provider/utils';
 import { Signer, SignerInterface } from '../signer';
 import {
@@ -33,9 +33,13 @@ import { AccountInterface } from './interface';
 export class Account extends Provider implements AccountInterface {
   public address: string;
 
-  private signer: SignerInterface;
+  public signer: SignerInterface;
 
-  constructor(provider: Provider, address: string, keyPairOrSigner: KeyPair | SignerInterface) {
+  constructor(
+    provider: ProviderInterface,
+    address: string,
+    keyPairOrSigner: KeyPair | SignerInterface
+  ) {
     super(provider);
     this.signer =
       'getPubKey' in keyPairOrSigner ? keyPairOrSigner : new Signer(keyPairOrSigner as KeyPair);
@@ -250,7 +254,8 @@ export class Account extends Provider implements AccountInterface {
   }
 
   /**
-   * Verify a signature of a JSON object
+   * Verify a signature of a given hash
+   * @warning This method is not recommended, use verifyMessage instead
    *
    * @param hash - JSON object to be verified
    * @param signature - signature of the JSON object
@@ -274,8 +279,7 @@ export class Account extends Provider implements AccountInterface {
   }
 
   /**
-   * Verify a signature of a given hash
-   * @warning This method is not recommended, use verifyMessage instead
+   * Verify a signature of a JSON object
    *
    * @param hash - hash to be verified
    * @param signature - signature of the hash

package/src/account/interface.ts

@@ -1,4 +1,5 @@
 import { ProviderInterface } from '../provider';
+import { SignerInterface } from '../signer';
 import {
   Abi,
   AddTransactionResponse,
@@ -15,6 +16,8 @@ import { TypedData } from '../utils/typedData/types';
 export abstract class AccountInterface extends ProviderInterface {
   public abstract address: string;
 
+  public abstract signer: SignerInterface;
+
   /**
    * Deploys a given compiled contract (json) to starknet
    *

package/src/contract/contractFactory.ts

@@ -1,7 +1,7 @@
 import assert from 'minimalistic-assert';
 
-import { Account } from '../account';
-import { Provider, defaultProvider } from '../provider';
+import { AccountInterface } from '../account';
+import { ProviderInterface, defaultProvider } from '../provider';
 import { Abi, CompiledContract, RawCalldata } from '../types';
 import { BigNumberish } from '../utils/number';
 import { Contract } from './default';
@@ -11,11 +11,11 @@ export class ContractFactory {
 
   compiledContract: CompiledContract;
 
-  providerOrAccount: Provider | Account;
+  providerOrAccount: ProviderInterface | AccountInterface;
 
   constructor(
     compiledContract: CompiledContract,
-    providerOrAccount: Provider | Account = defaultProvider,
+    providerOrAccount: ProviderInterface | AccountInterface = defaultProvider,
     abi: Abi = compiledContract.abi // abi can be different from the deployed contract ie for proxy contracts
   ) {
     this.abi = abi;
@@ -59,7 +59,7 @@ export class ContractFactory {
    *
    * @param providerOrAccount - new Provider or Account to attach to
    */
-  connect(providerOrAccount: Provider | Account): ContractFactory {
+  connect(providerOrAccount: ProviderInterface | AccountInterface): ContractFactory {
     this.providerOrAccount = providerOrAccount;
     return this;
   }

package/src/contract/default.ts

@@ -349,7 +349,7 @@ export class Contract implements ContractInterface {
       if (member.type === 'felt') {
         return acc + 1;
       }
-      return acc + this.structMemberNum(member.type);
+      return acc + this.calculateStructMembers(member.type);
     }, 0);
   }
 

package/src/index.ts

@@ -15,6 +15,7 @@ export * as encode from './utils/encode';
 export * as hash from './utils/hash';
 export * as json from './utils/json';
 export * as number from './utils/number';
+export * as transaction from './utils/transaction';
 export * as stark from './utils/stark';
 export * as ec from './utils/ellipticCurve';
 export * as uint256 from './utils/uint256';

package/src/provider/default.ts

@@ -52,8 +52,10 @@ export class Provider implements ProviderInterface {
 
   public chainId: StarknetChainId;
 
-  constructor(optionsOrProvider: ProviderOptions | Provider = { network: 'goerli-alpha' }) {
-    if (optionsOrProvider instanceof Provider) {
+  constructor(
+    optionsOrProvider: ProviderOptions | ProviderInterface = { network: 'goerli-alpha' }
+  ) {
+    if (optionsOrProvider instanceof ProviderInterface) {
       this.baseUrl = optionsOrProvider.baseUrl;
       this.feederGatewayUrl = optionsOrProvider.feederGatewayUrl;
       this.gatewayUrl = optionsOrProvider.gatewayUrl;