starknet 6.9.0 → 6.10.1

package/dist/account/interface.d.ts

@@ -0,0 +1,301 @@
+import { ProviderInterface } from '../provider';
+import { SignerInterface } from '../signer';
+import { Abi, AllowArray, BigNumberish, BlockIdentifier, CairoVersion, Call, DeclareAndDeployContractPayload, DeclareContractPayload, DeclareContractResponse, DeclareDeployUDCResponse, DeployAccountContractPayload, DeployContractResponse, DeployContractUDCResponse, EstimateFee, EstimateFeeAction, EstimateFeeDetails, EstimateFeeResponse, EstimateFeeResponseBulk, Invocations, InvocationsDetails, InvokeFunctionResponse, MultiDeployContractResponse, Nonce, Signature, SimulateTransactionDetails, SimulateTransactionResponse, TypedData, UniversalDeployerContractPayload } from '../types';
+export declare abstract class AccountInterface extends ProviderInterface {
+    abstract address: string;
+    abstract signer: SignerInterface;
+    abstract cairoVersion: CairoVersion;
+    /**
+     * Estimate Fee for executing an INVOKE transaction on starknet
+     *
+     * @param calls the invocation object containing:
+     * - contractAddress - the address of the contract
+     * - entrypoint - the entrypoint of the contract
+     * - calldata? - (defaults to []) the calldata
+     *
+     * @param estimateFeeDetails -
+     * - blockIdentifier?
+     * - nonce? = 0
+     * - skipValidate? - default true
+     * - tip? - prioritize order of transactions in the mempool.
+     * - accountDeploymentData? - deploy an account contract (substitution for deploy account transaction)
+     * - paymasterData? - entity other than the transaction sender to pay the transaction fees(EIP-4337)
+     * - nonceDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition)
+     * - feeDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition)
+     * - version? - specify ETransactionVersion - V3 Transactions fee is in fri, oldV transactions fee is in wei
+     *
+     * @returns response from estimate_fee
+     */
+    abstract estimateInvokeFee(calls: AllowArray<Call>, estimateFeeDetails?: EstimateFeeDetails): Promise<EstimateFeeResponse>;
+    /**
+     * Estimate Fee for executing a DECLARE transaction on starknet
+     *
+     * @param contractPayload the payload object containing:
+     * - contract - the compiled contract to be declared
+     * - casm? - compiled cairo assembly. Cairo1(casm or compiledClassHash are required)
+     * - classHash? - the class hash of the compiled contract. Precalculate for faster execution.
+     * - compiledClassHash?: class hash of the cairo assembly. Cairo1(casm or compiledClassHash are required)
+     *
+     * @param estimateFeeDetails -
+     * - blockIdentifier?
+     * - nonce? = 0
+     * - skipValidate? - default true
+     * - tip? - prioritize order of transactions in the mempool.
+     * - accountDeploymentData? - deploy an account contract (substitution for deploy account transaction)
+     * - paymasterData? - entity other than the transaction sender to pay the transaction fees(EIP-4337)
+     * - nonceDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition)
+     * - feeDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition)
+     * - version? - specify ETransactionVersion - V3 Transactions fee is in fri, oldV transactions fee is in wei
+     *
+     * @returns response from estimate_fee
+     */
+    abstract estimateDeclareFee(contractPayload: DeclareContractPayload, estimateFeeDetails?: EstimateFeeDetails): Promise<EstimateFeeResponse>;
+    /**
+     * Estimate Fee for executing a DEPLOY_ACCOUNT transaction on starknet
+     *
+     * @param contractPayload -
+     * - classHash - the class hash of the compiled contract.
+     * - constructorCalldata? - constructor data;
+     * - contractAddress? - future account contract address. Precalculate for faster execution.
+     * - addressSalt? - salt used for calculation of the contractAddress. Required if contractAddress is provided.
+     *
+     * @param estimateFeeDetails -
+     * - blockIdentifier?
+     * - nonce? = 0
+     * - skipValidate? - default true
+     * - tip? - prioritize order of transactions in the mempool.
+     * - paymasterData? - entity other than the transaction sender to pay the transaction fees(EIP-4337)
+     * - nonceDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition)
+     * - feeDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition)
+     * - version? - specify ETransactionVersion - V3 Transactions fee is in fri, oldV transactions fee is in wei
+     *
+     * @returns response from estimate_fee
+     */
+    abstract estimateAccountDeployFee(contractPayload: DeployAccountContractPayload, estimateFeeDetails?: EstimateFeeDetails): Promise<EstimateFeeResponse>;
+    /**
+     * Estimate Fee for executing a UDC DEPLOY transaction on starknet
+     * This is different from the normal DEPLOY transaction as it goes through the Universal Deployer Contract (UDC)
+     
+    * @param deployContractPayload array or singular
+     * - classHash: computed class hash of compiled contract
+     * - salt: address salt
+     * - unique: bool if true ensure unique salt
+     * - constructorCalldata: constructor calldata
+     *
+     * @param estimateFeeDetails -
+     * - blockIdentifier?
+     * - nonce?
+     * - skipValidate? - default true
+     * - tip? - prioritize order of transactions in the mempool.
+     * - accountDeploymentData? - deploy an account contract (substitution for deploy account transaction)
+     * - paymasterData? - entity other than the transaction sender to pay the transaction fees(EIP-4337)
+     * - nonceDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition)
+     * - feeDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition)
+     * - version? - specify ETransactionVersion - V3 Transactions fee is in fri, oldV transactions fee is in wei
+     */
+    abstract estimateDeployFee(deployContractPayload: UniversalDeployerContractPayload | UniversalDeployerContractPayload[], estimateFeeDetails?: EstimateFeeDetails): Promise<EstimateFeeResponse>;
+    /**
+     * Estimate Fee for executing a list of transactions on starknet
+     * Contract must be deployed for fee estimation to be possible
+     *
+     * @param invocations array of transaction object containing :
+     * - type - the type of transaction : 'DECLARE' | (multi)'DEPLOY' | (multi)'INVOKE_FUNCTION' | 'DEPLOY_ACCOUNT'
+     * - payload - the payload of the transaction
+     *
+     *  @param details -
+     * - blockIdentifier?
+     * - nonce?
+     * - skipValidate? - default true
+     * - tip? - prioritize order of transactions in the mempool.
+     * - accountDeploymentData? - deploy an account contract (substitution for deploy account transaction)
+     * - paymasterData? - entity other than the transaction sender to pay the transaction fees(EIP-4337)
+     * - nonceDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition)
+     * - feeDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition)
+     * - version? - specify ETransactionVersion - V3 Transactions fee is in fri, oldV transactions fee is in wei
+     *
+     * @returns response from estimate_fee
+     */
+    abstract estimateFeeBulk(invocations: Invocations, details?: EstimateFeeDetails): Promise<EstimateFeeResponseBulk>;
+    /**
+     * Gets Suggested Max Fee based on the transaction type
+     *
+     * @param  {EstimateFeeAction} estimateFeeAction
+     * @param  {EstimateFeeDetails} details
+     * @returns EstimateFee (...response, resourceBounds, suggestedMaxFee)
+     */
+    abstract getSuggestedFee(estimateFeeAction: EstimateFeeAction, details: EstimateFeeDetails): Promise<EstimateFee>;
+    /**
+     * Simulates an array of transaction and returns an array of transaction trace and estimated fee.
+     *
+     * @param invocations Invocations containing:
+     * - type - transaction type: DECLARE, (multi)DEPLOY, DEPLOY_ACCOUNT, (multi)INVOKE_FUNCTION
+     * @param details SimulateTransactionDetails
+     *
+     * @returns response from simulate_transaction
+     */
+    abstract simulateTransaction(invocations: Invocations, details?: SimulateTransactionDetails): Promise<SimulateTransactionResponse>;
+    /**
+     * Invoke execute function in account contract
+     *
+     * @param transactions the invocation object or an array of them, containing:
+     * - contractAddress - the address of the contract
+     * - entrypoint - the entrypoint of the contract
+     * - calldata - (defaults to []) the calldata
+     * - signature - (defaults to []) the signature
+     * @param {InvocationsDetails} transactionsDetail Additional optional parameters for the transaction
+     *
+     * @returns response from addTransaction
+     */
+    abstract execute(transactions: AllowArray<Call>, transactionsDetail?: InvocationsDetails): Promise<InvokeFunctionResponse>;
+    /**
+     * @deprecated
+     * @param transactions the invocation object or an array of them, containing:
+     * - contractAddress - the address of the contract
+     * - entrypoint - the entrypoint of the contract
+     * - calldata - (defaults to []) the calldata
+     * - signature - (defaults to []) the signature
+     * @param abis (optional) the abi of the contract for better displaying
+     * @param {InvocationsDetails} transactionsDetail Additional optional parameters for the transaction
+     * * @returns response from addTransaction
+     */
+    abstract execute(transactions: AllowArray<Call>, abis?: Abi[], transactionsDetail?: InvocationsDetails): Promise<InvokeFunctionResponse>;
+    /**
+     * Declares a given compiled contract (json) to starknet
+     *
+     * @param contractPayload transaction payload to be deployed containing:
+     * - contract: compiled contract code
+     * - (optional) classHash: computed class hash of compiled contract. Pre-compute it for faster execution.
+     * - (required for Cairo1 without compiledClassHash) casm: CompiledContract | string;
+     * - (optional for Cairo1 with casm) compiledClassHash: compiled class hash from casm. Pre-compute it for faster execution.
+     * @param transactionsDetail - InvocationsDetails
+     *
+     * @returns a confirmation of sending a transaction on the starknet contract
+     */
+    abstract declare(contractPayload: DeclareContractPayload, transactionsDetail?: InvocationsDetails): Promise<DeclareContractResponse>;
+    /**
+     * Deploys a declared contract to starknet - using Universal Deployer Contract (UDC)
+     * support multicall
+     *
+     * @param payload -
+     * - classHash: computed class hash of compiled contract
+     * - [constructorCalldata] contract constructor calldata
+     * - [salt=pseudorandom] deploy address salt
+     * - [unique=true] ensure unique salt
+     * @param details - InvocationsDetails
+     *
+     * @returns
+     * - contract_address[]
+     * - transaction_hash
+     */
+    abstract deploy(payload: UniversalDeployerContractPayload | UniversalDeployerContractPayload[], details?: InvocationsDetails): Promise<MultiDeployContractResponse>;
+    /**
+     * Simplify deploy simulating old DeployContract with same response + UDC specific response
+     * Internal wait for L2 transaction, support multicall
+     *
+     * @param payload -
+     * - classHash: computed class hash of compiled contract
+     * - [constructorCalldata] contract constructor calldata
+     * - [salt=pseudorandom] deploy address salt
+     * - [unique=true] ensure unique salt
+     * @param details - InvocationsDetails
+     *
+     * @returns
+     *  - contract_address
+     *  - transaction_hash
+     *  - address
+     *  - deployer
+     *  - unique
+     *  - classHash
+     *  - calldata_len
+     *  - calldata
+     *  - salt
+     */
+    abstract deployContract(payload: UniversalDeployerContractPayload | UniversalDeployerContractPayload[], details?: InvocationsDetails): Promise<DeployContractUDCResponse>;
+    /**
+     * Declares and Deploy a given compiled contract (json) to starknet using UDC
+     * Internal wait for L2 transaction, do not support multicall
+     * Method will pass even if contract is already declared (internal using DeclareIfNot)
+     *
+     * @param payload
+     * - contract: compiled contract code
+     * - [casm=cairo1]: CairoAssembly | undefined;
+     * - [compiledClassHash]: string | undefined;
+     * - [classHash]: computed class hash of compiled contract
+     * - [constructorCalldata] contract constructor calldata
+     * - [salt=pseudorandom] deploy address salt
+     * - [unique=true] ensure unique salt
+     * @param details - InvocationsDetails
+     *
+     * @returns
+     * - declare
+     *    - transaction_hash
+     * - deploy
+     *    - contract_address
+     *    - transaction_hash
+     *    - address
+     *    - deployer
+     *    - unique
+     *    - classHash
+     *    - calldata_len
+     *    - calldata
+     *    - salt
+     */
+    abstract declareAndDeploy(payload: DeclareAndDeployContractPayload, details?: InvocationsDetails): Promise<DeclareDeployUDCResponse>;
+    /**
+     * Deploy the account on Starknet
+     *
+     * @param contractPayload transaction payload to be deployed containing:
+     * - classHash: computed class hash of compiled contract
+     * - optional constructor calldata
+     * - optional address salt
+     * - optional contractAddress
+     * @param transactionsDetail - InvocationsDetails
+     *
+     * @returns a confirmation of sending a transaction on the starknet contract
+     */
+    abstract deployAccount(contractPayload: DeployAccountContractPayload, transactionsDetail?: InvocationsDetails): Promise<DeployContractResponse>;
+    /**
+     * Signs a TypedData object for off-chain usage with the Starknet private key and returns the signature
+     * This adds a message prefix so it can't be interchanged with transactions
+     *
+     * @param typedData - TypedData object to be signed
+     * @returns the signature of the TypedData object
+     * @throws {Error} if typedData is not a valid TypedData
+     */
+    abstract signMessage(typedData: TypedData): Promise<Signature>;
+    /**
+     * Hash a TypedData object with Pedersen hash and return the hash
+     * This adds a message prefix so it can't be interchanged with transactions
+     *
+     * @param typedData - TypedData object to be hashed
+     * @returns the hash of the TypedData object
+     * @throws {Error} if typedData is not a valid TypedData
+     */
+    abstract hashMessage(typedData: TypedData): Promise<string>;
+    /**
+     * Verify a signature of a TypedData object
+     *
+     * @param typedData - TypedData object to be verified
+     * @param signature - signature of the TypedData object
+     * @returns true if the signature is valid, false otherwise
+     * @throws {Error} if typedData is not a valid TypedData or the signature is not a valid signature
+     */
+    abstract verifyMessage(typedData: TypedData, signature: Signature): Promise<boolean>;
+    /**
+     * Verify a signature of a given hash
+     * @warning This method is not recommended, use verifyMessage instead
+     *
+     * @param hash - hash to be verified
+     * @param signature - signature of the hash
+     * @returns true if the signature is valid, false otherwise
+     * @throws {Error} if the signature is not a valid signature
+     */
+    abstract verifyMessageHash(hash: BigNumberish, signature: Signature): Promise<boolean>;
+    /**
+     * Gets the nonce of the account with respect to a specific block
+     *
+     * @param  {BlockIdentifier} blockIdentifier - optional blockIdentifier. Defaults to 'pending'
+     * @returns nonce of the account
+     */
+    abstract getNonce(blockIdentifier?: BlockIdentifier): Promise<Nonce>;
+}

package/dist/account/interface.mjs

@@ -0,0 +1,3 @@
+import { ProviderInterface } from "../provider/index.mjs";
+export class AccountInterface extends ProviderInterface {
+}

package/dist/channel/index.cjs

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  RPC06: true,
+  RPC07: true
+};
+exports.RPC07 = exports.RPC06 = void 0;
+var _RPC = _interopRequireWildcard(require("./rpc_0_6.cjs"));
+exports.RPC06 = _RPC;
+var _RPC2 = _interopRequireWildcard(require("./rpc_0_7.cjs"));
+exports.RPC07 = _RPC2;
+Object.keys(_RPC2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _RPC2[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _RPC2[key];
+    }
+  });
+});
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }

package/dist/channel/index.d.ts

@@ -0,0 +1,3 @@
+export * as RPC06 from './rpc_0_6';
+export * as RPC07 from './rpc_0_7';
+export * from './rpc_0_7';

package/dist/channel/index.mjs

@@ -0,0 +1,3 @@
+export * as RPC06 from "./rpc_0_6.mjs";
+export * as RPC07 from "./rpc_0_7.mjs";
+export * from "./rpc_0_7.mjs";