starknet 3.12.3 → 3.14.0

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,
@@ -31,7 +32,9 @@ type NetworkName = 'mainnet-alpha' | 'goerli-alpha';
 type ProviderOptions = { network: NetworkName } | { baseUrl: string };
 
 function wait(delay: number) {
-  return new Promise((res) => setTimeout(res, delay));
+  return new Promise((res) => {
+    setTimeout(res, delay);
+  });
 }
 
 function isEmptyQueryObject(obj?: Record<any, any>): obj is undefined {
@@ -250,7 +253,7 @@ export class Provider implements ProviderInterface {
    */
   public async getStorageAt(
     contractAddress: string,
-    key: number,
+    key: BigNumberish,
     blockIdentifier: BlockIdentifier = 'pending'
   ): Promise<object> {
     return this.fetchEndpoint('get_storage_at', { blockIdentifier, contractAddress, key });
@@ -270,14 +273,13 @@ export class Provider implements ProviderInterface {
   }
 
   /**
-   * Gets the transaction receipt from a tx hash or tx id.
+   * Gets the transaction receipt from a tx hash.
    *
-   * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L104-L111)
+   * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/167b28bcd940fd25ea3816204fa882a0b0a49603/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L183)
    *
    * @param txHash
    * @returns the transaction receipt object
    */
-
   public async getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse> {
     const txHashHex = toHex(toBN(txHash));
     return this.fetchEndpoint('get_transaction_receipt', { transactionHash: txHashHex });
@@ -308,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/provider/interface.ts

@@ -85,7 +85,7 @@ export abstract class ProviderInterface {
    */
   public abstract getStorageAt(
     contractAddress: string,
-    key: number,
+    key: BigNumberish,
     blockIdentifier?: BlockIdentifier
   ): Promise<object>;
 
@@ -109,6 +109,14 @@ export abstract class ProviderInterface {
    */
   public abstract getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
 
+  /**
+   * Gets the transaction receipt from a tx hash.
+   *
+   * [Reference] (https://github.com/starkware-libs/cairo-lang/blob/167b28bcd940fd25ea3816204fa882a0b0a49603/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L183)
+   *
+   * @param txHash
+   * @returns the transaction receipt object
+   */
   public abstract getTransactionReceipt(txHash: BigNumberish): Promise<TransactionReceiptResponse>;
 
   /**

package/src/types/account.ts

@@ -1,7 +1,14 @@
 import BN from 'bn.js';
 
+import { BlockIdentifier } from '../provider/utils';
+import { BigNumberish } from '../utils/number';
 import { EstimateFeeResponse } from './api';
 
 export interface EstimateFee extends EstimateFeeResponse {
   suggestedMaxFee: BN;
 }
+
+export interface EstimateFeeDetails {
+  nonce?: BigNumberish;
+  blockIdentifier?: BlockIdentifier;
+}

package/src/types/api.ts

@@ -55,7 +55,7 @@ export type Endpoints = {
   get_storage_at: {
     QUERY: {
       contractAddress: string;
-      key: number;
+      key: BigNumberish;
       blockIdentifier: BlockIdentifier;
     };
     REQUEST: never;
@@ -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;
@@ -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[];
@@ -224,6 +232,7 @@ export type AddTransactionResponse = {
   code: TransactionStatus;
   transaction_hash: string;
   address?: string;
+  class_hash?: string;
 };
 
 export type TransactionReceiptResponse = {

package/src/types/index.ts

@@ -2,3 +2,4 @@ export * from './lib';
 export * from './api';
 export * from './signer';
 export * from './contract';
+export * from './account';

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/types/account.d.ts

@@ -1,6 +1,12 @@
 import BN from 'bn.js';
 
+import { BlockIdentifier } from '../provider/utils';
+import { BigNumberish } from '../utils/number';
 import { EstimateFeeResponse } from './api';
 export interface EstimateFee extends EstimateFeeResponse {
   suggestedMaxFee: BN;
 }
+export interface EstimateFeeDetails {
+  nonce?: BigNumberish;
+  blockIdentifier?: BlockIdentifier;
+}

package/types/api.d.ts

@@ -54,7 +54,7 @@ export declare type Endpoints = {
   get_storage_at: {
     QUERY: {
       contractAddress: string;
-      key: number;
+      key: BigNumberish;
       blockIdentifier: BlockIdentifier;
     };
     REQUEST: never;
@@ -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;
@@ -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[];
 };
@@ -209,6 +219,7 @@ export declare type AddTransactionResponse = {
   code: TransactionStatus;
   transaction_hash: string;
   address?: string;
+  class_hash?: string;
 };
 export declare type TransactionReceiptResponse = {
   status: Status;

package/types/index.d.ts

@@ -2,3 +2,4 @@ export * from './lib';
 export * from './api';
 export * from './signer';
 export * from './contract';
+export * from './account';

package/types/index.js

@@ -4,12 +4,16 @@ var __createBinding =
   (Object.create
     ? function (o, m, k, k2) {
         if (k2 === undefined) k2 = k;
-        Object.defineProperty(o, k2, {
-          enumerable: true,
-          get: function () {
-            return m[k];
-          },
-        });
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (!desc || ('get' in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
       }
     : function (o, m, k, k2) {
         if (k2 === undefined) k2 = k;
@@ -27,3 +31,4 @@ __exportStar(require('./lib'), exports);
 __exportStar(require('./api'), exports);
 __exportStar(require('./signer'), exports);
 __exportStar(require('./contract'), exports);
+__exportStar(require('./account'), exports);

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/ellipticCurve.js

@@ -68,7 +68,7 @@ function fixMessage(msg) {
   }
   (0, minimalistic_assert_1.default)(pureHex.length === 63);
   // In this case delta will be 4 so we perform a shift-left of 4 bits by adding a ZERO_BN.
-  return pureHex + '0';
+  return ''.concat(pureHex, '0');
 }
 exports.genKeyPair = exports.ec.genKeyPair.bind(exports.ec);
 function getKeyPair(pk) {

package/utils/encode.js

@@ -76,7 +76,7 @@ function removeHexPrefix(hex) {
 }
 exports.removeHexPrefix = removeHexPrefix;
 function addHexPrefix(hex) {
-  return '0x' + removeHexPrefix(hex);
+  return '0x'.concat(removeHexPrefix(hex));
 }
 exports.addHexPrefix = addHexPrefix;
 function padString(str, length, left, padding) {

package/utils/hash.js

@@ -97,7 +97,7 @@ function pedersen(input) {
     (0, minimalistic_assert_1.default)(
       x.gte(constants_1.ZERO) &&
         x.lt((0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.FIELD_PRIME))),
-      'Invalid input: ' + input[i]
+      'Invalid input: '.concat(input[i])
     );
     for (var j = 0; j < 252; j += 1) {
       var pt = constantPoints[2 + i * 252 + j];

package/utils/number.js

@@ -4,12 +4,16 @@ var __createBinding =
   (Object.create
     ? function (o, m, k, k2) {
         if (k2 === undefined) k2 = k;
-        Object.defineProperty(o, k2, {
-          enumerable: true,
-          get: function () {
-            return m[k];
-          },
-        });
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (!desc || ('get' in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
       }
     : function (o, m, k, k2) {
         if (k2 === undefined) k2 = k;
@@ -68,7 +72,7 @@ function toHex(number) {
 }
 exports.toHex = toHex;
 function hexToDecimalString(hex) {
-  return toBN('0x' + hex.replace(/^0x/, '')).toString();
+  return toBN('0x'.concat(hex.replace(/^0x/, ''))).toString();
 }
 exports.hexToDecimalString = hexToDecimalString;
 function toFelt(num) {
@@ -88,11 +92,11 @@ function assertInRange(input, lowerBound, upperBound, inputName) {
   if (inputName === void 0) {
     inputName = '';
   }
-  var messageSuffix = inputName === '' ? 'invalid length' : 'invalid ' + inputName + ' length';
+  var messageSuffix = inputName === '' ? 'invalid length' : 'invalid '.concat(inputName, ' length');
   var inputBn = toBN(input);
   (0, minimalistic_assert_1.default)(
     inputBn.gte(toBN(lowerBound)) && inputBn.lt(toBN(upperBound)),
-    'Message not signable, ' + messageSuffix + '.'
+    'Message not signable, '.concat(messageSuffix, '.')
   );
 }
 exports.assertInRange = assertInRange;

package/utils/shortString.js

@@ -17,8 +17,8 @@ function isShortString(str) {
 }
 exports.isShortString = isShortString;
 function encodeShortString(str) {
-  if (!isASCII(str)) throw new Error(str + ' is not an ASCII string');
-  if (!isShortString(str)) throw new Error(str + ' is too long');
+  if (!isASCII(str)) throw new Error(''.concat(str, ' is not an ASCII string'));
+  if (!isShortString(str)) throw new Error(''.concat(str, ' is too long'));
   return (0, encode_1.addHexPrefix)(
     str.replace(/./g, function (char) {
       return char.charCodeAt(0).toString(16);

package/utils/typedData/index.js

@@ -4,12 +4,16 @@ var __createBinding =
   (Object.create
     ? function (o, m, k, k2) {
         if (k2 === undefined) k2 = k;
-        Object.defineProperty(o, k2, {
-          enumerable: true,
-          get: function () {
-            return m[k];
-          },
-        });
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (!desc || ('get' in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
       }
     : function (o, m, k, k2) {
         if (k2 === undefined) k2 = k;
@@ -76,7 +80,7 @@ function getHex(value) {
     if (typeof value === 'string') {
       return (0, number_1.toHex)((0, number_1.toBN)((0, shortString_1.encodeShortString)(value)));
     }
-    throw new Error('Invalid BigNumberish: ' + value);
+    throw new Error('Invalid BigNumberish: '.concat(value));
   }
 }
 /**
@@ -135,12 +139,10 @@ var encodeType = function (typedData, type) {
   var types = __spreadArray([primary], __read(dependencies.sort()), false);
   return types
     .map(function (dependency) {
-      return (
-        dependency +
-        '(' +
+      return ''.concat(dependency, '(').concat(
         typedData.types[dependency].map(function (t) {
-          return t.name + ':' + t.type;
-        }) +
+          return ''.concat(t.name, ':').concat(t.type);
+        }),
         ')'
       );
     })
@@ -193,7 +195,7 @@ var encodeData = function (typedData, type, data) {
             ts = _b[0],
             vs = _b[1];
           if (data[field.name] === undefined || data[field.name] === null) {
-            throw new Error("Cannot encode data: missing data for '" + field.name + "'");
+            throw new Error("Cannot encode data: missing data for '".concat(field.name, "'"));
           }
           var value = data[field.name];
           var _c = __read(encodeValue(typedData, field.type, value), 2),

package/www/docs/API/provider.md

@@ -131,11 +131,11 @@ Gets the status of a transaction.
 
 <hr/>
 
-provider.**getTransactionReceipt**(txHash, txId) => _Promise < TransactionReceipt >_
+provider.**getTransactionReceipt**(txHash) => _Promise < TransactionReceiptResponse >_
 
 Gets the status of a transaction.
 
-###### _TransactionReceipt_
+###### _TransactionReceiptResponse_
 
 ```
 {
@@ -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_
 

package/www/guides/account.md

@@ -14,7 +14,15 @@ Install the latest version of starknet with `npm install starknet@next`
 
 ```javascript
 import fs from "fs";
-import * as starknet from "starknet";
+import fs from "fs";
+import {
+  Account,
+  Contract,
+  defaultProvider,
+  ec,
+  json,
+  number,
+} from "starknet";
 ```
 
 ## Generate random key pair.
@@ -44,17 +52,23 @@ const accountResponse = await defaultProvider.deployContract({
 
 Wait for the deployment transaction to be accepted and assign the address of the deployed account to the Account object.
 
-Use your new account object to sign transactions, messages or verify signatures!
-
 ```javascript
 await defaultProvider.waitForTransaction(accountResponse.transaction_hash);
 const accountContract = new Contract(
   compiledArgentAccount.abi,
   accountResponse.address
 );
-const { transaction_hash: initializeTxHash } = await accountContract.initialize(
-  starkKeyPub,
-  "0"
+const initializeResponse = await accountContract.initialize(starkKeyPub, "0");
+
+await defaultProvider.waitForTransaction(initializeResponse.transaction_hash);
+```
+
+Once account contract is initialized [Account](../docs/API/account.md) instance can be created. Use your new account instance to sign transactions, messages or verify signatures!
+
+```js
+const account = new Account(
+    defaultProvider,
+    accountResponse.address,
+    starkKeyPair
 );
-await defaultProvider.waitForTransaction(initializeTxHash);
 ```

package/www/guides/erc20.md

@@ -4,7 +4,7 @@ sidebar_position: 3
 
 # Deploy an ERC20 Contract
 
-Dpeploy the contract and wait for deployment transaction to be accepted on StarkNet
+Deploy the contract and wait for deployment transaction to be accepted on StarkNet
 
 ```javascript
 const compiledErc20 = json.parse(
@@ -26,9 +26,11 @@ const erc20 = new Contract(compiledErc20.abi, erc20Address);
 
 ## Mint tokens to an account address
 
+Make sure you created the `Account` instance following the [Creating an Account](./account.md) guide.
+
 ```javascript
 const { transaction_hash: mintTxHash } = await erc20.mint(
-  accountContract.address,
+  account.address,
   "1000"
 );
 console.log(`Waiting for Tx to be Accepted on Starknet - Minting...`);
@@ -38,11 +40,11 @@ await defaultProvider.waitForTransaction(mintTxHash);
 ## Check balance after mint
 
 ```javascript
-console.log(`Calling StarkNet for accountContract balance...`);
-const balanceBeforeTransfer = await erc20.balance_of(accountContract.address);
+console.log(`Calling StarkNet for account balance...`);
+const balanceBeforeTransfer = await erc20.balance_of(account.address);
 
 console.log(
-  `accountContract Address ${accountContract.address} has a balance of:`,
+  `account Address ${account.address} has a balance of:`,
   number.toBN(balanceBeforeTransfer.res, 16).toString()
 );
 ```
@@ -50,30 +52,16 @@ console.log(
 ## Transfer tokens
 
 ```javascript
-// Get the nonce of the account and prepare transfer tx
-console.log(`Calling StarkNet for accountContract nonce...`);
-const nonce = (await accountContract.call("get_nonce")).nonce.toString();
-const calls = [
+// Execute tx transfer of 10 tokens
+console.log(`Invoke Tx - Transfer 10 tokens back to erc20 contract...`);
+const { transaction_hash: transferTxHash } = await account.execute(
   {
     contractAddress: erc20Address,
     entrypoint: "transfer",
     calldata: [erc20Address, "10"],
   },
-];
-const msgHash = hash.hashMulticall(accountContract.address, calls, nonce, "0");
-
-const { callArray, calldata } = transformCallsToMulticallArrays(calls);
-
-// sign tx to transfer 10 tokens
-const signature = ec.sign(starkKeyPair, msgHash);
-
-// Execute tx transfer of 10 tokens
-console.log(`Invoke Tx - Transfer 10 tokens back to erc20 contract...`);
-const { transaction_hash: transferTxHash } = await accountContract.__execute__(
-  callArray,
-  calldata,
-  nonce,
-  signature
+  undefined,
+  { maxFee: "0" }
 );
 
 // Wait for the invoke transaction to be accepted on StarkNet
@@ -85,11 +73,11 @@ await defaultProvider.waitForTransaction(transferTxHash);
 
 ```javascript
 // Check balance after transfer - should be 990
-console.log(`Calling StarkNet for accountContract balance...`);
-const balanceAfterTransfer = await erc20.balance_of(accountContract.address);
+console.log(`Calling StarkNet for account balance...`);
+const balanceAfterTransfer = await erc20.balance_of(account.address);
 
 console.log(
-  `accountContract Address ${accountContract.address} has a balance of:`,
+  `account Address ${account.address} has a balance of:`,
   number.toBN(balanceAfterTransfer.res, 16).toString()
 );
 ```