starknet 3.12.3 → 3.13.0

package/provider/interface.d.ts

@@ -75,7 +75,7 @@ export declare abstract class ProviderInterface {
    */
   abstract getStorageAt(
     contractAddress: string,
-    key: number,
+    key: BigNumberish,
     blockIdentifier?: BlockIdentifier
   ): Promise<object>;
   /**

package/provider/utils.js

@@ -26,10 +26,10 @@ exports.formatHash = formatHash;
  */
 function txIdentifier(txHash, txId) {
   if (!txHash) {
-    return 'transactionId=' + JSON.stringify(txId);
+    return 'transactionId='.concat(JSON.stringify(txId));
   }
   var hashString = formatHash(txHash);
-  return 'transactionHash=' + hashString;
+  return 'transactionHash='.concat(hashString);
 }
 exports.txIdentifier = txIdentifier;
 /**
@@ -55,7 +55,7 @@ function getBlockIdentifier(blockIdentifier) {
     return { type: 'BLOCK_NUMBER', data: parseInt(blockIdentifier, 10) };
   }
   if (typeof blockIdentifier === 'string') {
-    throw new Error('Invalid block identifier: ' + blockIdentifier);
+    throw new Error('Invalid block identifier: '.concat(blockIdentifier));
   }
   return { type: 'BLOCK_HASH', data: blockIdentifier };
 }
@@ -77,8 +77,8 @@ function getFormattedBlockIdentifier(blockIdentifier) {
     return '';
   }
   if (blockIdentifierObject.type === 'BLOCK_NUMBER') {
-    return 'blockNumber=' + blockIdentifierObject.data;
+    return 'blockNumber='.concat(blockIdentifierObject.data);
   }
-  return 'blockHash=' + (0, number_1.toHex)((0, number_1.toBN)(blockIdentifierObject.data));
+  return 'blockHash='.concat((0, number_1.toHex)((0, number_1.toBN)(blockIdentifierObject.data)));
 }
 exports.getFormattedBlockIdentifier = getFormattedBlockIdentifier;

package/signer/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;

package/src/provider/default.ts

@@ -31,7 +31,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 +252,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 });

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>;
 

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;

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;

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;

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/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()
 );
 ```

package/__tests__/accountContract.test.ts

@@ -1,110 +0,0 @@
-import { Contract, defaultProvider, ec, hash, number, stark } from '../src';
-import { StarknetChainId } from '../src/constants';
-import {
-  calculcateTransactionHash,
-  getSelectorFromName,
-  transactionVersion,
-} from '../src/utils/hash';
-import { fromCallsToExecuteCalldataWithNonce } from '../src/utils/transaction';
-import { compiledArgentAccount, compiledErc20 } from './fixtures';
-
-describe('getStarkAccountFromPrivateKey()', () => {
-  test('it works with valid privateKey', () => {
-    const privateKey = '0xb696427c0d79c5d28a1fa6f748bae1b98b3f4b86bd1a2505bab144673c856fa9';
-
-    const starkKeyPair = ec.getKeyPair(privateKey);
-    const starkKey = ec.getStarkKey(starkKeyPair);
-
-    expect(starkKey).toBe('0x060d46f8d7ef3d83ed05f3ed9beb91e22f9529289b9d863683fd71eafaf28035');
-  });
-  test('it works with valid privateKey', () => {
-    const privateKey = '0x5f65099e269b080000000000000000000000000000000000000000000000000';
-
-    const starkKeyPair = ec.getKeyPair(privateKey);
-    const starkKey = ec.getStarkKey(starkKeyPair);
-
-    expect(starkKey).toBe('0xf321e59b257a577836d8313150aabd21f412491358c329966218df76bab591');
-  });
-});
-
-test('build tx', async () => {
-  const privateKey = '0x1B69B4BE052FAB1';
-  const keyPair = ec.getKeyPair(privateKey);
-  const address = ec.getStarkKey(keyPair);
-
-  expect(address).toBe('0x04024999b9574cb7623679ce049a609db62a95098982c5b28ac61abdebd1c82b');
-
-  const selector = hash.getSelectorFromName('transfer');
-
-  expect(selector).toMatchInlineSnapshot(
-    `"0x83afd3f4caedc6eebf44246fe54e38c95e3179a5ec9ea81740eca5b482d12e"`
-  );
-
-  const calls = [{ contractAddress: '1', entrypoint: 'transfer', calldata: ['6', '7'] }];
-  const calldata = fromCallsToExecuteCalldataWithNonce(calls, 0);
-
-  const msgHash = calculcateTransactionHash(
-    address,
-    transactionVersion,
-    getSelectorFromName('__execute__'),
-    calldata,
-    0,
-    StarknetChainId.TESTNET
-  );
-  expect(number.toBN(msgHash).toString()).toMatchInlineSnapshot(
-    `"235855380881994314533025886817815774848495061484535023348790852315407085619"`
-  );
-
-  const [r, s] = ec.sign(keyPair, msgHash);
-  expect(r.toString()).toMatchInlineSnapshot(
-    `"181489288548431284937202760565682158657883789985879744111612429574110648095"`
-  );
-  expect(s.toString()).toMatchInlineSnapshot(
-    `"2055384802167699202203509702082340762385659879831017273872106910763470114538"`
-  );
-});
-
-describe('deploy and test Wallet', () => {
-  const privateKey = stark.randomAddress();
-
-  const starkKeyPair = ec.getKeyPair(privateKey);
-  const starkKeyPub = ec.getStarkKey(starkKeyPair);
-  let accountContract: Contract;
-  let erc20: Contract;
-  let erc20Address: string;
-
-  beforeAll(async () => {
-    const accountResponse = await defaultProvider.deployContract({
-      contract: compiledArgentAccount,
-      addressSalt: starkKeyPub,
-    });
-    accountContract = new Contract(compiledArgentAccount.abi, accountResponse.address);
-    expect(accountResponse.code).toBe('TRANSACTION_RECEIVED');
-
-    const initializeResponse = await accountContract.initialize(starkKeyPub, '0');
-    expect(initializeResponse.code).toBe('TRANSACTION_RECEIVED');
-
-    const erc20Response = await defaultProvider.deployContract({
-      contract: compiledErc20,
-    });
-    erc20Address = erc20Response.address;
-    erc20 = new Contract(compiledErc20.abi, erc20Address);
-    expect(erc20Response.code).toBe('TRANSACTION_RECEIVED');
-
-    const mintResponse = await erc20.mint(accountContract.address, '1000');
-    expect(mintResponse.code).toBe('TRANSACTION_RECEIVED');
-    await defaultProvider.waitForTransaction(mintResponse.transaction_hash);
-  });
-
-  test('read nonce', async () => {
-    const { nonce } = await accountContract.get_nonce();
-
-    expect(number.toBN(nonce as string).toString()).toStrictEqual(number.toBN(0).toString());
-  });
-
-  test('read balance of wallet', async () => {
-    const { res } = await erc20.balance_of(accountContract.address);
-
-    expect(res).toStrictEqual(number.toBN(1000));
-  });
-});