Merge pull request #890 from starknet-io/v6/v3-transactions

tabaktoni · web-flow · commit 621bdad94814 · 2023-12-11T18:36:32.000+01:00
V6/v3 transactions
diff --git a/src/account/default.ts b/src/account/default.ts
diff --git a/src/account/interface.ts b/src/account/interface.ts
@@ -44,7 +44,18 @@ export abstract class AccountInterface extends ProviderInterface {
    * @param calls the invocation object containing:
    * - contractAddress - the address of the contract
    * - entrypoint - the entrypoint of the contract
-   * - calldata - (defaults to []) the calldata
+   * - 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
    */
@@ -58,7 +69,20 @@ export abstract class AccountInterface extends ProviderInterface {
    *
    * @param contractPayload the payload object containing:
    * - contract - the compiled contract to be declared
-   * - classHash - the class hash of the compiled contract. This can be obtained by using starknet-cli.
+   * - 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
    */
@@ -71,11 +95,21 @@ export abstract class AccountInterface extends ProviderInterface {
    * Estimate Fee for executing a DEPLOY_ACCOUNT transaction on starknet
    *
    * @param contractPayload -
-   * - contract - the compiled contract to be deployed
-   * - classHash - the class hash of the compiled contract. This can be obtained by using starknet-cli.
+   * - 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 -
-   * - optional blockIdentifier
-   * - constant nonce = 0
+   * - 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
    */
   public abstract estimateAccountDeployFee(
@@ -87,20 +121,26 @@ export abstract class AccountInterface extends ProviderInterface {
    * 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 containing
+  * @param deployContractPayload array or singular
    * - classHash: computed class hash of compiled contract
    * - salt: address salt
    * - unique: bool if true ensure unique salt
-   * - calldata: constructor calldata
+   * - constructorCalldata: constructor calldata
    * 
-   * @param transactionsDetail Invocation Details containing:
-   *  - optional nonce
-   *  - optional version
-   *  - optional maxFee
+   * @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
    */
   public abstract estimateDeployFee(
     deployContractPayload: UniversalDeployerContractPayload | UniversalDeployerContractPayload[],
-    transactionsDetail?: InvocationsDetails
+    estimateFeeDetails?: EstimateFeeDetails
   ): Promise<EstimateFeeResponse>;
 
   /**
@@ -111,13 +151,50 @@ export abstract class AccountInterface extends ProviderInterface {
    * - type - the type of transaction : 'DECLARE' | (multi)'DEPLOY' | (multi)'INVOKE_FUNCTION' | 'DEPLOY_ACCOUNT'
    * - payload - the payload of the transaction
    *
+   *  @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
+   *
    * @returns response from estimate_fee
    */
   public 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)
+   */
+  public 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
+   */
+  public abstract simulateTransaction(
+    invocations: Invocations,
+    details?: SimulateTransactionDetails
+  ): Promise<SimulateTransactionResponse>;
+
   /**
    * Invoke execute function in account contract
    *
@@ -138,16 +215,14 @@ export abstract class AccountInterface extends ProviderInterface {
 
   /**
    * 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 Invocation Details containing:
-  - optional nonce
-  - optional version
-  - optional maxFee
+   * - 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
    */
   public abstract declare(
@@ -164,17 +239,15 @@ export abstract class AccountInterface extends ProviderInterface {
    * - [constructorCalldata] contract constructor calldata
    * - [salt=pseudorandom] deploy address salt
    * - [unique=true] ensure unique salt
-   * @param details -
-   * - [nonce=getNonce]
-   * - [version=transactionVersion]
-   * - [maxFee=getSuggestedFee]
+   * @param details - InvocationsDetails
+   *
    * @returns
    * - contract_address[]
    * - transaction_hash
    */
   public abstract deploy(
     payload: UniversalDeployerContractPayload | UniversalDeployerContractPayload[],
-    details?: InvocationsDetails | undefined
+    details?: InvocationsDetails
   ): Promise<MultiDeployContractResponse>;
 
   /**
@@ -186,10 +259,8 @@ export abstract class AccountInterface extends ProviderInterface {
    * - [constructorCalldata] contract constructor calldata
    * - [salt=pseudorandom] deploy address salt
    * - [unique=true] ensure unique salt
-   * @param details -
-   * - [nonce=getNonce]
-   * - [version=transactionVersion]
-   * - [maxFee=getSuggestedFee]
+   * @param details - InvocationsDetails
+   *
    * @returns
    *  - contract_address
    *  - transaction_hash
@@ -203,7 +274,7 @@ export abstract class AccountInterface extends ProviderInterface {
    */
   public abstract deployContract(
     payload: UniversalDeployerContractPayload | UniversalDeployerContractPayload[],
-    details?: InvocationsDetails | undefined
+    details?: InvocationsDetails
   ): Promise<DeployContractUDCResponse>;
 
   /**
@@ -219,10 +290,8 @@ export abstract class AccountInterface extends ProviderInterface {
    * - [constructorCalldata] contract constructor calldata
    * - [salt=pseudorandom] deploy address salt
    * - [unique=true] ensure unique salt
-   * @param details
-   * - [nonce=getNonce]
-   * - [version=transactionVersion]
-   * - [maxFee=getSuggestedFee]
+   * @param details - InvocationsDetails
+   *
    * @returns
    * - declare
    *    - transaction_hash
@@ -239,21 +308,19 @@ export abstract class AccountInterface extends ProviderInterface {
    */
   public abstract declareAndDeploy(
     payload: DeclareAndDeployContractPayload,
-    details?: InvocationsDetails | undefined
+    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 Invocation Details containing:
-  - constant nonce = 0
-  - optional version
-  - optional maxFee
+   * - 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
    */
   public abstract deployAccount(
@@ -309,30 +376,4 @@ export abstract class AccountInterface extends ProviderInterface {
    * @returns nonce of the account
    */
   public abstract getNonce(blockIdentifier?: BlockIdentifier): Promise<Nonce>;
-
-  /**
-   * Gets Suggested Max Fee based on the transaction type
-   *
-   * @param  {EstimateFeeAction} estimateFeeAction
-   * @param  {EstimateFeeDetails} details
-   * @returns suggestedMaxFee
-   */
-  public 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
-   */
-  public abstract simulateTransaction(
-    invocations: Invocations,
-    details?: SimulateTransactionDetails
-  ): Promise<SimulateTransactionResponse>;
 }
diff --git a/src/types/account.ts b/src/types/account.ts
@@ -16,20 +16,22 @@ export type AccountInvocationsFactoryDetails = {
   blockIdentifier?: BlockIdentifier;
 } & Partial<V3TransactionDetails>;
 
-export interface EstimateFeeDetails {
+export interface UniversalDetails {
   nonce?: BigNumberish;
   blockIdentifier?: BlockIdentifier;
-  maxFee?: BigNumberish; // TODO: max_fee is added to match InvocationsDetails
+  maxFee?: BigNumberish; // ignored on estimate
   tip?: BigNumberish;
   paymasterData?: BigNumberish[];
   accountDeploymentData?: BigNumberish[];
   nonceDataAvailabilityMode?: EDataAvailabilityMode;
   feeDataAvailabilityMode?: EDataAvailabilityMode;
-  version?: BigNumberish; // TODO: this is BigNumberish for interoperability with InvocationsDetails
-  resourceBounds?: ResourceBounds; // TODO: required for non estimate and for estimate is 00
-  skipValidate?: boolean; // TODO: Specific only to estimatFee methods
+  version?: BigNumberish;
+  resourceBounds?: ResourceBounds; // ignored on estimate
+  skipValidate?: boolean; // ignored on non-estimate
 }
 
+export interface EstimateFeeDetails extends UniversalDetails {}
+
 export interface DeployContractResponse {
   contract_address: string;
   transaction_hash: string;
diff --git a/src/types/api/rpcspec_0_6/errors.ts b/src/types/api/rpcspec_0_6/errors.ts
@@ -111,6 +111,7 @@ export interface INSUFFICIENT_ACCOUNT_BALANCE {
 export interface VALIDATION_FAILURE {
   code: 55;
   message: 'Account validation failed';
+  data: string;
 }
 
 export interface COMPILATION_FAILED {
diff --git a/src/types/api/rpcspec_0_6/index.ts b/src/types/api/rpcspec_0_6/index.ts
@@ -1,5 +1,5 @@
 /**
- * version 0.6.0-rc2
+ * version 0.6.0
  */
 
 export { Methods } from './methods';
diff --git a/src/types/api/rpcspec_0_6/methods.ts b/src/types/api/rpcspec_0_6/methods.ts
@@ -177,7 +177,7 @@ type ReadMethods = {
   starknet_estimateFee: {
     params: {
       request: BROADCASTED_TXN[];
-      simulation_flags?: [SIMULATION_FLAG_FOR_ESTIMATE_FEE] | []; // TODO: Check this is like this is spec (0.5 can't be, 0.6 must be)
+      simulation_flags?: [SIMULATION_FLAG_FOR_ESTIMATE_FEE] | []; // Diverged from spec (0.5 can't be, 0.6 must be)
       block_id: BLOCK_ID;
     };
     result: FeeEstimate[];
@@ -191,7 +191,7 @@ type ReadMethods = {
       block_id: BLOCK_ID;
     };
     result: FeeEstimate;
-    errors: Errors.CONTRACT_NOT_FOUND | Errors.CONTRACT_ERROR | Errors.BLOCK_NOT_FOUND;
+    errors: Errors.CONTRACT_ERROR | Errors.BLOCK_NOT_FOUND;
   };
 
   // Get the most recent accepted block number
diff --git a/src/types/lib/index.ts b/src/types/lib/index.ts
@@ -99,7 +99,7 @@ export type DeclareContractTransaction = {
 export type CallDetails = {
   contractAddress: string;
   calldata?: RawArgs | Calldata;
-  entrypoint?: string; // TODO: check if required
+  entrypoint?: string;
 };
 
 export type Invocation = CallDetails & { signature?: Signature };
@@ -113,7 +113,7 @@ export type InvocationsDetails = {
   nonce?: BigNumberish;
   maxFee?: BigNumberish;
   version?: BigNumberish;
-};
+} & Partial<V3TransactionDetails>;
 
 export type V3TransactionDetails = {
   nonce: BigNumberish;
diff --git a/src/utils/stark.ts b/src/utils/stark.ts

Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,7 @@ export interface INSUFFICIENT_ACCOUNT_BALANCE {`
`111`	`111`	`export interface VALIDATION_FAILURE {`
`112`	`112`	`code: 55;`
`113`	`113`	`message: 'Account validation failed';`
	`114`	`+ data: string;`
`114`	`115`	`}`
`115`	`116`
`116`	`117`	`export interface COMPILATION_FAILED {`