starknet 3.18.1 → 4.0.0

package/types/contract.d.ts

@@ -1,5 +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;
+    [key: string]: any;
 }

package/types/contract.js

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

package/types/index.d.ts

@@ -1,5 +1,7 @@
 export * from './lib';
-export * from './api';
+export * as api from './api';
+export { Calldata, Overrides, RawArgs } from './api';
 export * from './signer';
 export * from './contract';
 export * from './account';
+export * from './provider';

package/types/index.js

@@ -1,34 +1,35 @@
-'use strict';
-var __createBinding =
-  (this && this.__createBinding) ||
-  (Object.create
-    ? function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        var desc = Object.getOwnPropertyDescriptor(m, k);
-        if (!desc || ('get' in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-          desc = {
-            enumerable: true,
-            get: function () {
-              return m[k];
-            },
-          };
-        }
-        Object.defineProperty(o, k2, desc);
-      }
-    : function (o, m, k, k2) {
-        if (k2 === undefined) k2 = k;
-        o[k2] = m[k];
-      });
-var __exportStar =
-  (this && this.__exportStar) ||
-  function (m, exports) {
-    for (var p in m)
-      if (p !== 'default' && !Object.prototype.hasOwnProperty.call(exports, p))
-        __createBinding(exports, m, p);
-  };
-Object.defineProperty(exports, '__esModule', { value: true });
-__exportStar(require('./lib'), exports);
-__exportStar(require('./api'), exports);
-__exportStar(require('./signer'), exports);
-__exportStar(require('./contract'), exports);
-__exportStar(require('./account'), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.api = void 0;
+__exportStar(require("./lib"), exports);
+exports.api = __importStar(require("./api"));
+__exportStar(require("./signer"), exports);
+__exportStar(require("./contract"), exports);
+__exportStar(require("./account"), exports);
+__exportStar(require("./provider"), exports);

package/types/lib.d.ts

@@ -1,78 +1,73 @@
 import type { ec as EC } from 'elliptic';
-
 import type { BigNumberish } from '../utils/number';
 export declare type KeyPair = EC.KeyPair;
 export declare type Signature = string[];
 export declare type RawCalldata = BigNumberish[];
 export declare type DeployContractPayload = {
-  contract: CompiledContract | string;
-  constructorCalldata?: RawCalldata;
-  addressSalt?: BigNumberish;
+    contract: CompiledContract | string;
+    constructorCalldata?: RawCalldata;
+    addressSalt?: BigNumberish;
 };
 export declare type DeclareContractPayload = {
-  contract: CompiledContract | string;
+    contract: CompiledContract | string;
+    version?: BigNumberish;
 };
 export declare type Invocation = {
-  contractAddress: string;
-  entrypoint: string;
-  calldata?: RawCalldata;
-  signature?: Signature;
+    contractAddress: string;
+    entrypoint: string;
+    calldata?: RawCalldata;
+    signature?: Signature;
 };
 export declare type Call = Omit<Invocation, 'signature'>;
 export declare type InvocationsDetails = {
-  nonce?: BigNumberish;
-  maxFee?: BigNumberish;
-  version?: BigNumberish;
+    nonce?: BigNumberish;
+    maxFee?: BigNumberish;
+    version?: BigNumberish;
 };
-export declare type Status =
-  | 'NOT_RECEIVED'
-  | 'RECEIVED'
-  | 'PENDING'
-  | 'ACCEPTED_ON_L2'
-  | 'ACCEPTED_ON_L1'
-  | 'REJECTED';
+export declare type Status = 'NOT_RECEIVED' | 'RECEIVED' | 'PENDING' | 'ACCEPTED_ON_L2' | 'ACCEPTED_ON_L1' | 'REJECTED';
 export declare type TransactionStatus = 'TRANSACTION_RECEIVED';
 export declare type Type = 'DECLARE' | 'DEPLOY' | 'INVOKE_FUNCTION';
 export declare type EntryPointType = 'EXTERNAL';
 export declare type CompressedProgram = string;
 export declare type AbiEntry = {
-  name: string;
-  type: 'felt' | 'felt*' | string;
+    name: string;
+    type: 'felt' | 'felt*' | string;
 };
 export declare type FunctionAbi = {
-  inputs: AbiEntry[];
-  name: string;
-  outputs: AbiEntry[];
-  stateMutability?: 'view';
-  type: 'function' | 'constructor';
+    inputs: AbiEntry[];
+    name: string;
+    outputs: AbiEntry[];
+    stateMutability?: 'view';
+    type: 'function' | 'constructor';
 };
 export declare type StructAbi = {
-  members: (AbiEntry & {
-    offset: number;
-  })[];
-  name: string;
-  size: number;
-  type: 'struct';
+    members: (AbiEntry & {
+        offset: number;
+    })[];
+    name: string;
+    size: number;
+    type: 'struct';
 };
 export declare type Abi = Array<FunctionAbi | StructAbi>;
 export declare type EntryPointsByType = object;
 export declare type Program = Record<any, any>;
-export declare type BlockNumber = 'pending' | 'latest' | null | number;
+export declare type BlockTag = 'pending' | 'latest';
+export declare type BlockNumber = BlockTag | null | number;
 export declare type CompiledContract = {
-  abi: Abi;
-  entry_points_by_type: EntryPointsByType;
-  program: Program;
+    abi: Abi;
+    entry_points_by_type: EntryPointsByType;
+    program: Program;
 };
 export declare type CompressedCompiledContract = Omit<CompiledContract, 'program'> & {
-  program: CompressedProgram;
+    program: CompressedProgram;
 };
 export declare type Struct = {
-  type: 'struct';
-  [k: string]: BigNumberish;
+    type: 'struct';
+    [k: string]: BigNumberish;
 };
 export declare type Args = {
-  [inputName: string]: BigNumberish | BigNumberish[] | ParsedStruct | ParsedStruct[];
+    [inputName: string]: BigNumberish | BigNumberish[] | ParsedStruct | ParsedStruct[];
 };
 export declare type ParsedStruct = {
-  [key: string]: BigNumberish | ParsedStruct;
+    [key: string]: BigNumberish | ParsedStruct;
 };

package/types/lib.js

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

package/types/provider.d.ts

@@ -0,0 +1,86 @@
+import BN from 'bn.js';
+import { Abi, CompressedProgram, EntryPointsByType, RawCalldata, Signature, Status } from './lib';
+export interface GetBlockResponse {
+    accepted_time: number;
+    block_hash: string;
+    block_number: number;
+    gas_price: string;
+    new_root: string;
+    old_root?: string;
+    parent_hash: string;
+    sequencer: string;
+    status: Status;
+    transactions: Array<string>;
+    starknet_version?: string;
+}
+export declare type GetTransactionResponse = InvokeTransactionResponse & DeclareTransactionResponse;
+export interface CommonTransactionResponse {
+    transaction_hash?: string;
+    version?: string;
+    signature?: Signature;
+    max_fee?: string;
+    nonce?: string;
+}
+export interface InvokeTransactionResponse extends CommonTransactionResponse {
+    contract_address?: string;
+    entry_point_selector?: string;
+    calldata: RawCalldata;
+}
+export interface ContractEntryPoint {
+    offset: string;
+    selector: string;
+}
+export interface ContractClass {
+    program: CompressedProgram;
+    entry_points_by_type: EntryPointsByType;
+    abi?: Abi;
+}
+export interface DeclareTransactionResponse extends CommonTransactionResponse {
+    contract_class?: any;
+    sender_address?: string;
+}
+export declare type GetTransactionReceiptResponse = InvokeTransactionReceiptResponse | DeclareTransactionReceiptResponse;
+export interface CommonTransactionReceiptResponse {
+    transaction_hash: string;
+    status: Status;
+    actual_fee?: string;
+    status_data?: string;
+}
+export interface MessageToL1 {
+    to_address: string;
+    payload: Array<string>;
+}
+export interface Event {
+    from_address: string;
+    keys: Array<string>;
+    data: Array<string>;
+}
+export interface MessageToL2 {
+    from_address: string;
+    payload: Array<string>;
+}
+export interface InvokeTransactionReceiptResponse extends CommonTransactionReceiptResponse {
+    messages_sent: Array<MessageToL1>;
+    events: Array<Event>;
+    l1_origin_message?: MessageToL2;
+}
+export declare type DeclareTransactionReceiptResponse = CommonTransactionReceiptResponse;
+export interface EstimateFeeResponse {
+    overall_fee: BN;
+    gas_consumed?: BN;
+    gas_price?: BN;
+}
+export interface InvokeFunctionResponse {
+    transaction_hash: string;
+}
+export interface DeployContractResponse {
+    contract_address: string;
+    transaction_hash: string;
+}
+export interface DeclareContractResponse {
+    transaction_hash: string;
+    class_hash: string;
+}
+export declare type CallContractResponse = {
+    result: Array<string>;
+};

package/types/provider.js

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

package/types/signer.d.ts

@@ -1,6 +1,6 @@
 import { StarknetChainId } from '../constants';
 import { InvocationsDetails } from './lib';
 export interface InvocationsSignerDetails extends Required<InvocationsDetails> {
-  walletAddress: string;
-  chainId: StarknetChainId;
+    walletAddress: string;
+    chainId: StarknetChainId;
 }

package/types/signer.js

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

package/utils/address.js

@@ -1,52 +1,41 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.validateChecksumAddress =
-  exports.getChecksumAddress =
-  exports.validateAndParseAddress =
-  exports.addAddressPadding =
-    void 0;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateChecksumAddress = exports.getChecksumAddress = exports.validateAndParseAddress = exports.addAddressPadding = void 0;
 /* eslint-disable no-bitwise */
-var bytes_1 = require('@ethersproject/bytes');
-var constants_1 = require('../constants');
-var encode_1 = require('./encode');
-var hash_1 = require('./hash');
-var number_1 = require('./number');
+var bytes_1 = require("@ethersproject/bytes");
+var constants_1 = require("../constants");
+var encode_1 = require("./encode");
+var hash_1 = require("./hash");
+var number_1 = require("./number");
 function addAddressPadding(address) {
-  return (0, encode_1.addHexPrefix)(
-    (0, encode_1.removeHexPrefix)((0, number_1.toHex)((0, number_1.toBN)(address))).padStart(
-      64,
-      '0'
-    )
-  );
+    return (0, encode_1.addHexPrefix)((0, encode_1.removeHexPrefix)((0, number_1.toHex)((0, number_1.toBN)(address))).padStart(64, '0'));
 }
 exports.addAddressPadding = addAddressPadding;
 function validateAndParseAddress(address) {
-  (0, number_1.assertInRange)(address, constants_1.ZERO, constants_1.MASK_251, 'Starknet Address');
-  var result = addAddressPadding(address);
-  if (!result.match(/^(0x)?[0-9a-fA-F]{64}$/)) {
-    throw new Error('Invalid Address Format');
-  }
-  return result;
+    (0, number_1.assertInRange)(address, constants_1.ZERO, constants_1.MASK_251, 'Starknet Address');
+    var result = addAddressPadding(address);
+    if (!result.match(/^(0x)?[0-9a-fA-F]{64}$/)) {
+        throw new Error('Invalid Address Format');
+    }
+    return result;
 }
 exports.validateAndParseAddress = validateAndParseAddress;
 // from https://github.com/ethers-io/ethers.js/blob/fc1e006575d59792fa97b4efb9ea2f8cca1944cf/packages/address/src.ts/index.ts#L12
 function getChecksumAddress(address) {
-  var chars = (0, encode_1.removeHexPrefix)(validateAndParseAddress(address))
-    .toLowerCase()
-    .split('');
-  var hashed = (0, bytes_1.arrayify)((0, hash_1.pedersen)([0, address]), { hexPad: 'left' }); // as the hash will be 251 bits (63 chars) we need to pad it to 64 chars without changing the number value ("left")
-  for (var i = 0; i < chars.length; i += 2) {
-    if (hashed[i >> 1] >> 4 >= 8) {
-      chars[i] = chars[i].toUpperCase();
-    }
-    if ((hashed[i >> 1] & 0x0f) >= 8) {
-      chars[i + 1] = chars[i + 1].toUpperCase();
+    var chars = (0, encode_1.removeHexPrefix)(validateAndParseAddress(address)).toLowerCase().split('');
+    var hashed = (0, bytes_1.arrayify)((0, hash_1.pedersen)([0, address]), { hexPad: 'left' }); // as the hash will be 251 bits (63 chars) we need to pad it to 64 chars without changing the number value ("left")
+    for (var i = 0; i < chars.length; i += 2) {
+        if (hashed[i >> 1] >> 4 >= 8) {
+            chars[i] = chars[i].toUpperCase();
+        }
+        if ((hashed[i >> 1] & 0x0f) >= 8) {
+            chars[i + 1] = chars[i + 1].toUpperCase();
+        }
     }
-  }
-  return (0, encode_1.addHexPrefix)(chars.join(''));
+    return (0, encode_1.addHexPrefix)(chars.join(''));
 }
 exports.getChecksumAddress = getChecksumAddress;
 function validateChecksumAddress(address) {
-  return getChecksumAddress(address) === address;
+    return getChecksumAddress(address) === address;
 }
 exports.validateChecksumAddress = validateChecksumAddress;

package/utils/ellipticCurve.d.ts

@@ -1,5 +1,4 @@
 import { ec as EC } from 'elliptic';
-
 import { KeyPair, Signature } from '../types';
 import { BigNumberish } from './number';
 export declare const ec: EC;
@@ -14,8 +13,4 @@ export declare function getStarkKey(keyPair: KeyPair): string;
  */
 export declare function getKeyPairFromPublicKey(publicKey: BigNumberish): KeyPair;
 export declare function sign(keyPair: KeyPair, msgHash: string): Signature;
-export declare function verify(
-  keyPair: KeyPair | KeyPair[],
-  msgHash: string,
-  sig: Signature
-): boolean;
+export declare function verify(keyPair: KeyPair | KeyPair[], msgHash: string, sig: Signature): boolean;