starknet 4.12.0 → 4.13.0

package/types/api/sequencer.d.ts

@@ -1,320 +0,0 @@
-import BN from 'bn.js';
-import { BlockIdentifier } from '../../provider/utils';
-import { BigNumberish } from '../../utils/number';
-import { Abi, BlockNumber, ContractClass, EntryPointType, RawCalldata, Signature, Status, TransactionStatus } from '../lib';
-export declare type GetTransactionStatusResponse = {
-    tx_status: Status;
-    block_hash?: string;
-    tx_failure_reason?: {
-        code: string;
-        error_message: string;
-    };
-};
-export declare type GetContractAddressesResponse = {
-    Starknet: string;
-    GpsStatementVerifier: string;
-};
-export declare type FunctionInvocation = {
-    caller_address: string;
-    contract_address: string;
-    calldata: RawCalldata;
-    call_type?: string;
-    class_hash?: string;
-    selector?: string;
-    entry_point_type?: EntryPointType;
-    result: Array<any>;
-    execution_resources: ExecutionResources;
-    internal_calls: Array<FunctionInvocation>;
-    events: Array<any>;
-    messages: Array<any>;
-};
-export declare type ExecutionResources = {
-    n_steps: number;
-    builtin_instance_counter: {
-        pedersen_builtin: number;
-        range_check_builtin: number;
-        bitwise_builtin: number;
-        output_builtin: number;
-        ecdsa_builtin: number;
-        ec_op_builtin?: number;
-    };
-    n_memory_holes: number;
-};
-export declare type GetTransactionTraceResponse = {
-    validate_invocation?: FunctionInvocation;
-    function_invocation?: FunctionInvocation;
-    fee_transfer_invocation?: FunctionInvocation;
-    signature: Signature;
-};
-export declare type RawArgs = {
-    [inputName: string]: string | string[] | {
-        type: 'struct';
-        [k: string]: BigNumberish;
-    };
-};
-export declare type CallL1Handler = {
-    from_address: string;
-    to_address: string;
-    entry_point_selector: string;
-    payload: Array<string>;
-};
-export declare namespace Sequencer {
-    type DeclareTransaction = {
-        type: 'DECLARE';
-        sender_address: string;
-        contract_class: ContractClass;
-        signature?: Signature;
-        nonce: BigNumberish;
-        max_fee?: BigNumberish;
-        version?: BigNumberish;
-    };
-    type DeployTransaction = {
-        type: 'DEPLOY';
-        contract_definition: ContractClass;
-        contract_address_salt: BigNumberish;
-        constructor_calldata: string[];
-        nonce?: BigNumberish;
-    };
-    type DeployAccountTransaction = {
-        type: 'DEPLOY_ACCOUNT';
-        class_hash: string;
-        contract_address_salt: BigNumberish;
-        constructor_calldata: string[];
-        signature?: Signature;
-        max_fee?: BigNumberish;
-        version?: BigNumberish;
-        nonce?: BigNumberish;
-    };
-    type InvokeFunctionTransaction = {
-        type: 'INVOKE_FUNCTION';
-        contract_address: string;
-        signature?: Signature;
-        entry_point_type?: EntryPointType;
-        calldata?: RawCalldata;
-        nonce: BigNumberish;
-        max_fee?: BigNumberish;
-        version?: BigNumberish;
-    };
-    type Transaction = DeclareTransaction | DeployTransaction | InvokeFunctionTransaction | DeployAccountTransaction;
-    type AddTransactionResponse = {
-        transaction_hash: string;
-        code?: TransactionStatus;
-        address?: string;
-        class_hash?: string;
-    };
-    type GetCodeResponse = {
-        bytecode: string[];
-        abi: Abi;
-    };
-    interface InvokeFunctionTransactionResponse extends InvokeFunctionTransaction {
-        transaction_hash: string;
-        entry_point_selector: string;
-    }
-    type TransactionResponse = DeclareTransaction | DeployTransaction | InvokeFunctionTransactionResponse;
-    type SuccessfulTransactionResponse = {
-        status: Status;
-        transaction: TransactionResponse;
-        block_hash: string;
-        block_number: BlockNumber;
-        transaction_index: number;
-    };
-    type FailedTransactionResponse = {
-        status: 'REJECTED';
-        transaction_failure_reason: {
-            code: string;
-            error_message: string;
-        };
-        transaction: TransactionResponse;
-    };
-    type GetTransactionResponse = SuccessfulTransactionResponse | FailedTransactionResponse;
-    type TransactionReceiptResponse = SuccessfulTransactionReceiptResponse | FailedTransactionReceiptResponse;
-    type SuccessfulTransactionReceiptResponse = {
-        status: Status;
-        transaction_hash: string;
-        transaction_index: number;
-        block_hash: string;
-        block_number: BlockNumber;
-        l2_to_l1_messages: string[];
-        events: string[];
-        actual_fee: string;
-        execution_resources: ExecutionResources;
-    };
-    type FailedTransactionReceiptResponse = {
-        status: 'REJECTED';
-        transaction_failure_reason: {
-            code: string;
-            error_message: string;
-        };
-        transaction_hash: string;
-        l2_to_l1_messages: string[];
-        events: string[];
-    };
-    type GetBlockResponse = {
-        block_number: number;
-        state_root: string;
-        block_hash: string;
-        transactions: {
-            [txHash: string]: TransactionResponse;
-        };
-        timestamp: number;
-        transaction_receipts: {
-            [txHash: string]: {
-                block_hash: string;
-                transaction_hash: string;
-                l2_to_l1_messages: {
-                    to_address: string;
-                    payload: string[];
-                    from_address: string;
-                }[];
-                block_number: BlockNumber;
-                status: Status;
-                transaction_index: number;
-            };
-        };
-        parent_block_hash: string;
-        status: Status;
-        gas_price: string;
-        sequencer_address: string;
-        starknet_version: string;
-    };
-    type CallContractTransaction = Omit<InvokeFunctionTransaction, 'type' | 'entry_point_type' | 'nonce'> & {
-        entry_point_selector: string;
-    };
-    type CallContractResponse = {
-        result: string[];
-    };
-    type InvokeEstimateFee = Omit<InvokeFunctionTransaction, 'max_fee' | 'entry_point_type'>;
-    type DeclareEstimateFee = Omit<DeclareTransaction, 'max_fee'>;
-    type DeployAccountEstimateFee = Omit<DeployAccountTransaction, 'max_fee'>;
-    type DeployEstimateFee = DeployTransaction;
-    type EstimateFeeRequest = InvokeEstimateFee | DeclareEstimateFee | DeployEstimateFee | DeployAccountEstimateFee;
-    type EstimateFeeResponse = {
-        overall_fee: number;
-        gas_price: number;
-        gas_usage: number;
-    } | {
-        amount: BN;
-        unit: string;
-    };
-    type Endpoints = {
-        get_contract_addresses: {
-            QUERY: never;
-            REQUEST: never;
-            RESPONSE: GetContractAddressesResponse;
-        };
-        add_transaction: {
-            QUERY: never;
-            REQUEST: Transaction;
-            RESPONSE: AddTransactionResponse;
-        };
-        get_transaction: {
-            QUERY: {
-                transactionHash: string;
-            };
-            REQUEST: never;
-            RESPONSE: GetTransactionResponse;
-        };
-        get_transaction_status: {
-            QUERY: {
-                transactionHash: string;
-            };
-            REQUEST: never;
-            RESPONSE: GetTransactionStatusResponse;
-        };
-        get_transaction_trace: {
-            QUERY: {
-                transactionHash: string;
-            };
-            REQUEST: never;
-            RESPONSE: GetTransactionTraceResponse;
-        };
-        get_transaction_receipt: {
-            QUERY: {
-                transactionHash: string;
-            };
-            REQUEST: never;
-            RESPONSE: TransactionReceiptResponse;
-        };
-        get_nonce: {
-            QUERY: {
-                contractAddress: string;
-                blockIdentifier: BlockIdentifier;
-            };
-            REQUEST: never;
-            RESPONSE: BigNumberish;
-        };
-        get_storage_at: {
-            QUERY: {
-                contractAddress: string;
-                key: BigNumberish;
-                blockIdentifier: BlockIdentifier;
-            };
-            REQUEST: never;
-            RESPONSE: string;
-        };
-        get_code: {
-            QUERY: {
-                contractAddress: string;
-                blockIdentifier: BlockIdentifier;
-            };
-            REQUEST: never;
-            RESPONSE: GetCodeResponse;
-        };
-        get_block: {
-            QUERY: {
-                blockIdentifier: BlockIdentifier;
-            };
-            REQUEST: never;
-            RESPONSE: GetBlockResponse;
-        };
-        call_contract: {
-            QUERY: {
-                blockIdentifier: BlockIdentifier;
-            };
-            REQUEST: CallContractTransaction;
-            RESPONSE: CallContractResponse;
-        };
-        estimate_fee: {
-            QUERY: {
-                blockIdentifier: BlockIdentifier;
-            };
-            REQUEST: EstimateFeeRequest;
-            RESPONSE: EstimateFeeResponse;
-        };
-        get_class_by_hash: {
-            QUERY: {
-                classHash: string;
-            };
-            REQUEST: never;
-            RESPONSE: any;
-        };
-        get_class_hash_at: {
-            QUERY: {
-                contractAddress: string;
-                blockIdentifier?: BlockIdentifier;
-            };
-            REQUEST: never;
-            RESPONSE: string;
-        };
-        get_state_update: {
-            QUERY: {
-                blockHash: string;
-            };
-            REQUEST: never;
-            RESPONSE: any;
-        };
-        get_full_contract: {
-            QUERY: {
-                contractAddress: string;
-                blockIdentifier?: BlockIdentifier;
-            };
-            REQUEST: never;
-            RESPONSE: any;
-        };
-        estimate_message_fee: {
-            QUERY: any;
-            REQUEST: any;
-            RESPONSE: EstimateFeeResponse;
-        };
-    };
-}

package/types/api/sequencer.js

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

package/types/contract.d.ts

@@ -1,5 +0,0 @@
-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;
-}

package/types/contract.js

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

package/types/index.d.ts

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

package/types/index.js

@@ -1,35 +0,0 @@
-"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,120 +0,0 @@
-import type { ec as EC } from 'elliptic';
-import type { BigNumberish } from '../utils/number';
-import { RPC } from './api/rpc';
-export declare type KeyPair = EC.KeyPair;
-export declare type Signature = string[];
-export declare type RawCalldata = BigNumberish[];
-export declare type AllowArray<T> = T | T[];
-export declare type RawArgs = {
-    [inputName: string]: string | string[] | {
-        type: 'struct';
-        [k: string]: BigNumberish;
-    };
-} | string[];
-export interface ContractClass {
-    program: CompressedProgram;
-    entry_points_by_type: RPC.ContractClass['entry_points_by_type'];
-    abi?: Abi;
-}
-export declare type UniversalDeployerContractPayload = {
-    classHash: BigNumberish;
-    salt: string;
-    unique: boolean;
-    constructorCalldata?: RawArgs;
-    isDevnet?: boolean;
-};
-export declare type DeployContractPayload = {
-    contract: CompiledContract | string;
-    constructorCalldata?: RawCalldata;
-    addressSalt?: string;
-};
-export declare type DeployAccountContractPayload = {
-    classHash: BigNumberish;
-    constructorCalldata?: RawCalldata;
-    addressSalt?: BigNumberish;
-    contractAddress?: string;
-};
-export declare type DeployAccountContractTransaction = Omit<DeployAccountContractPayload, 'contractAddress'> & {
-    signature?: Signature;
-};
-export declare type DeclareContractPayload = {
-    contract: CompiledContract | string;
-    classHash: BigNumberish;
-};
-export declare type DeclareContractTransaction = {
-    contractDefinition: ContractClass;
-    senderAddress: string;
-    signature?: Signature;
-};
-export declare type CallDetails = {
-    contractAddress: string;
-    calldata?: RawCalldata;
-};
-export declare type Invocation = CallDetails & {
-    signature?: Signature;
-};
-export declare type Call = CallDetails & {
-    entrypoint: string;
-};
-export declare type InvocationsDetails = {
-    nonce?: BigNumberish;
-    maxFee?: BigNumberish;
-    version?: BigNumberish;
-};
-export declare type InvocationsDetailsWithNonce = InvocationsDetails & {
-    nonce: BigNumberish;
-};
-export declare type Status = 'NOT_RECEIVED' | 'RECEIVED' | 'PENDING' | 'ACCEPTED_ON_L2' | 'ACCEPTED_ON_L1' | 'REJECTED';
-export declare type TransactionStatus = 'TRANSACTION_RECEIVED';
-export declare type TransactionType = 'DECLARE' | 'DEPLOY' | 'INVOKE_FUNCTION' | 'DEPLOY_ACCOUNT';
-export declare type EntryPointType = 'EXTERNAL';
-export declare type CompressedProgram = string;
-export declare type AbiEntry = {
-    name: string;
-    type: 'felt' | 'felt*' | string;
-};
-export declare type FunctionAbi = {
-    inputs: AbiEntry[];
-    name: string;
-    outputs: AbiEntry[];
-    stateMutability?: 'view';
-    type: FunctionAbiType;
-};
-declare enum FunctionAbiType {
-    'function' = 0,
-    'l1_handler' = 1,
-    'constructor' = 2
-}
-export declare type StructAbi = {
-    members: (AbiEntry & {
-        offset: number;
-    })[];
-    name: string;
-    size: number;
-    type: 'struct';
-};
-export declare type Abi = Array<FunctionAbi | EventAbi | StructAbi>;
-declare type EventAbi = any;
-export declare type EntryPointsByType = object;
-export declare type Program = Record<any, any>;
-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;
-};
-export declare type CompressedCompiledContract = Omit<CompiledContract, 'program'> & {
-    program: CompressedProgram;
-};
-export declare type Struct = {
-    type: 'struct';
-    [k: string]: BigNumberish;
-};
-export declare type Args = {
-    [inputName: string]: BigNumberish | BigNumberish[] | ParsedStruct | ParsedStruct[];
-};
-export declare type ParsedStruct = {
-    [key: string]: BigNumberish | ParsedStruct;
-};
-export {};

package/types/lib.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var FunctionAbiType;
-(function (FunctionAbiType) {
-    FunctionAbiType[FunctionAbiType["function"] = 0] = "function";
-    FunctionAbiType[FunctionAbiType["l1_handler"] = 1] = "l1_handler";
-    FunctionAbiType[FunctionAbiType["constructor"] = 2] = "constructor";
-})(FunctionAbiType || (FunctionAbiType = {}));

package/types/provider.d.ts

@@ -1,99 +0,0 @@
-/**
- * Common interface response
- * Intersection (sequencer response ∩ (∪ rpc responses))
- */
-import BN from 'bn.js';
-import { AllowArray, Call, DeclareContractPayload, DeployAccountContractPayload, RawCalldata, Signature, Status } from './lib';
-export interface GetBlockResponse {
-    timestamp: number;
-    block_hash: string;
-    block_number: number;
-    new_root: string;
-    parent_hash: string;
-    status: Status;
-    transactions: Array<string>;
-    gas_price?: string;
-    sequencer_address?: string;
-    starknet_version?: string;
-    transaction_receipts?: any;
-}
-export interface GetCodeResponse {
-    bytecode: 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 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 {
-    /** @deprecated Use l2_to_l1_messages */
-    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>;
-};
-export declare type EstimateFeeAction = {
-    type: 'INVOKE';
-    payload: AllowArray<Call>;
-} | {
-    type: 'DECLARE';
-    payload: DeclareContractPayload;
-} | {
-    type: 'DEPLOY_ACCOUNT';
-    payload: DeployAccountContractPayload;
-};

package/types/provider.js

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

package/types/signer.d.ts

@@ -1,19 +0,0 @@
-import { StarknetChainId } from '../constants';
-import { BigNumberish } from '../utils/number';
-import { DeployAccountContractPayload, InvocationsDetails } from './lib';
-export interface InvocationsSignerDetails extends Required<InvocationsDetails> {
-    walletAddress: string;
-    chainId: StarknetChainId;
-}
-export interface DeclareSignerDetails {
-    classHash: BigNumberish;
-    senderAddress: BigNumberish;
-    chainId: StarknetChainId;
-    maxFee: BigNumberish;
-    version: BigNumberish;
-    nonce: BigNumberish;
-}
-export declare type DeployAccountSignerDetails = Required<DeployAccountContractPayload> & Required<InvocationsDetails> & {
-    contractAddress: BigNumberish;
-    chainId: StarknetChainId;
-};

package/types/signer.js

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

package/utils/address.d.ts

@@ -1,5 +0,0 @@
-import { BigNumberish } from './number';
-export declare function addAddressPadding(address: BigNumberish): string;
-export declare function validateAndParseAddress(address: BigNumberish): string;
-export declare function getChecksumAddress(address: BigNumberish): string;
-export declare function validateChecksumAddress(address: string): boolean;

package/utils/address.js

@@ -1,41 +0,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");
-function addAddressPadding(address) {
-    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;
-}
-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.keccakBn)(address), { hexPad: 'left' }); // in case the hash is 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(''));
-}
-exports.getChecksumAddress = getChecksumAddress;
-function validateChecksumAddress(address) {
-    return getChecksumAddress(address) === address;
-}
-exports.validateChecksumAddress = validateChecksumAddress;