starknet 2.7.2 → 3.1.0

package/dist/utils/stark.js

@@ -1,6 +1,31 @@
 "use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatSignature = exports.makeAddress = exports.randomAddress = exports.getSelectorFromName = exports.compressProgram = void 0;
+exports.compileCalldata = exports.formatSignature = exports.makeAddress = exports.randomAddress = exports.getSelectorFromName = exports.compressProgram = void 0;
 var pako_1 = require("pako");
 var ellipticCurve_1 = require("./ellipticCurve");
 var encode_1 = require("./encode");
@@ -52,3 +77,21 @@ function formatSignature(sig) {
     }
 }
 exports.formatSignature = formatSignature;
+function compileCalldata(args) {
+    return Object.values(args).flatMap(function (value) {
+        if (Array.isArray(value))
+            return __spreadArray([(0, number_1.toBN)(value.length).toString()], __read(value.map(function (x) { return (0, number_1.toBN)(x).toString(); })), false);
+        if (typeof value === 'object' && 'type' in value)
+            return Object.entries(value)
+                .filter(function (_a) {
+                var _b = __read(_a, 1), k = _b[0];
+                return k !== 'type';
+            })
+                .map(function (_a) {
+                var _b = __read(_a, 2), v = _b[1];
+                return (0, number_1.toBN)(v).toString();
+            });
+        return (0, number_1.toBN)(value).toString();
+    });
+}
+exports.compileCalldata = compileCalldata;

package/index.d.ts

@@ -4,7 +4,7 @@
 export * from './types';
 export * from './contract';
 export * from './provider';
-export * from './signer';
+export * from './account';
 /**
  * Utils
  */
@@ -18,3 +18,4 @@ export * as ec from './utils/ellipticCurve';
 export * as uint256 from './utils/uint256';
 export * as shortString from './utils/shortString';
 export * as typedData from './utils/typedData';
+export * from './utils/address';

package/index.js

@@ -61,7 +61,7 @@ exports.typedData =
 __exportStar(require('./types'), exports);
 __exportStar(require('./contract'), exports);
 __exportStar(require('./provider'), exports);
-__exportStar(require('./signer'), exports);
+__exportStar(require('./account'), exports);
 /**
  * Utils
  */
@@ -75,3 +75,4 @@ exports.ec = __importStar(require('./utils/ellipticCurve'));
 exports.uint256 = __importStar(require('./utils/uint256'));
 exports.shortString = __importStar(require('./utils/shortString'));
 exports.typedData = __importStar(require('./utils/typedData'));
+__exportStar(require('./utils/address'), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "2.7.2",
+  "version": "3.1.0",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,7 +23,7 @@
     "zk",
     "rollup"
   ],
-  "repository": "github:seanjameshan/starknet.js",
+  "repository": "github:0xs34n/starknet.js",
   "author": "Sean Han",
   "license": "MIT",
   "devDependencies": {
@@ -44,6 +44,7 @@
     "@types/url-join": "^4.0.1",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
+    "axios-logger": "^2.6.0",
     "eslint": "^7.32.0",
     "eslint-config-airbnb-base": "^14.2.1",
     "eslint-config-airbnb-typescript": "^14.0.1",
@@ -76,7 +77,12 @@
     "*.{ts,js,md,yml,json}": "prettier --write"
   },
   "jest": {
-    "testTimeout": 800000
+    "testMatch": [
+      "**/__tests__/**/(*.)+(spec|test).[jt]s?(x)"
+    ],
+    "setupFilesAfterEnv": [
+      "./__tests__/jest.setup.ts"
+    ]
   },
   "importSort": {
     ".js, .jsx, .ts, .tsx": {

package/provider/default.d.ts

@@ -1,19 +1,21 @@
 import {
+  Abi,
   AddTransactionResponse,
-  BlockNumber,
+  Call,
   CallContractResponse,
-  CallContractTransaction,
-  CompiledContract,
+  DeployContractPayload,
+  Endpoints,
   GetBlockResponse,
   GetCodeResponse,
   GetContractAddressesResponse,
   GetTransactionResponse,
   GetTransactionStatusResponse,
-  Signature,
-  Transaction,
+  Invocation,
+  TransactionReceipt,
 } from '../types';
 import { BigNumberish } from '../utils/number';
 import { ProviderInterface } from './interface';
+import { BlockIdentifier } from './utils';
 declare type NetworkName = 'mainnet-alpha' | 'goerli-alpha';
 declare type ProviderOptions =
   | {
@@ -30,6 +32,20 @@ export declare class Provider implements ProviderInterface {
   protected static getNetworkFromName(
     name: NetworkName
   ): 'https://alpha-mainnet.starknet.io' | 'https://alpha4.starknet.io';
+  private getFetchUrl;
+  private getFetchMethod;
+  private getQueryString;
+  private getHeaders;
+  protected fetchEndpoint<T extends keyof Endpoints>(
+    endpoint: T,
+    ...[query, request]: Endpoints[T]['QUERY'] extends never
+      ? Endpoints[T]['REQUEST'] extends never
+        ? []
+        : [undefined, Endpoints[T]['REQUEST']]
+      : Endpoints[T]['REQUEST'] extends never
+      ? [Endpoints[T]['QUERY']]
+      : [Endpoints[T]['QUERY'], Endpoints[T]['REQUEST']]
+  ): Promise<Endpoints[T]['RESPONSE']>;
   /**
    * Gets the smart contract address on the goerli testnet.
    *
@@ -48,9 +64,8 @@ export declare class Provider implements ProviderInterface {
    * @returns the result of the function on the smart contract.
    */
   callContract(
-    invokeTransaction: CallContractTransaction,
-    blockHash?: BigNumberish,
-    blockNumber?: BlockNumber
+    { contractAddress, entrypoint, calldata }: Call,
+    blockIdentifier?: BlockIdentifier
   ): Promise<CallContractResponse>;
   /**
    * Gets the block information
@@ -61,7 +76,7 @@ export declare class Provider implements ProviderInterface {
    * @param blockNumber
    * @returns the block object { block_number, previous_block_number, state_root, status, timestamp, transaction_receipts, transactions }
    */
-  getBlock(blockHash?: BigNumberish, blockNumber?: BlockNumber): Promise<GetBlockResponse>;
+  getBlock(blockIdentifier?: BlockIdentifier): Promise<GetBlockResponse>;
   /**
    * Gets the code of the deployed contract.
    *
@@ -72,11 +87,7 @@ export declare class Provider implements ProviderInterface {
    * @param blockNumber
    * @returns Bytecode and ABI of compiled contract
    */
-  getCode(
-    contractAddress: string,
-    blockHash?: BigNumberish,
-    blockNumber?: BlockNumber
-  ): Promise<GetCodeResponse>;
+  getCode(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<GetCodeResponse>;
   /**
    * Gets the contract's storage variable at a specific key.
    *
@@ -91,8 +102,7 @@ export declare class Provider implements ProviderInterface {
   getStorageAt(
     contractAddress: string,
     key: number,
-    blockHash?: BigNumberish,
-    blockNumber?: BlockNumber
+    blockIdentifier?: BlockIdentifier
   ): Promise<object>;
   /**
    * Gets the status of a transaction.
@@ -104,23 +114,30 @@ export declare class Provider implements ProviderInterface {
    */
   getTransactionStatus(txHash: BigNumberish): Promise<GetTransactionStatusResponse>;
   /**
-   * Gets the transaction information from a tx id.
+   * Gets the transaction receipt from a tx hash or tx id.
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L54-L58)
+   * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L104-L111)
    *
    * @param txHash
-   * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
+   * @param txId
+   * @returns the transaction receipt object
    */
-  getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
+  getTransactionReceipt({
+    txHash,
+    txId,
+  }: {
+    txHash?: BigNumberish;
+    txId?: BigNumberish;
+  }): Promise<TransactionReceipt>;
   /**
-   * Invoke a function on the starknet contract
+   * Gets the transaction information from a tx id.
    *
-   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/gateway/gateway_client.py#L13-L17)
+   * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L54-L58)
    *
-   * @param transaction - transaction to be invoked
-   * @returns a confirmation of invoking a function on the starknet contract
+   * @param txHash
+   * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
    */
-  addTransaction(transaction: Transaction): Promise<AddTransactionResponse>;
+  getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
   /**
    * Deploys a given compiled contract (json) to starknet
    *
@@ -128,13 +145,10 @@ export declare class Provider implements ProviderInterface {
    * @param address - (optional, defaults to a random address) the address where the contract should be deployed (alpha)
    * @returns a confirmation of sending a transaction on the starknet contract
    */
-  deployContract(
-    contract: CompiledContract | string,
-    constructorCalldata?: string[],
-    addressSalt?: BigNumberish
-  ): Promise<AddTransactionResponse>;
+  deployContract(payload: DeployContractPayload, _abi?: Abi): Promise<AddTransactionResponse>;
   /**
    * 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
@@ -142,12 +156,7 @@ export declare class Provider implements ProviderInterface {
    * @param signature - (optional) signature to send along
    * @returns response from addTransaction
    */
-  invokeFunction(
-    contractAddress: string,
-    entrypointSelector: string,
-    calldata?: string[],
-    signature?: Signature
-  ): Promise<AddTransactionResponse>;
+  invokeFunction(invocation: Invocation, _abi?: Abi): Promise<AddTransactionResponse>;
   waitForTx(txHash: BigNumberish, retryInterval?: number): Promise<void>;
 }
 export {};