starknet 3.5.1 → 3.6.0

package/www/docs/API/signer.md

@@ -0,0 +1,8 @@
+---
+sidebar_position: 3
+---
+
+# Signer
+
+The **Signer** API allows you to sign transactions and messages, and also allows you to get the public key.
+

package/www/docusaurus.config.js

@@ -0,0 +1,131 @@
+// @ts-check
+// Note: type annotations allow type checking and IDEs autocompletion
+
+const lightCodeTheme = require('prism-react-renderer/themes/github');
+const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  title: 'Starknet.js',
+  tagline: 'JavaScript libray for StarkNet',
+  url: 'https://starknetjs.com',
+  baseUrl: '/',
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+  favicon: 'img/favicon.ico',
+  organizationName: '0xs34n', // Usually your GitHub org/user name.
+  projectName: 'starknet.js', // Usually your repo name.
+
+  plugins: [
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'guides',
+        path: 'guides',
+        routeBasePath: 'guides',
+        sidebarPath: require.resolve('./sidebars.js'),
+      },
+    ],
+  ],
+
+  presets: [
+    [
+      'classic',
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
+        docs: {
+          sidebarPath: require.resolve('./sidebars.js'),
+          // Please change this to your repo.
+          editUrl: 'https://github.com/0xs34n/starknet.js',
+        },
+        blog: {
+          showReadingTime: true,
+          // Please change this to your repo.
+          editUrl:
+            'https://github.com/0xs34n/starknet.js',
+        },
+        theme: {
+          customCss: require.resolve('./src/css/custom.css'),
+        },
+      }),
+    ],
+  ],
+
+  themeConfig:
+    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+    ({
+      navbar: {
+        title: 'Home',
+        logo: {
+          alt: 'Starknet.js Logo',
+          src: 'img/logo.svg',
+        },
+        items: [
+          {
+            type: 'doc',
+            docId: 'API/index',
+            position: 'left',
+            label: 'API',
+          },
+          {
+            position: 'left',
+            label: 'Guides',
+            to: '/guides/intro'
+          },
+          // {to: '/blog', label: 'Blog', position: 'left'},
+          {
+            href: 'https://github.com/facebook/docusaurus',
+            label: 'GitHub',
+            position: 'right',
+          },
+        ],
+      },
+      footer: {
+        style: 'dark',
+        links: [
+          {
+            title: 'Docs',
+            items: [
+              {
+                label: 'API',
+                to: '/docs/API/',
+              },
+              {
+                label: 'Guides',
+                to: '/guides/intro',
+              },
+            ],
+          },
+          {
+            title: 'Community',
+            items: [
+              {
+                label: 'Twitter',
+                href: 'https://twitter.com/0xs34n',
+              },
+            ],
+          },
+          {
+            title: 'More',
+            items: [
+              // {
+              //   label: 'Blog',
+              //   to: '/blog',
+              // },
+              {
+                label: 'GitHub',
+                href: 'https://github.com/0xs34n/starknet.js',
+              },
+            ],
+          },
+        ],
+        copyright: `Copyright © ${new Date().getFullYear()} 0xs34n`,
+      },
+      prism: {
+        theme: lightCodeTheme,
+        darkTheme: darkCodeTheme,
+      },
+    }),
+};
+
+module.exports = config;

package/www/guides/account.md

@@ -0,0 +1,60 @@
+---
+sidebar_position: 2
+---
+
+# Creating an Account
+
+Since there are no Externally Owned Accounts (EOA) in StarkNet, all Accounts in StarkNet are contracts.
+
+Unlike in Ethereum where a wallet is created with a public and private key pair, StarkNet Accounts are the only way to sign transactions and messages, and verify signatures. Therefore a Account - Contract interface is needed.
+
+## Install and import StarkNet
+
+Install the latest version of starknet with `npm install starknet@next`
+
+```javascript
+import fs from "fs";
+import * as starknet from "starknet";
+```
+
+##  Generate random key pair.
+
+You can also get a key pair from a private key using `getKeyPair(pk: BigNumberish)`
+
+```javascript
+const starkKeyPair = ec.genKeyPair();
+const starkKeyPub = ec.getStarkKey(starkKeyPair);;
+```
+
+## Deploy Account Contract
+
+Deploy the Account contract and wait for it to be verified on StarkNet.
+
+```javascript
+const compiledArgentAccount = json.parse(
+  fs.readFileSync("./ArgentAccount.json").toString("ascii")
+);
+const accountResponse = await defaultProvider.deployContract({
+  contract: compiledArgentAccount,
+  addressSalt: starkKeyPub,
+});
+```
+
+## Use your new account
+
+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"
+);
+await defaultProvider.waitForTransaction(initializeTxHash);
+```

package/www/guides/cra.md

@@ -0,0 +1,3 @@
+# Usage with Create React App
+
+Please refer to this <ins>[GitHub issue](https://github.com/0xs34n/starknet.js/issues/37)</ins>

package/www/guides/erc20.md

@@ -0,0 +1,88 @@
+---
+sidebar_position: 3
+---
+# Deploy an ERC20 Contract
+
+Dpeploy the contract and wait for deployment transaction to be accepted on StarkNet
+
+```javascript
+const compiledErc20 = json.parse(
+  fs.readFileSync("./ERC20.json").toString("ascii")
+);
+const erc20Response = await defaultProvider.deployContract({
+  contract: compiledErc20,
+});
+console.log("Waiting for Tx to be Accepted on Starknet - ERC20 Deployment...");
+await defaultProvider.waitForTransaction(erc20Response.transaction_hash);
+```
+## Get the erc20 contract address and create the contact object
+```javascript
+const erc20Address = erc20Response.address;
+const erc20 = new Contract(compiledErc20.abi, erc20Address);
+```
+
+## Mint tokens to an account address
+```javascript
+const { transaction_hash: mintTxHash } = await erc20.mint(
+  accountContract.address,
+  "1000"
+);
+console.log(`Waiting for Tx to be Accepted on Starknet - Minting...`);
+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(
+  `accountContract Address ${accountContract.address} has a balance of:`,
+  number.toBN(balanceBeforeTransfer.res, 16).toString()
+);
+```
+
+## 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 = [
+  {
+    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
+);
+
+// Wait for the invoke transaction to be accepted on StarkNet
+console.log(`Waiting for Tx to be Accepted on Starknet - Transfer...`);
+await defaultProvider.waitForTransaction(transferTxHash);
+```
+
+## Check balance after transfer
+```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(
+  `accountContract Address ${accountContract.address} has a balance of:`,
+  number.toBN(balanceAfterTransfer.res, 16).toString()
+);
+```

package/www/guides/intro.md

@@ -0,0 +1,20 @@
+---
+sidebar_position: 1
+---
+
+# Getting Started
+
+```bash
+npm install starknet
+
+# to use latest features
+
+npm install starknet@next
+```
+
+## Compiling StarkNet Contracts
+
+Please check the StarkNet documentation <ins>[here](https://www.cairo-lang.org/docs/hello_starknet/intro.html)</ins> to compile starknet contracts.
+
+## Full example with account & erc20
+Please see workshop <ins>[here](https://github.com/0xs34n/starknet.js-workshop)</ins>