starknet 3.14.0 → 3.14.1

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [3.14.1](https://github.com/0xs34n/starknet.js/compare/v3.14.0...v3.14.1) (2022-06-15)
+
+### Bug Fixes
+
+- update api typings ([44796af](https://github.com/0xs34n/starknet.js/commit/44796af4849b6bab3d99065bb1e1948e4ea0b55e))
+
 # [3.14.0](https://github.com/0xs34n/starknet.js/compare/v3.13.1...v3.14.0) (2022-06-15)
 
 ### Bug Fixes

package/__tests__/provider.test.ts

@@ -85,20 +85,43 @@ describe('defaultProvider', () => {
         )
       ).resolves.not.toThrow();
     });
-    test('getTransaction()', async () => {
-      return expect(
-        defaultProvider.getTransaction(
-          '0x37013e1cb9c133e6fe51b4b371b76b317a480f56d80576730754c1662582348'
-        )
-      ).resolves.not.toThrow();
+
+    test('getTransaction() - successful transaction', async () => {
+      const transaction = await defaultProvider.getTransaction(
+        '0x37013e1cb9c133e6fe51b4b371b76b317a480f56d80576730754c1662582348'
+      );
+
+      expect(transaction).not.toHaveProperty('transaction_failure_reason');
+
+      expect(transaction.transaction).toHaveProperty('transaction_hash');
+
+      return expect(transaction.status).not.toEqual('REJECTED');
     });
 
-    test('getTransactionReceipt', async () => {
-      return expect(
-        defaultProvider.getTransactionReceipt(
-          '0x37013e1cb9c133e6fe51b4b371b76b317a480f56d80576730754c1662582348'
-        )
-      ).resolves.not.toThrow();
+    test('getTransaction() - failed transaction', async () => {
+      const transaction = await defaultProvider.getTransaction(
+        '0x698e60db2bae3ef8d5fafda10ff83b6ba634351aa1f4fcf8455ec0cffa738d9'
+      );
+
+      expect(transaction).toHaveProperty('transaction_failure_reason');
+
+      return expect(transaction.status).toEqual('REJECTED');
+    });
+
+    test('getTransactionReceipt() - successful transaction', async () => {
+      const transactionReceipt = await defaultProvider.getTransactionReceipt(
+        '0x18c49389193b40e178dfc9f2f595a7c79a7a55639e9951d956329f2ce6cfd4f'
+      );
+
+      return expect(transactionReceipt).toHaveProperty('actual_fee');
+    });
+
+    test('getTransactionReceipt() - failed transaction', async () => {
+      const transactionReceipt = await defaultProvider.getTransactionReceipt(
+        '0x698e60db2bae3ef8d5fafda10ff83b6ba634351aa1f4fcf8455ec0cffa738d9'
+      );
+
+      return expect(transactionReceipt).not.toHaveProperty('actual_fee');
     });
 
     test('callContract()', () => {

package/dist/types/api.d.ts

@@ -129,7 +129,7 @@ export declare type ExecutionResources = {
         bitwise_builtin: number;
         output_builtin: number;
         ecdsa_builtin: number;
-        ec_op_builtin: number;
+        ec_op_builtin?: number;
     };
     n_memory_holes: number;
 };
@@ -160,8 +160,9 @@ export declare type GetBlockResponse = {
             transaction_index: number;
         };
     };
-    previous_block_hash: string;
+    parent_block_hash: string;
     status: Status;
+    gas_price: string;
 };
 export declare type GetCodeResponse = {
     bytecode: string[];
@@ -169,9 +170,8 @@ export declare type GetCodeResponse = {
 };
 export declare type GetTransactionStatusResponse = {
     tx_status: Status;
-    block_hash: string;
+    block_hash?: string;
     tx_failure_reason?: {
-        tx_id: number;
         code: string;
         error_message: string;
     };
@@ -184,28 +184,36 @@ export declare type GetTransactionTraceResponse = {
         selector: string;
         calldata: RawArgs;
         result: Array<any>;
-        execution_resources: any;
+        execution_resources: ExecutionResources;
         internal_call: Array<any>;
         events: Array<any>;
         messages: Array<any>;
     };
     signature: Signature;
 };
-export declare type GetTransactionResponse = {
+export declare type SuccessfulTransactionResponse = {
     status: Status;
     transaction: Transaction;
     block_hash: string;
     block_number: BlockNumber;
     transaction_index: number;
-    transaction_hash: string;
 };
+export declare type FailedTransactionResponse = {
+    status: 'REJECTED';
+    transaction_failure_reason: {
+        code: string;
+        error_message: string;
+    };
+    transaction: Transaction;
+};
+export declare type GetTransactionResponse = SuccessfulTransactionResponse | FailedTransactionResponse;
 export declare type AddTransactionResponse = {
     code: TransactionStatus;
     transaction_hash: string;
     address?: string;
     class_hash?: string;
 };
-export declare type TransactionReceiptResponse = {
+export declare type SuccessfulTransactionReceiptResponse = {
     status: Status;
     transaction_hash: string;
     transaction_index: number;
@@ -213,7 +221,20 @@ export declare type TransactionReceiptResponse = {
     block_number: BlockNumber;
     l2_to_l1_messages: string[];
     events: string[];
+    actual_fee: string;
+    execution_resources: ExecutionResources;
+};
+export declare type FailedTransactionReceiptResponse = {
+    status: 'REJECTED';
+    transaction_failure_reason: {
+        code: string;
+        error_message: string;
+    };
+    transaction_hash: string;
+    l2_to_l1_messages: string[];
+    events: string[];
 };
+export declare type TransactionReceiptResponse = SuccessfulTransactionReceiptResponse | FailedTransactionReceiptResponse;
 export declare type EstimateFeeResponse = {
     amount: BN;
     unit: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "3.14.0",
+  "version": "3.14.1",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/types/api.ts

@@ -146,7 +146,7 @@ export type ExecutionResources = {
     bitwise_builtin: number;
     output_builtin: number;
     ecdsa_builtin: number;
-    ec_op_builtin: number;
+    ec_op_builtin?: number;
   };
   n_memory_holes: number;
 };
@@ -184,8 +184,9 @@ export type GetBlockResponse = {
       transaction_index: number;
     };
   };
-  previous_block_hash: string;
+  parent_block_hash: string;
   status: Status;
+  gas_price: string;
 };
 
 export type GetCodeResponse = {
@@ -195,9 +196,8 @@ export type GetCodeResponse = {
 
 export type GetTransactionStatusResponse = {
   tx_status: Status;
-  block_hash: string;
+  block_hash?: string;
   tx_failure_reason?: {
-    tx_id: number;
     code: string;
     error_message: string;
   };
@@ -211,7 +211,7 @@ export type GetTransactionTraceResponse = {
     selector: string;
     calldata: RawArgs;
     result: Array<any>;
-    execution_resources: any;
+    execution_resources: ExecutionResources;
     internal_call: Array<any>;
     events: Array<any>;
     messages: Array<any>;
@@ -219,15 +219,25 @@ export type GetTransactionTraceResponse = {
   signature: Signature;
 };
 
-export type GetTransactionResponse = {
+export type SuccessfulTransactionResponse = {
   status: Status;
   transaction: Transaction;
   block_hash: string;
   block_number: BlockNumber;
   transaction_index: number;
-  transaction_hash: string;
 };
 
+export type FailedTransactionResponse = {
+  status: 'REJECTED';
+  transaction_failure_reason: {
+    code: string;
+    error_message: string;
+  };
+  transaction: Transaction;
+};
+
+export type GetTransactionResponse = SuccessfulTransactionResponse | FailedTransactionResponse;
+
 export type AddTransactionResponse = {
   code: TransactionStatus;
   transaction_hash: string;
@@ -235,7 +245,7 @@ export type AddTransactionResponse = {
   class_hash?: string;
 };
 
-export type TransactionReceiptResponse = {
+export type SuccessfulTransactionReceiptResponse = {
   status: Status;
   transaction_hash: string;
   transaction_index: number;
@@ -243,8 +253,25 @@ export type TransactionReceiptResponse = {
   block_number: BlockNumber;
   l2_to_l1_messages: string[];
   events: string[];
+  actual_fee: string;
+  execution_resources: ExecutionResources;
 };
 
+export type FailedTransactionReceiptResponse = {
+  status: 'REJECTED';
+  transaction_failure_reason: {
+    code: string;
+    error_message: string;
+  };
+  transaction_hash: string;
+  l2_to_l1_messages: string[];
+  events: string[];
+};
+
+export type TransactionReceiptResponse =
+  | SuccessfulTransactionReceiptResponse
+  | FailedTransactionReceiptResponse;
+
 export type EstimateFeeResponse = {
   amount: BN;
   unit: string;

package/types/api.d.ts

@@ -139,7 +139,7 @@ export declare type ExecutionResources = {
     bitwise_builtin: number;
     output_builtin: number;
     ecdsa_builtin: number;
-    ec_op_builtin: number;
+    ec_op_builtin?: number;
   };
   n_memory_holes: number;
 };
@@ -176,8 +176,9 @@ export declare type GetBlockResponse = {
       transaction_index: number;
     };
   };
-  previous_block_hash: string;
+  parent_block_hash: string;
   status: Status;
+  gas_price: string;
 };
 export declare type GetCodeResponse = {
   bytecode: string[];
@@ -185,9 +186,8 @@ export declare type GetCodeResponse = {
 };
 export declare type GetTransactionStatusResponse = {
   tx_status: Status;
-  block_hash: string;
+  block_hash?: string;
   tx_failure_reason?: {
-    tx_id: number;
     code: string;
     error_message: string;
   };
@@ -200,28 +200,38 @@ export declare type GetTransactionTraceResponse = {
     selector: string;
     calldata: RawArgs;
     result: Array<any>;
-    execution_resources: any;
+    execution_resources: ExecutionResources;
     internal_call: Array<any>;
     events: Array<any>;
     messages: Array<any>;
   };
   signature: Signature;
 };
-export declare type GetTransactionResponse = {
+export declare type SuccessfulTransactionResponse = {
   status: Status;
   transaction: Transaction;
   block_hash: string;
   block_number: BlockNumber;
   transaction_index: number;
-  transaction_hash: string;
 };
+export declare type FailedTransactionResponse = {
+  status: 'REJECTED';
+  transaction_failure_reason: {
+    code: string;
+    error_message: string;
+  };
+  transaction: Transaction;
+};
+export declare type GetTransactionResponse =
+  | SuccessfulTransactionResponse
+  | FailedTransactionResponse;
 export declare type AddTransactionResponse = {
   code: TransactionStatus;
   transaction_hash: string;
   address?: string;
   class_hash?: string;
 };
-export declare type TransactionReceiptResponse = {
+export declare type SuccessfulTransactionReceiptResponse = {
   status: Status;
   transaction_hash: string;
   transaction_index: number;
@@ -229,7 +239,22 @@ export declare type TransactionReceiptResponse = {
   block_number: BlockNumber;
   l2_to_l1_messages: string[];
   events: string[];
+  actual_fee: string;
+  execution_resources: ExecutionResources;
+};
+export declare type FailedTransactionReceiptResponse = {
+  status: 'REJECTED';
+  transaction_failure_reason: {
+    code: string;
+    error_message: string;
+  };
+  transaction_hash: string;
+  l2_to_l1_messages: string[];
+  events: string[];
 };
+export declare type TransactionReceiptResponse =
+  | SuccessfulTransactionReceiptResponse
+  | FailedTransactionReceiptResponse;
 export declare type EstimateFeeResponse = {
   amount: BN;
   unit: string;