starknet 3.13.1 → 3.15.0

package/CHANGELOG.md

@@ -1,3 +1,29 @@
+# [3.15.0](https://github.com/0xs34n/starknet.js/compare/v3.14.1...v3.15.0) (2022-06-16)
+
+### Bug Fixes
+
+- **tests:** update test ([c71f482](https://github.com/0xs34n/starknet.js/commit/c71f482facdaac914c45f4bf91f48e05a930abff))
+
+### Features
+
+- add calculateContractAddressFromHash ([e22c346](https://github.com/0xs34n/starknet.js/commit/e22c3464036f97eee3c617d3790aac35b3d95379))
+
+## [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
+
+- remove redundant \_abi from declareContract() ([53d6578](https://github.com/0xs34n/starknet.js/commit/53d6578b932ed6046b5e0df83d748673d7efc3d5))
+
+### Features
+
+- support contract declaration API introduced at SN 0.9.0 ([ca6203f](https://github.com/0xs34n/starknet.js/commit/ca6203f93471d7fb421d580e07d6de7c183e40f3))
+
 ## [3.13.1](https://github.com/0xs34n/starknet.js/compare/v3.13.0...v3.13.1) (2022-06-14)
 
 ### Bug Fixes

package/__tests__/provider.test.ts

@@ -1,6 +1,6 @@
 import { defaultProvider, stark } from '../src';
 import { toBN } from '../src/utils/number';
-import { compiledArgentAccount } from './fixtures';
+import { compiledArgentAccount, compiledErc20 } from './fixtures';
 
 const { compileCalldata } = stark;
 
@@ -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()', () => {
@@ -123,6 +146,16 @@ describe('defaultProvider', () => {
   });
 
   describe('addTransaction()', () => {
+    test('declareContract()', async () => {
+      const response = await defaultProvider.declareContract({
+        contract: compiledErc20,
+      });
+
+      expect(response.code).toBe('TRANSACTION_RECEIVED');
+      expect(response.transaction_hash).toBeDefined();
+      expect(response.class_hash).toBeDefined();
+    });
+
     test('deployContract()', async () => {
       const response = await defaultProvider.deployContract({
         contract: compiledArgentAccount,

package/__tests__/utils/utils.test.ts

@@ -1,6 +1,7 @@
 import fs from 'fs';
 
 import { constants, hash, json, number, stark } from '../../src';
+import { pedersen } from '../../src/utils/hash';
 
 const { IS_BROWSER } = constants;
 
@@ -87,3 +88,29 @@ describe('estimatedFeeToMaxFee()', () => {
     expect(res).toBe(11_500);
   });
 });
+
+describe('calculateContractAddressFromHash()', () => {
+  // This test just show how to use calculateContractAddressFromHash for new devs
+
+  test('calculated contract address should match the snapshot', () => {
+    const ethAddress = '0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7';
+
+    const daiAddress = '0x03e85bfbb8e2a42b7bead9e88e9a1b19dbccf661471061807292120462396ec9';
+    const factoryAddress = '0x249827618A01858A72B7D04339C47195A324D20D6037033DFE2829F98AFF4FC';
+    const classHash = '0x55187E68C60664A947048E0C9E5322F9BF55F7D435ECDCF17ED75724E77368F';
+
+    // Any type of salt can be used. It depends on the dApp what kind of salt it wants to use.
+    const salt = pedersen([ethAddress, daiAddress]);
+
+    const res = hash.calculateContractAddressFromHash(
+      salt,
+      classHash,
+      [ethAddress, daiAddress, factoryAddress],
+      factoryAddress
+    );
+
+    expect(res).toMatchInlineSnapshot(
+      `"0x36dc8dcb3440596472ddde11facacc45d0cd250df764ae7c3d1a360c853c324"`
+    );
+  });
+});

package/account/default.js

@@ -424,6 +424,7 @@ var Account = /** @class */ (function (_super) {
         switch (_a.label) {
           case 0:
             if (transaction.type === 'DEPLOY') throw new Error('No DEPLOYS');
+            if (transaction.type === 'DECLARE') throw new Error('No DECLARES');
             (0,
             minimalistic_assert_1.default)(!transaction.signature, "Adding signatures to a signer transaction currently isn't supported");
             if (!transaction.nonce) return [3 /*break*/, 1];

package/constants.d.ts

@@ -10,6 +10,7 @@ export declare enum StarknetChainId {
   TESTNET = '0x534e5f474f45524c49',
 }
 export declare enum TransactionHashPrefix {
+  DECLARE = '0x6465636c617265',
   DEPLOY = '0x6465706c6f79',
   INVOKE = '0x696e766f6b65',
   L1_HANDLER = '0x6c315f68616e646c6572',

package/constants.js

@@ -37,6 +37,7 @@ var StarknetChainId;
 })((StarknetChainId = exports.StarknetChainId || (exports.StarknetChainId = {})));
 var TransactionHashPrefix;
 (function (TransactionHashPrefix) {
+  TransactionHashPrefix['DECLARE'] = '0x6465636c617265';
   TransactionHashPrefix['DEPLOY'] = '0x6465706c6f79';
   TransactionHashPrefix['INVOKE'] = '0x696e766f6b65';
   TransactionHashPrefix['L1_HANDLER'] = '0x6c315f68616e646c6572';

package/dist/account/default.js

@@ -267,6 +267,8 @@ var Account = /** @class */ (function (_super) {
                     case 0:
                         if (transaction.type === 'DEPLOY')
                             throw new Error('No DEPLOYS');
+                        if (transaction.type === 'DECLARE')
+                            throw new Error('No DECLARES');
                         (0, minimalistic_assert_1.default)(!transaction.signature, "Adding signatures to a signer transaction currently isn't supported");
                         if (!transaction.nonce) return [3 /*break*/, 1];
                         nonceBn = (0, number_1.toBN)(transaction.nonce);

package/dist/constants.d.ts

@@ -10,6 +10,7 @@ export declare enum StarknetChainId {
     TESTNET = "0x534e5f474f45524c49"
 }
 export declare enum TransactionHashPrefix {
+    DECLARE = "0x6465636c617265",
     DEPLOY = "0x6465706c6f79",
     INVOKE = "0x696e766f6b65",
     L1_HANDLER = "0x6c315f68616e646c6572"

package/dist/constants.js

@@ -16,6 +16,7 @@ var StarknetChainId;
 })(StarknetChainId = exports.StarknetChainId || (exports.StarknetChainId = {}));
 var TransactionHashPrefix;
 (function (TransactionHashPrefix) {
+    TransactionHashPrefix["DECLARE"] = "0x6465636c617265";
     TransactionHashPrefix["DEPLOY"] = "0x6465706c6f79";
     TransactionHashPrefix["INVOKE"] = "0x696e766f6b65";
     TransactionHashPrefix["L1_HANDLER"] = "0x6c315f68616e646c6572";

package/dist/provider/default.d.ts

@@ -1,5 +1,5 @@
 import { StarknetChainId } from '../constants';
-import { Abi, AddTransactionResponse, Call, CallContractResponse, DeployContractPayload, Endpoints, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, GetTransactionTraceResponse, Invocation, TransactionReceiptResponse } from '../types';
+import { Abi, AddTransactionResponse, Call, CallContractResponse, DeclareContractPayload, DeployContractPayload, Endpoints, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, GetTransactionTraceResponse, Invocation, TransactionReceiptResponse } from '../types';
 import { BigNumberish } from '../utils/number';
 import { ProviderInterface } from './interface';
 import { BlockIdentifier } from './utils';
@@ -110,6 +110,13 @@ export declare class Provider implements ProviderInterface {
      * @returns the transaction trace
      */
     getTransactionTrace(txHash: BigNumberish): Promise<GetTransactionTraceResponse>;
+    /**
+     * Declare a given compiled contract (json) on starknet
+     *
+     * @param contract - a json object containing the compiled contract
+     * @returns a confirmation of sending a transaction on the starknet contract
+     */
+    declareContract(payload: DeclareContractPayload): Promise<AddTransactionResponse>;
     /**
      * Deploys a given compiled contract (json) to starknet
      *

package/dist/provider/default.js

@@ -370,6 +370,25 @@ var Provider = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Declare a given compiled contract (json) on starknet
+     *
+     * @param contract - a json object containing the compiled contract
+     * @returns a confirmation of sending a transaction on the starknet contract
+     */
+    Provider.prototype.declareContract = function (payload) {
+        var parsedContract = typeof payload.contract === 'string'
+            ? (0, json_1.parse)(payload.contract)
+            : payload.contract;
+        var contractDefinition = __assign(__assign({}, parsedContract), { program: (0, stark_1.compressProgram)(parsedContract.program) });
+        return this.fetchEndpoint('add_transaction', undefined, {
+            type: 'DECLARE',
+            contract_class: contractDefinition,
+            nonce: (0, number_1.toHex)(constants_1.ZERO),
+            signature: [],
+            sender_address: (0, number_1.toHex)(constants_1.ONE),
+        });
+    };
     /**
      * Deploys a given compiled contract (json) to starknet
      *

package/dist/types/api.d.ts

@@ -84,6 +84,13 @@ export declare type GetContractAddressesResponse = {
     Starknet: string;
     GpsStatementVerifier: string;
 };
+export declare type DeclareTransaction = {
+    type: 'DECLARE';
+    contract_class: CompressedCompiledContract;
+    nonce: BigNumberish;
+    sender_address: BigNumberish;
+    signature: Signature;
+};
 export declare type DeployTransaction = {
     type: 'DEPLOY';
     contract_definition: CompressedCompiledContract;
@@ -122,12 +129,12 @@ 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;
 };
 export declare type CallContractTransaction = Omit<InvokeFunctionTransaction, 'type' | 'entry_point_type' | 'nonce'>;
-export declare type Transaction = DeployTransaction | InvokeFunctionTransaction;
+export declare type Transaction = DeclareTransaction | DeployTransaction | InvokeFunctionTransaction;
 export declare type CallContractResponse = {
     result: string[];
 };
@@ -153,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[];
@@ -162,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;
     };
@@ -177,27 +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;
@@ -205,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/dist/types/lib.d.ts

@@ -8,6 +8,9 @@ export declare type DeployContractPayload = {
     constructorCalldata?: RawCalldata;
     addressSalt?: BigNumberish;
 };
+export declare type DeclareContractPayload = {
+    contract: CompiledContract | string;
+};
 export declare type Invocation = {
     contractAddress: string;
     entrypoint: string;
@@ -22,7 +25,7 @@ export declare type InvocationsDetails = {
 };
 export declare type Status = 'NOT_RECEIVED' | 'RECEIVED' | 'PENDING' | 'ACCEPTED_ON_L2' | 'ACCEPTED_ON_L1' | 'REJECTED';
 export declare type TransactionStatus = 'TRANSACTION_RECEIVED';
-export declare type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
+export declare type Type = 'DECLARE' | 'DEPLOY' | 'INVOKE_FUNCTION';
 export declare type EntryPointType = 'EXTERNAL';
 export declare type CompressedProgram = string;
 export declare type AbiEntry = {

package/dist/utils/hash.d.ts

@@ -1,5 +1,6 @@
 import BN from 'bn.js';
 import { StarknetChainId, TransactionHashPrefix } from '../constants';
+import { RawCalldata } from '../types/lib';
 import { BigNumberish } from './number';
 export declare const transactionVersion = 0;
 export declare const feeTransactionVersion: BN;
@@ -24,3 +25,4 @@ export declare function computeHashOnElements(data: BigNumberish[]): string;
 export declare function calculateTransactionHashCommon(txHashPrefix: TransactionHashPrefix, version: BigNumberish, contractAddress: BigNumberish, entryPointSelector: BigNumberish, calldata: BigNumberish[], maxFee: BigNumberish, chainId: StarknetChainId, additionalData?: BigNumberish[]): string;
 export declare function calculateDeployTransactionHash(contractAddress: BigNumberish, constructorCalldata: BigNumberish[], version: BigNumberish, chainId: StarknetChainId): string;
 export declare function calculcateTransactionHash(contractAddress: BigNumberish, version: BigNumberish, entryPointSelector: BigNumberish, calldata: BigNumberish[], maxFee: BigNumberish, chainId: StarknetChainId): string;
+export declare function calculateContractAddressFromHash(salt: BigNumberish, classHash: BigNumberish, constructorCalldata: RawCalldata, deployerAddress: BigNumberish): string;

package/dist/utils/hash.js

@@ -28,7 +28,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculcateTransactionHash = exports.calculateDeployTransactionHash = exports.calculateTransactionHashCommon = exports.computeHashOnElements = exports.pedersen = exports.getSelectorFromName = exports.starknetKeccak = exports.feeTransactionVersion = exports.transactionVersion = void 0;
+exports.calculateContractAddressFromHash = exports.calculcateTransactionHash = exports.calculateDeployTransactionHash = exports.calculateTransactionHashCommon = exports.computeHashOnElements = exports.pedersen = exports.getSelectorFromName = exports.starknetKeccak = exports.feeTransactionVersion = exports.transactionVersion = void 0;
 var keccak_1 = require("ethereum-cryptography/keccak");
 var minimalistic_assert_1 = __importDefault(require("minimalistic-assert"));
 var constants_1 = require("../constants");
@@ -112,3 +112,16 @@ function calculcateTransactionHash(contractAddress, version, entryPointSelector,
     return calculateTransactionHashCommon(constants_1.TransactionHashPrefix.INVOKE, version, contractAddress, entryPointSelector, calldata, maxFee, chainId);
 }
 exports.calculcateTransactionHash = calculcateTransactionHash;
+function calculateContractAddressFromHash(salt, classHash, constructorCalldata, deployerAddress) {
+    var constructorCalldataHash = computeHashOnElements(constructorCalldata);
+    var CONTRACT_ADDRESS_PREFIX = (0, number_1.toFelt)('0x535441524b4e45545f434f4e54524143545f41444452455353'); // Equivalent to 'STARKNET_CONTRACT_ADDRESS'
+    var dataToHash = [
+        CONTRACT_ADDRESS_PREFIX,
+        deployerAddress,
+        salt,
+        classHash,
+        constructorCalldataHash,
+    ];
+    return computeHashOnElements(dataToHash);
+}
+exports.calculateContractAddressFromHash = calculateContractAddressFromHash;

package/package.json

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

package/provider/default.d.ts

@@ -4,6 +4,7 @@ import {
   AddTransactionResponse,
   Call,
   CallContractResponse,
+  DeclareContractPayload,
   DeployContractPayload,
   Endpoints,
   GetBlockResponse,
@@ -147,6 +148,13 @@ export declare class Provider implements ProviderInterface {
    * @returns the transaction trace
    */
   getTransactionTrace(txHash: BigNumberish): Promise<GetTransactionTraceResponse>;
+  /**
+   * Declare a given compiled contract (json) on starknet
+   *
+   * @param contract - a json object containing the compiled contract
+   * @returns a confirmation of sending a transaction on the starknet contract
+   */
+  declareContract(payload: DeclareContractPayload): Promise<AddTransactionResponse>;
   /**
    * Deploys a given compiled contract (json) to starknet
    *

package/provider/default.js

@@ -536,6 +536,26 @@ var Provider = /** @class */ (function () {
       });
     });
   };
+  /**
+   * Declare a given compiled contract (json) on starknet
+   *
+   * @param contract - a json object containing the compiled contract
+   * @returns a confirmation of sending a transaction on the starknet contract
+   */
+  Provider.prototype.declareContract = function (payload) {
+    var parsedContract =
+      typeof payload.contract === 'string' ? (0, json_1.parse)(payload.contract) : payload.contract;
+    var contractDefinition = __assign(__assign({}, parsedContract), {
+      program: (0, stark_1.compressProgram)(parsedContract.program),
+    });
+    return this.fetchEndpoint('add_transaction', undefined, {
+      type: 'DECLARE',
+      contract_class: contractDefinition,
+      nonce: (0, number_1.toHex)(constants_1.ZERO),
+      signature: [],
+      sender_address: (0, number_1.toHex)(constants_1.ONE),
+    });
+  };
   /**
    * Deploys a given compiled contract (json) to starknet
    *

package/src/account/default.ts

@@ -143,6 +143,7 @@ export class Account extends Provider implements AccountInterface {
    */
   public async LEGACY_addTransaction(transaction: Transaction): Promise<AddTransactionResponse> {
     if (transaction.type === 'DEPLOY') throw new Error('No DEPLOYS');
+    if (transaction.type === 'DECLARE') throw new Error('No DECLARES');
 
     assert(
       !transaction.signature,

package/src/constants.ts

@@ -13,6 +13,7 @@ export enum StarknetChainId {
   TESTNET = '0x534e5f474f45524c49', // encodeShortString('SN_GOERLI'),
 }
 export enum TransactionHashPrefix {
+  DECLARE = '0x6465636c617265', // encodeShortString('declare'),
   DEPLOY = '0x6465706c6f79', // encodeShortString('deploy'),
   INVOKE = '0x696e766f6b65', // encodeShortString('invoke'),
   L1_HANDLER = '0x6c315f68616e646c6572', // encodeShortString('l1_handler'),

package/src/provider/default.ts

@@ -1,13 +1,14 @@
 import fetch from 'cross-fetch';
 import urljoin from 'url-join';
 
-import { StarknetChainId } from '../constants';
+import { ONE, StarknetChainId, ZERO } from '../constants';
 import {
   Abi,
   AddTransactionResponse,
   Call,
   CallContractResponse,
   CompiledContract,
+  DeclareContractPayload,
   DeployContractPayload,
   Endpoints,
   GetBlockResponse,
@@ -309,6 +310,31 @@ export class Provider implements ProviderInterface {
     return this.fetchEndpoint('get_transaction_trace', { transactionHash: txHashHex });
   }
 
+  /**
+   * Declare a given compiled contract (json) on starknet
+   *
+   * @param contract - a json object containing the compiled contract
+   * @returns a confirmation of sending a transaction on the starknet contract
+   */
+  public declareContract(payload: DeclareContractPayload): Promise<AddTransactionResponse> {
+    const parsedContract =
+      typeof payload.contract === 'string'
+        ? (parse(payload.contract) as CompiledContract)
+        : payload.contract;
+    const contractDefinition = {
+      ...parsedContract,
+      program: compressProgram(parsedContract.program),
+    };
+
+    return this.fetchEndpoint('add_transaction', undefined, {
+      type: 'DECLARE',
+      contract_class: contractDefinition,
+      nonce: toHex(ZERO),
+      signature: [],
+      sender_address: toHex(ONE),
+    });
+  }
+
   /**
    * Deploys a given compiled contract (json) to starknet
    *

package/src/types/api.ts

@@ -97,6 +97,14 @@ export type GetContractAddressesResponse = {
   GpsStatementVerifier: string;
 };
 
+export type DeclareTransaction = {
+  type: 'DECLARE';
+  contract_class: CompressedCompiledContract;
+  nonce: BigNumberish;
+  sender_address: BigNumberish;
+  signature: Signature;
+};
+
 export type DeployTransaction = {
   type: 'DEPLOY';
   contract_definition: CompressedCompiledContract;
@@ -138,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;
 };
@@ -148,7 +156,7 @@ export type CallContractTransaction = Omit<
   'type' | 'entry_point_type' | 'nonce'
 >;
 
-export type Transaction = DeployTransaction | InvokeFunctionTransaction;
+export type Transaction = DeclareTransaction | DeployTransaction | InvokeFunctionTransaction;
 
 export type CallContractResponse = {
   result: string[];
@@ -176,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 = {
@@ -187,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;
   };
@@ -203,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>;
@@ -211,22 +219,33 @@ 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;
   address?: string;
+  class_hash?: string;
 };
 
-export type TransactionReceiptResponse = {
+export type SuccessfulTransactionReceiptResponse = {
   status: Status;
   transaction_hash: string;
   transaction_index: number;
@@ -234,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/src/types/lib.ts

@@ -12,6 +12,10 @@ export type DeployContractPayload = {
   addressSalt?: BigNumberish;
 };
 
+export type DeclareContractPayload = {
+  contract: CompiledContract | string;
+};
+
 export type Invocation = {
   contractAddress: string;
   entrypoint: string;
@@ -35,7 +39,7 @@ export type Status =
   | 'ACCEPTED_ON_L1'
   | 'REJECTED';
 export type TransactionStatus = 'TRANSACTION_RECEIVED';
-export type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
+export type Type = 'DECLARE' | 'DEPLOY' | 'INVOKE_FUNCTION';
 export type EntryPointType = 'EXTERNAL';
 export type CompressedProgram = string;
 

package/src/utils/hash.ts

@@ -11,9 +11,10 @@ import {
   TransactionHashPrefix,
   ZERO,
 } from '../constants';
+import { RawCalldata } from '../types/lib';
 import { ec } from './ellipticCurve';
 import { addHexPrefix, buf2hex, utf8ToArray } from './encode';
-import { BigNumberish, toBN, toHex } from './number';
+import { BigNumberish, toBN, toFelt, toHex } from './number';
 
 export const transactionVersion = 0;
 export const feeTransactionVersion = toBN(2).pow(toBN(128)).add(toBN(transactionVersion));
@@ -132,3 +133,24 @@ export function calculcateTransactionHash(
     chainId
   );
 }
+
+export function calculateContractAddressFromHash(
+  salt: BigNumberish,
+  classHash: BigNumberish,
+  constructorCalldata: RawCalldata,
+  deployerAddress: BigNumberish
+) {
+  const constructorCalldataHash = computeHashOnElements(constructorCalldata);
+
+  const CONTRACT_ADDRESS_PREFIX = toFelt('0x535441524b4e45545f434f4e54524143545f41444452455353'); // Equivalent to 'STARKNET_CONTRACT_ADDRESS'
+
+  const dataToHash = [
+    CONTRACT_ADDRESS_PREFIX,
+    deployerAddress,
+    salt,
+    classHash,
+    constructorCalldataHash,
+  ];
+
+  return computeHashOnElements(dataToHash);
+}

package/types/api.d.ts

@@ -94,6 +94,13 @@ export declare type GetContractAddressesResponse = {
   Starknet: string;
   GpsStatementVerifier: string;
 };
+export declare type DeclareTransaction = {
+  type: 'DECLARE';
+  contract_class: CompressedCompiledContract;
+  nonce: BigNumberish;
+  sender_address: BigNumberish;
+  signature: Signature;
+};
 export declare type DeployTransaction = {
   type: 'DEPLOY';
   contract_definition: CompressedCompiledContract;
@@ -132,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;
 };
@@ -140,7 +147,10 @@ export declare type CallContractTransaction = Omit<
   InvokeFunctionTransaction,
   'type' | 'entry_point_type' | 'nonce'
 >;
-export declare type Transaction = DeployTransaction | InvokeFunctionTransaction;
+export declare type Transaction =
+  | DeclareTransaction
+  | DeployTransaction
+  | InvokeFunctionTransaction;
 export declare type CallContractResponse = {
   result: string[];
 };
@@ -166,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[];
@@ -175,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;
   };
@@ -190,27 +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;
@@ -218,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;

package/types/lib.d.ts

@@ -9,6 +9,9 @@ export declare type DeployContractPayload = {
   constructorCalldata?: RawCalldata;
   addressSalt?: BigNumberish;
 };
+export declare type DeclareContractPayload = {
+  contract: CompiledContract | string;
+};
 export declare type Invocation = {
   contractAddress: string;
   entrypoint: string;
@@ -29,7 +32,7 @@ export declare type Status =
   | 'ACCEPTED_ON_L1'
   | 'REJECTED';
 export declare type TransactionStatus = 'TRANSACTION_RECEIVED';
-export declare type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
+export declare type Type = 'DECLARE' | 'DEPLOY' | 'INVOKE_FUNCTION';
 export declare type EntryPointType = 'EXTERNAL';
 export declare type CompressedProgram = string;
 export declare type AbiEntry = {

package/utils/hash.d.ts

@@ -1,6 +1,7 @@
 import BN from 'bn.js';
 
 import { StarknetChainId, TransactionHashPrefix } from '../constants';
+import { RawCalldata } from '../types/lib';
 import { BigNumberish } from './number';
 export declare const transactionVersion = 0;
 export declare const feeTransactionVersion: BN;
@@ -46,3 +47,9 @@ export declare function calculcateTransactionHash(
   maxFee: BigNumberish,
   chainId: StarknetChainId
 ): string;
+export declare function calculateContractAddressFromHash(
+  salt: BigNumberish,
+  classHash: BigNumberish,
+  constructorCalldata: RawCalldata,
+  deployerAddress: BigNumberish
+): string;

package/utils/hash.js

@@ -39,7 +39,8 @@ var __importDefault =
     return mod && mod.__esModule ? mod : { default: mod };
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.calculcateTransactionHash =
+exports.calculateContractAddressFromHash =
+  exports.calculcateTransactionHash =
   exports.calculateDeployTransactionHash =
   exports.calculateTransactionHashCommon =
   exports.computeHashOnElements =
@@ -174,3 +175,18 @@ function calculcateTransactionHash(
   );
 }
 exports.calculcateTransactionHash = calculcateTransactionHash;
+function calculateContractAddressFromHash(salt, classHash, constructorCalldata, deployerAddress) {
+  var constructorCalldataHash = computeHashOnElements(constructorCalldata);
+  var CONTRACT_ADDRESS_PREFIX = (0, number_1.toFelt)(
+    '0x535441524b4e45545f434f4e54524143545f41444452455353'
+  ); // Equivalent to 'STARKNET_CONTRACT_ADDRESS'
+  var dataToHash = [
+    CONTRACT_ADDRESS_PREFIX,
+    deployerAddress,
+    salt,
+    classHash,
+    constructorCalldataHash,
+  ];
+  return computeHashOnElements(dataToHash);
+}
+exports.calculateContractAddressFromHash = calculateContractAddressFromHash;

package/www/docs/API/provider.md

@@ -198,9 +198,26 @@ Gets the transaction trace from a tx hash.
 
 <hr/>
 
+provider.**declareContract**(payload) => _Promise < AddTransactionResponse >_
+
+Declares a contract on Starknet
+
+###### _AddTransactionResponse_
+
+```
+{
+  code: 'TRANSACTION_RECEIVED';
+  transaction_hash: string;
+  class_hash: string;
+};
+
+<hr/>
+
+```
+
 provider.**deployContract**(payload [ , abi ]) => _Promise < AddTransactionResponse >_
 
-Gets the transaction trace from a tx hash.
+Deploys a contract on Starknet
 
 ###### _AddTransactionResponse_