starknet 3.12.1 → 3.13.0

package/utils/typedData/utils.js

@@ -1,8 +1,6 @@
 'use strict';
 Object.defineProperty(exports, '__esModule', { value: true });
 exports.validateTypedData = void 0;
-var superstruct_1 = require('superstruct');
-var types_1 = require('./types');
 /**
  * Validates that `data` matches the EIP-712 JSON schema.
  *
@@ -10,6 +8,9 @@ var types_1 = require('./types');
  * @return {boolean}
  */
 var validateTypedData = function (data) {
-  return (0, superstruct_1.is)(data, types_1.STARKNET_TYPED_DATA_TYPE);
+  var typedData = data;
+  // Validate that the data matches the EIP-712 JSON schema
+  var valid = Boolean(typedData.types && typedData.primaryType && typedData.message);
+  return valid;
 };
 exports.validateTypedData = validateTypedData;

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