starknet 4.13.2 → 4.14.0

package/index.d.ts

@@ -9,6 +9,11 @@ declare function toBN(number: BigNumberish, base?: number | 'hex'): BN__default;
 declare function toHex(number: BN__default): string;
 declare function hexToDecimalString(hex: string): string;
 declare function toFelt(num: BigNumberish): string;
+/**
+ * Remove hex string leading zero and lower case '0x01A'.. -> '0x1a..'
+ * @param hex string
+ */
+declare const cleanHex: (hex: string) => string;
 declare function assertInRange(input: BigNumberish, lowerBound: BigNumberish, upperBound: BigNumberish, inputName?: string): void;
 declare function bigNumberishArrayToDecimalStringArray(rawCalldata: BigNumberish[]): string[];
 declare function bigNumberishArrayToHexadecimalStringArray(rawCalldata: BigNumberish[]): string[];
@@ -25,6 +30,7 @@ declare const number_toBN: typeof toBN;
 declare const number_toHex: typeof toHex;
 declare const number_hexToDecimalString: typeof hexToDecimalString;
 declare const number_toFelt: typeof toFelt;
+declare const number_cleanHex: typeof cleanHex;
 declare const number_assertInRange: typeof assertInRange;
 declare const number_bigNumberishArrayToDecimalStringArray: typeof bigNumberishArrayToDecimalStringArray;
 declare const number_bigNumberishArrayToHexadecimalStringArray: typeof bigNumberishArrayToHexadecimalStringArray;
@@ -42,6 +48,7 @@ declare namespace number {
     number_toHex as toHex,
     number_hexToDecimalString as hexToDecimalString,
     number_toFelt as toFelt,
+    number_cleanHex as cleanHex,
     number_assertInRange as assertInRange,
     number_bigNumberishArrayToDecimalStringArray as bigNumberishArrayToDecimalStringArray,
     number_bigNumberishArrayToHexadecimalStringArray as bigNumberishArrayToHexadecimalStringArray,
@@ -686,8 +693,8 @@ interface ContractClass {
 }
 declare type UniversalDeployerContractPayload = {
     classHash: BigNumberish;
-    salt: string;
-    unique: boolean;
+    salt?: string;
+    unique?: boolean;
     constructorCalldata?: RawArgs;
     additionalCalls?: AllowArray<Call>;
 };
@@ -709,6 +716,7 @@ declare type DeclareContractPayload = {
     contract: CompiledContract | string;
     classHash: BigNumberish;
 };
+declare type DeclareDeployContractPayload = DeclareContractPayload & UniversalDeployerContractPayload;
 declare type DeclareContractTransaction = {
     contractDefinition: ContractClass;
     senderAddress: string;
@@ -1013,10 +1021,6 @@ interface EstimateFeeResponse {
 interface InvokeFunctionResponse {
     transaction_hash: string;
 }
-interface DeployContractResponse {
-    contract_address: string;
-    transaction_hash: string;
-}
 interface DeclareContractResponse {
     transaction_hash: string;
     class_hash: string;
@@ -1045,6 +1049,23 @@ interface EstimateFeeDetails {
     nonce?: BigNumberish;
     blockIdentifier?: BlockIdentifier;
 }
+interface DeployContractResponse {
+    contract_address: string;
+    transaction_hash: string;
+}
+interface DeployContractUDCResponse extends DeployContractResponse {
+    address: string;
+    deployer: string;
+    unique: string;
+    classHash: string;
+    calldata_len: string;
+    calldata: Array<string>;
+    salt: string;
+}
+declare type DeclareDeployContractResponse = {
+    declare: DeclareTransactionReceiptResponse;
+    deploy: DeployContractUDCResponse;
+};
 
 declare type GetTransactionStatusResponse = {
     tx_status: Status;
@@ -1413,7 +1434,7 @@ declare abstract class ProviderInterface {
      * @param contractAddress - contract address
      * @returns the hex nonce
      */
-    abstract getNonce(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<BigNumberish>;
+    abstract getNonceForAddress(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<BigNumberish>;
     /**
      * Gets the contract's storage variable at a specific key.
      *
@@ -1448,7 +1469,7 @@ declare abstract class ProviderInterface {
      * - address salt
      * @returns a confirmation of sending a transaction on the starknet contract
      */
-    abstract deployContract(payload: DeployContractPayload, details?: InvocationsDetails): Promise<DeployContractResponse>;
+    abstract deployContract(payload: DeployContractPayload | any, details?: InvocationsDetails): Promise<DeployContractResponse>;
     /**
      * Deploys a given compiled Account contract (json) to starknet
      *
@@ -1554,8 +1575,9 @@ declare abstract class ProviderInterface {
      * Wait for the transaction to be accepted
      * @param txHash - transaction hash
      * @param retryInterval - retry interval
+     * @return GetTransactionReceiptResponse
      */
-    abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+    abstract waitForTransaction(txHash: BigNumberish, successStates?: Array<Status>, retryInterval?: number): Promise<GetTransactionReceiptResponse>;
 }
 
 declare type RpcProviderOptions = {
@@ -1579,7 +1601,7 @@ declare class RpcProvider implements ProviderInterface {
     getBlockWithTxHashes(blockIdentifier?: BlockIdentifier): Promise<RPC.GetBlockWithTxHashesResponse>;
     getBlockWithTxs(blockIdentifier?: BlockIdentifier): Promise<RPC.GetBlockWithTxs>;
     getClassHashAt(contractAddress: RPC.ContractAddress, blockIdentifier?: BlockIdentifier): Promise<RPC.Felt>;
-    getNonce(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<RPC.Nonce>;
+    getNonceForAddress(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<RPC.Nonce>;
     getPendingTransactions(): Promise<RPC.PendingTransactions>;
     getProtocolVersion(): Promise<Error>;
     getStateUpdate(blockIdentifier?: BlockIdentifier): Promise<RPC.StateUpdate>;
@@ -1606,7 +1628,7 @@ declare class RpcProvider implements ProviderInterface {
     callContract(call: Call, blockIdentifier?: BlockIdentifier): Promise<CallContractResponse>;
     traceTransaction(transactionHash: RPC.TransactionHash): Promise<RPC.Trace>;
     traceBlockTransactions(blockHash: RPC.BlockHash): Promise<RPC.Traces>;
-    waitForTransaction(txHash: string, retryInterval?: number): Promise<void>;
+    waitForTransaction(txHash: string, successStates?: string[], retryInterval?: number): Promise<any>;
     /**
      * Gets the transaction count from a block.
      *
@@ -1666,7 +1688,7 @@ declare class SequencerProvider implements ProviderInterface {
     getChainId(): Promise<StarknetChainId>;
     callContract({ contractAddress, entrypoint: entryPointSelector, calldata }: Call, blockIdentifier?: BlockIdentifier): Promise<CallContractResponse>;
     getBlock(blockIdentifier?: BlockIdentifier): Promise<GetBlockResponse>;
-    getNonce(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<BigNumberish>;
+    getNonceForAddress(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<BigNumberish>;
     getStorageAt(contractAddress: string, key: BigNumberish, blockIdentifier?: BlockIdentifier): Promise<BigNumberish>;
     getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
     getTransactionReceipt(txHash: BigNumberish): Promise<GetTransactionReceiptResponse>;
@@ -1685,7 +1707,7 @@ declare class SequencerProvider implements ProviderInterface {
     getDeclareEstimateFee({ senderAddress, contractDefinition, signature }: DeclareContractTransaction, details: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<EstimateFeeResponse>;
     getDeployAccountEstimateFee({ classHash, addressSalt, constructorCalldata, signature }: DeployAccountContractTransaction, details: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<EstimateFeeResponse>;
     getCode(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<Sequencer.GetCodeResponse>;
-    waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+    waitForTransaction(txHash: BigNumberish, successStates?: string[], retryInterval?: number): Promise<GetTransactionReceiptResponse>;
     /**
      * Gets the status of a transaction.
      *
@@ -1728,7 +1750,7 @@ declare class Provider implements ProviderInterface {
     getClassByHash(classHash: string): Promise<ContractClass>;
     getEstimateFee(invocationWithTxType: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<EstimateFeeResponse>;
     getInvokeEstimateFee(invocationWithTxType: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<EstimateFeeResponse>;
-    getNonce(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<BigNumberish>;
+    getNonceForAddress(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<BigNumberish>;
     getStorageAt(contractAddress: string, key: BigNumberish, blockIdentifier?: BlockIdentifier): Promise<BigNumberish>;
     getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
     getTransactionReceipt(txHash: BigNumberish): Promise<GetTransactionReceiptResponse>;
@@ -1737,13 +1759,13 @@ declare class Provider implements ProviderInterface {
     /**
      * @deprecated This method won't be supported, use Account.deploy instead
      */
-    deployContract(payload: DeployContractPayload, details: InvocationsDetails): Promise<DeployContractResponse>;
+    deployContract(payload: DeployContractPayload | any, details: InvocationsDetails): Promise<DeployContractResponse>;
     deployAccountContract(payload: DeployAccountContractTransaction, details: InvocationsDetailsWithNonce): Promise<DeployContractResponse>;
     declareContract(transaction: DeclareContractTransaction, details: InvocationsDetailsWithNonce): Promise<DeclareContractResponse>;
     getDeclareEstimateFee(transaction: DeclareContractTransaction, details: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<EstimateFeeResponse>;
     getDeployAccountEstimateFee(transaction: DeployAccountContractTransaction, details: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<EstimateFeeResponse>;
     getCode(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<GetCodeResponse>;
-    waitForTransaction(txHash: BigNumberish, retryInterval?: number): Promise<void>;
+    waitForTransaction(txHash: BigNumberish, successStates?: Array<Status>, retryInterval?: number): Promise<any>;
 }
 
 declare class GatewayError extends CustomError {
@@ -2041,7 +2063,6 @@ declare abstract class AccountInterface extends ProviderInterface {
      * @param contractPayload transaction payload to be deployed containing:
     - contract: compiled contract code
     - classHash: computed class hash of compiled contract
-    - signature
      * @param transactionsDetail Invocation Details containing:
     - optional nonce
     - optional version
@@ -2055,16 +2076,72 @@ declare abstract class AccountInterface extends ProviderInterface {
      *
      * @param deployContractPayload containing
      * - classHash: computed class hash of compiled contract
-     * - salt: address salt
-     * - unique: bool if true ensure unique salt
-     * - calldata: constructor calldata
-     * - additionalCalls - optional additional calls array to support multicall
+     * - constructorCalldata: constructor calldata
+     * - optional salt: address salt - default random
+     * - optional unique: bool if true ensure unique salt - default true
+     * - optional additionalCalls - optional additional calls array to support multi-call
      * @param transactionsDetail Invocation Details containing:
      *  - optional nonce
      *  - optional version
      *  - optional maxFee
+     * @returns Promise<InvokeFunctionResponse>
+     *  - transaction_hash
      */
     abstract deploy(deployContractPayload: UniversalDeployerContractPayload, transactionsDetail?: InvocationsDetails): Promise<InvokeFunctionResponse>;
+    /**
+     * Simplify deploy simulating old DeployContract with same response + UDC specific response
+     *
+     * @param payload UniversalDeployerContractPayload
+     *  - classHash: computed class hash of compiled contract
+     *  - constructorCalldata: constructor calldata
+     *  - optional salt: address salt - default random
+     *  - optional unique: bool if true ensure unique salt - default true
+     *  - optional additionalCalls - optional additional calls array to support multi-call
+     * @param details InvocationsDetails
+     *  - optional nonce
+     *  - optional version
+     *  - optional maxFee
+     * @returns Promise<DeployContractUDCResponse>
+     *  - contract_address
+     *  - transaction_hash
+     *  - address
+     *  - deployer
+     *  - unique
+     *  - classHash
+     *  - calldata_len
+     *  - calldata
+     *  - salt
+     */
+    abstract deployContract(payload: UniversalDeployerContractPayload, details: InvocationsDetails): Promise<DeployContractUDCResponse>;
+    /**
+     * Declares and Deploy a given compiled contract (json) to starknet using UDC
+     *
+     * @param declareDeployerContractPayload containing
+     * - contract: compiled contract code
+     * - classHash: computed class hash of compiled contract
+     * - optional constructorCalldata: constructor calldata
+     * - optional salt: address salt - default random
+     * - optional unique: bool if true ensure unique salt - default true
+     * - optional additionalCalls: - optional additional calls array to support multicall
+     * @param details
+     * - optional nonce
+     * - optional version
+     * - optional maxFee
+     * @returns Promise<DeclareDeployContractResponse>
+     * - declare
+     *    - transaction_hash
+     * - deploy
+     *    - contract_address
+     *    - transaction_hash
+     *    - address
+     *    - deployer
+     *    - unique
+     *    - classHash
+     *    - calldata_len
+     *    - calldata
+     *    - salt
+     */
+    abstract declareDeploy(declareDeployerContractPayload: DeclareDeployContractPayload, details?: InvocationsDetails): Promise<DeclareDeployContractResponse>;
     /**
      * Deploy the account on Starknet
      *
@@ -2146,7 +2223,12 @@ declare class Account extends Provider implements AccountInterface {
     estimateDeployFee({ classHash, salt, unique, constructorCalldata, additionalCalls, }: UniversalDeployerContractPayload, transactionsDetail?: InvocationsDetails | undefined): Promise<EstimateFee>;
     execute(calls: AllowArray<Call>, abis?: Abi[] | undefined, transactionsDetail?: InvocationsDetails): Promise<InvokeFunctionResponse>;
     declare({ classHash, contract }: DeclareContractPayload, transactionsDetail?: InvocationsDetails): Promise<DeclareContractResponse>;
-    deploy({ classHash, salt, unique, constructorCalldata, additionalCalls, }: UniversalDeployerContractPayload, transactionsDetail?: InvocationsDetails): Promise<InvokeFunctionResponse>;
+    deploy({ classHash, salt, unique, constructorCalldata, additionalCalls, }: UniversalDeployerContractPayload, invocationsDetails?: InvocationsDetails): Promise<InvokeFunctionResponse>;
+    deployContract(payload: UniversalDeployerContractPayload, details?: InvocationsDetails): Promise<DeployContractUDCResponse>;
+    declareDeploy({ classHash, contract, constructorCalldata }: DeclareDeployContractPayload, details?: InvocationsDetails): Promise<{
+        declare: any;
+        deploy: DeployContractUDCResponse;
+    }>;
     deployAccount({ classHash, constructorCalldata, addressSalt, contractAddress: providedContractAddress, }: DeployAccountContractPayload, transactionsDetail?: InvocationsDetails): Promise<DeployContractResponse>;
     signMessage(typedData: TypedData): Promise<Signature>;
     hashMessage(typedData: TypedData): Promise<string>;
@@ -2338,8 +2420,9 @@ declare class Contract implements ContractInterface {
 declare class ContractFactory {
     abi: Abi;
     compiledContract: CompiledContract;
-    providerOrAccount: ProviderInterface | AccountInterface;
-    constructor(compiledContract: CompiledContract, providerOrAccount?: ProviderInterface | AccountInterface, abi?: Abi);
+    classHash: string;
+    account: AccountInterface;
+    constructor(compiledContract: CompiledContract, classHash: string, account: AccountInterface, abi?: Abi);
     /**
      * Deploys contract and returns new instance of the Contract
      *
@@ -2347,13 +2430,14 @@ declare class ContractFactory {
      * @param addressSalt (optional) - Address Salt for deployment
      * @returns deployed Contract
      */
-    deploy(constructorCalldata?: RawCalldata, addressSalt?: string | undefined): Promise<Contract>;
+    deploy(constructorCalldata?: RawArgs, addressSalt?: string | undefined): Promise<Contract>;
     /**
      * Attaches to new Provider or Account
      *
-     * @param providerOrAccount - new Provider or Account to attach to
+     * @param account - new Provider or Account to attach to
+     * @returns ContractFactory
      */
-    connect(providerOrAccount: ProviderInterface | AccountInterface): ContractFactory;
+    connect(account: AccountInterface): ContractFactory;
     /**
      * Attaches current abi and provider or account to the new address
      *
@@ -2648,4 +2732,4 @@ declare function validateChecksumAddress(address: string): boolean;
 declare function isUrl(s?: string): boolean;
 declare function buildUrl(baseUrl: string, defaultPath: string, urlOrPath?: string): string;
 
-export { Abi, AbiEntry, Account, AccountInterface, AllowArray, Args, AsyncContractFunction, BlockNumber, BlockTag, Call, CallContractResponse, CallDetails, CallL1Handler, Calldata, CommonTransactionReceiptResponse, CommonTransactionResponse, CompiledContract, CompressedCompiledContract, CompressedProgram, Contract, ContractClass, ContractEntryPoint, ContractFactory, ContractFunction, ContractInterface, DeclareContractPayload, DeclareContractResponse, DeclareContractTransaction, DeclareSignerDetails, DeclareTransactionReceiptResponse, DeclareTransactionResponse, DeployAccountContractPayload, DeployAccountContractTransaction, DeployAccountSignerDetails, DeployContractPayload, DeployContractResponse, EntryPointType, EntryPointsByType, EstimateFee, EstimateFeeAction, EstimateFeeDetails, EstimateFeeResponse, Event, ExecutionResources, FunctionAbi, FunctionInvocation, GatewayError, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionReceiptResponse, GetTransactionResponse, GetTransactionStatusResponse, GetTransactionTraceResponse, HttpError, Invocation, InvocationsDetails, InvocationsDetailsWithNonce, InvocationsSignerDetails, InvokeFunctionResponse, InvokeTransactionReceiptResponse, InvokeTransactionResponse, KeyPair, MessageToL1, MessageToL2, Overrides, ParsedStruct, Program, Provider, ProviderInterface, ProviderOptions, RPC, RawArgs, RawCalldata, Result, RpcProvider, RpcProviderOptions, Sequencer, SequencerProvider, SequencerProviderOptions, Signature, Signer, SignerInterface, Status, Struct, StructAbi, TransactionStatus, TransactionType, UniversalDeployerContractPayload, addAddressPadding, buildUrl, constants, defaultProvider, ellipticCurve as ec, encode, getChecksumAddress, hash, isUrl, json, merkle, number, shortString, stark, transaction, index as typedData, uint256, validateAndParseAddress, validateChecksumAddress };
+export { Abi, AbiEntry, Account, AccountInterface, AllowArray, Args, AsyncContractFunction, BlockNumber, BlockTag, Call, CallContractResponse, CallDetails, CallL1Handler, Calldata, CommonTransactionReceiptResponse, CommonTransactionResponse, CompiledContract, CompressedCompiledContract, CompressedProgram, Contract, ContractClass, ContractEntryPoint, ContractFactory, ContractFunction, ContractInterface, DeclareContractPayload, DeclareContractResponse, DeclareContractTransaction, DeclareDeployContractPayload, DeclareDeployContractResponse, DeclareSignerDetails, DeclareTransactionReceiptResponse, DeclareTransactionResponse, DeployAccountContractPayload, DeployAccountContractTransaction, DeployAccountSignerDetails, DeployContractPayload, DeployContractResponse, DeployContractUDCResponse, EntryPointType, EntryPointsByType, EstimateFee, EstimateFeeAction, EstimateFeeDetails, EstimateFeeResponse, Event, ExecutionResources, FunctionAbi, FunctionInvocation, GatewayError, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionReceiptResponse, GetTransactionResponse, GetTransactionStatusResponse, GetTransactionTraceResponse, HttpError, Invocation, InvocationsDetails, InvocationsDetailsWithNonce, InvocationsSignerDetails, InvokeFunctionResponse, InvokeTransactionReceiptResponse, InvokeTransactionResponse, KeyPair, MessageToL1, MessageToL2, Overrides, ParsedStruct, Program, Provider, ProviderInterface, ProviderOptions, RPC, RawArgs, RawCalldata, Result, RpcProvider, RpcProviderOptions, Sequencer, SequencerProvider, SequencerProviderOptions, Signature, Signer, SignerInterface, Status, Struct, StructAbi, TransactionStatus, TransactionType, UniversalDeployerContractPayload, addAddressPadding, buildUrl, constants, defaultProvider, ellipticCurve as ec, encode, getChecksumAddress, hash, isUrl, json, merkle, number, shortString, stark, transaction, index as typedData, uint256, validateAndParseAddress, validateChecksumAddress };