starknet 3.5.1 → 3.8.0

package/src/provider/utils.ts

@@ -43,6 +43,12 @@ type BlockIdentifierObject =
  * @returns block identifier object
  */
 export function getBlockIdentifier(blockIdentifier: BlockIdentifier): BlockIdentifierObject {
+  if (blockIdentifier === null) {
+    return { type: 'BLOCK_NUMBER', data: null };
+  }
+  if (blockIdentifier === 'pending') {
+    return { type: 'BLOCK_NUMBER', data: 'pending' };
+  }
   if (typeof blockIdentifier === 'number') {
     return { type: 'BLOCK_NUMBER', data: blockIdentifier };
   }
@@ -52,12 +58,6 @@ export function getBlockIdentifier(blockIdentifier: BlockIdentifier): BlockIdent
   if (typeof blockIdentifier === 'string' && !Number.isNaN(parseInt(blockIdentifier, 10))) {
     return { type: 'BLOCK_NUMBER', data: parseInt(blockIdentifier, 10) };
   }
-  if (blockIdentifier === null) {
-    return { type: 'BLOCK_NUMBER', data: null };
-  }
-  if (blockIdentifier === 'pending') {
-    return { type: 'BLOCK_NUMBER', data: 'pending' };
-  }
   if (typeof blockIdentifier === 'string') {
     throw new Error(`Invalid block identifier: ${blockIdentifier}`);
   }
@@ -69,8 +69,7 @@ export function getBlockIdentifier(blockIdentifier: BlockIdentifier): BlockIdent
  *
  * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L164-L173)
  *
- * @param blockNumber
- * @param blockHash
+ * @param blockIdentifier
  * @returns block identifier for API request
  */
 export function getFormattedBlockIdentifier(blockIdentifier: BlockIdentifier = null): string {

package/src/signer/index.ts

@@ -1,2 +1,3 @@
 export * from './interface';
 export * from './default';
+export * from './ledger';

package/src/signer/ledger.ts

@@ -0,0 +1,81 @@
+import Eth from '@ledgerhq/hw-app-eth';
+import Transport from '@ledgerhq/hw-transport';
+import TransportWebHID from '@ledgerhq/hw-transport-webhid';
+
+import { Invocation, InvocationsSignerDetails, Signature } from '../types';
+import { addHexPrefix } from '../utils/encode';
+import { hashMulticall } from '../utils/hash';
+import { TypedData, getMessageHash } from '../utils/typedData';
+import { SignerInterface } from './interface';
+
+function hexZeroPad(hash: string, length: number): string {
+  let value = hash;
+  if (value.length > 2 * length + 2) {
+    throw new Error('value out of range');
+  }
+  while (value.length < 2 * length + 2) {
+    value = `0x0${value.substring(2)}`;
+  }
+  return value;
+}
+
+export class LedgerBlindSigner implements SignerInterface {
+  public derivationPath = "/2645'/579218131'/1148870696'/0'/0'/0";
+
+  private transport: Transport | undefined;
+
+  private async getEthApp(): Promise<Eth> {
+    if (!this.transport) {
+      try {
+        this.transport = await TransportWebHID.create();
+      } catch {
+        throw new Error('Device connection error');
+      }
+    }
+    return new Eth(this.transport);
+  }
+
+  public async getPubKey(): Promise<string> {
+    const eth = await this.getEthApp();
+    const response = await eth.starkGetPublicKey(this.derivationPath);
+    const starkPub = `0x${response.slice(1, 1 + 32).toString('hex')}`;
+    return starkPub;
+  }
+
+  public async signTransaction(
+    transactions: Invocation[],
+    transactionsDetail: InvocationsSignerDetails
+  ): Promise<Signature> {
+    const msgHash = hashMulticall(
+      transactionsDetail.walletAddress,
+      transactions,
+      transactionsDetail.nonce.toString(),
+      transactionsDetail.maxFee.toString()
+    );
+
+    return this.sign(msgHash);
+  }
+
+  public async signMessage(typedData: TypedData, accountAddress: string): Promise<Signature> {
+    const msgHash = getMessageHash(typedData, accountAddress);
+
+    return this.sign(msgHash);
+  }
+
+  protected async sign(msgHash: string): Promise<Signature> {
+    const eth = await this.getEthApp();
+
+    const {
+      r,
+      s,
+    }: {
+      r: string;
+      s: string;
+    } = (await eth.starkUnsafeSign(this.derivationPath, hexZeroPad(msgHash, 32))) as {
+      r: string;
+      s: string;
+    };
+
+    return [addHexPrefix(r), addHexPrefix(s)];
+  }
+}

package/src/types/api.ts

@@ -36,6 +36,13 @@ export type Endpoints = {
     REQUEST: never;
     RESPONSE: GetTransactionStatusResponse;
   };
+  get_transaction_trace: {
+    QUERY: {
+      transactionHash: string;
+    };
+    REQUEST: never;
+    RESPONSE: GetTransactionTraceResponse;
+  };
   get_storage_at: {
     QUERY: {
       contractAddress: string;
@@ -68,8 +75,10 @@ export type Endpoints = {
     RESPONSE: CallContractResponse;
   };
   estimate_fee: {
-    QUERY: never;
-    REQUEST: Transaction;
+    QUERY: {
+      blockIdentifier: BlockIdentifier;
+    };
+    REQUEST: CallContractTransaction;
     RESPONSE: EstimateFeeResponse;
   };
 };
@@ -95,6 +104,33 @@ export type InvokeFunctionTransaction = {
   entry_point_selector: string;
   calldata?: RawCalldata;
   nonce?: BigNumberish;
+  max_fee?: BigNumberish;
+};
+
+export type InvokeFunctionTrace = {
+  caller_address: string;
+  contract_address: string;
+  code_address: string;
+  selector: string;
+  calldata: RawCalldata;
+  result: Array<any>;
+  execution_resources: ExecutionResources;
+  internal_call: Array<InvokeFunctionTrace>;
+  events: Array<any>;
+  messages: Array<any>;
+};
+
+export type ExecutionResources = {
+  n_steps: number;
+  builtin_instance_counter: {
+    pedersen_builtin: number;
+    range_check_builtin: number;
+    bitwise_builtin: number;
+    output_builtin: number;
+    ecdsa_builtin: number;
+    ec_op_builtin: number;
+  };
+  n_memory_holes: number;
 };
 
 export type CallContractTransaction = Omit<
@@ -149,6 +185,22 @@ export type GetTransactionStatusResponse = {
   };
 };
 
+export type GetTransactionTraceResponse = {
+  function_invocation: {
+    caller_address: string;
+    contract_address: string;
+    code_address: string;
+    selector: string;
+    calldata: RawArgs;
+    result: Array<any>;
+    execution_resources: any;
+    internal_call: Array<any>;
+    events: Array<any>;
+    messages: Array<any>;
+  };
+  signature: Signature;
+};
+
 export type GetTransactionResponse = {
   status: Status;
   transaction: Transaction;
@@ -173,11 +225,20 @@ export type TransactionReceipt = {
   l2_to_l1_messages: string[];
   events: string[];
 };
-// TODO: Add response data
-export type EstimateFeeResponse = {};
+
+export type EstimateFeeResponse = {
+  amount: number;
+  unit: string;
+};
 
 export type RawArgs = {
   [inputName: string]: string | string[] | { type: 'struct'; [k: string]: BigNumberish };
 };
 
 export type Calldata = string[];
+
+export type Overrides = {
+  maxFee?: BigNumberish;
+  nonce?: BigNumberish;
+  signature?: Signature;
+};

package/tsconfig.json

@@ -103,14 +103,5 @@
     "skipLibCheck": true /* Skip type checking all .d.ts files. */
   },
   "include": ["src/**/*"],
-  "exclude": ["node_modules"],
-  "typedocOptions": {
-    "entryPoints": "src/index.ts",
-    "entryPointStrategy": "expand",
-    "out": "docs",
-    "githubPages": false,
-    "readme": "./README.md",
-    "name": "StarkNet.js Docs",
-    "sort": "required-first"
-  }
+  "exclude": ["node_modules"]
 }

package/types/api.d.ts

@@ -35,6 +35,13 @@ export declare type Endpoints = {
     REQUEST: never;
     RESPONSE: GetTransactionStatusResponse;
   };
+  get_transaction_trace: {
+    QUERY: {
+      transactionHash: string;
+    };
+    REQUEST: never;
+    RESPONSE: GetTransactionTraceResponse;
+  };
   get_storage_at: {
     QUERY: {
       contractAddress: string;
@@ -67,8 +74,10 @@ export declare type Endpoints = {
     RESPONSE: CallContractResponse;
   };
   estimate_fee: {
-    QUERY: never;
-    REQUEST: Transaction;
+    QUERY: {
+      blockIdentifier: BlockIdentifier;
+    };
+    REQUEST: CallContractTransaction;
     RESPONSE: EstimateFeeResponse;
   };
 };
@@ -91,6 +100,31 @@ export declare type InvokeFunctionTransaction = {
   entry_point_selector: string;
   calldata?: RawCalldata;
   nonce?: BigNumberish;
+  max_fee?: BigNumberish;
+};
+export declare type InvokeFunctionTrace = {
+  caller_address: string;
+  contract_address: string;
+  code_address: string;
+  selector: string;
+  calldata: RawCalldata;
+  result: Array<any>;
+  execution_resources: ExecutionResources;
+  internal_call: Array<InvokeFunctionTrace>;
+  events: Array<any>;
+  messages: Array<any>;
+};
+export declare type ExecutionResources = {
+  n_steps: number;
+  builtin_instance_counter: {
+    pedersen_builtin: number;
+    range_check_builtin: number;
+    bitwise_builtin: number;
+    output_builtin: number;
+    ecdsa_builtin: number;
+    ec_op_builtin: number;
+  };
+  n_memory_holes: number;
 };
 export declare type CallContractTransaction = Omit<
   InvokeFunctionTransaction,
@@ -138,6 +172,21 @@ export declare type GetTransactionStatusResponse = {
     error_message: string;
   };
 };
+export declare type GetTransactionTraceResponse = {
+  function_invocation: {
+    caller_address: string;
+    contract_address: string;
+    code_address: string;
+    selector: string;
+    calldata: RawArgs;
+    result: Array<any>;
+    execution_resources: any;
+    internal_call: Array<any>;
+    events: Array<any>;
+    messages: Array<any>;
+  };
+  signature: Signature;
+};
 export declare type GetTransactionResponse = {
   status: Status;
   transaction: Transaction;
@@ -160,7 +209,10 @@ export declare type TransactionReceipt = {
   l2_to_l1_messages: string[];
   events: string[];
 };
-export declare type EstimateFeeResponse = {};
+export declare type EstimateFeeResponse = {
+  amount: number;
+  unit: string;
+};
 export declare type RawArgs = {
   [inputName: string]:
     | string
@@ -171,3 +223,8 @@ export declare type RawArgs = {
       };
 };
 export declare type Calldata = string[];
+export declare type Overrides = {
+  maxFee?: BigNumberish;
+  nonce?: BigNumberish;
+  signature?: Signature;
+};

package/www/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

package/www/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

package/www/code-examples/account.js

@@ -0,0 +1,62 @@
+
+// Install the latest version of starknet with npm install starknet@next and import starknet
+import * as starknet from "starknet";
+
+// Generate public and private key pair.
+
+const keyPair = starknet.ec.genKeyPair();
+const starkKey = starknet.ec.getStarkKey(keyPair);
+const starkKeyInt = starknet.number.toBN(starknet.encode.removeHexPrefix(starkKey), 16);
+
+const { address: walletAddressLocal } = await provider.deployContract({contract: COMPILED_WALLET_CONTRACT_JSON, constructorCallData: [starkKeyInt], addressSalt: 0});
+
+walletAddress = walletAddressLocal;
+
+const { code: codeErc20, address: erc20AddressLocal } = await defaultProvider.deployContract({
+  contract: compiledErc20,
+});
+
+const erc20Address = erc20AddressLocal;
+const erc20 = new Contract(compiledErc20.abi, erc20Address);
+
+const { code: codeErc20Mint, transaction_hash: txErc20Mint } = await erc20.invoke('mint', {
+  recipient: walletAddress,
+  amount: '1000',
+});
+
+const balanceBeforeTransfer = await erc20.call('balance_of', {
+  user: walletAddress,
+}).res;
+
+console.log(number.toBN(res).toString())
+
+const { nonce } = await wallet.call('get_nonce');
+const msgHash = encode.addHexPrefix(
+  hash.hashMessage(
+    wallet.connectedTo,
+    erc20Address,
+    stark.getSelectorFromName('transfer'),
+    [erc20Address, '10'],
+    nonce.toString()
+  )
+);
+
+const signature = ec.sign(starkKeyPair, msgHash);
+const { code, transaction_hash } = await wallet.invoke(
+  'execute',
+  {
+    to: erc20Address,
+    selector: stark.getSelectorFromName('transfer'),
+    calldata: [erc20Address, '10'],
+    nonce: nonce.toString(),
+  },
+  signature
+);
+
+await defaultProvider.waitForTx(transaction_hash);
+
+const balanceAfterTransfer = await erc20.call('balance_of', {
+  user: walletAddress,
+}).res;
+
+console.log('Balance after transfer', balanceAfterTransfer)

package/www/code-examples/amm.js

@@ -0,0 +1,49 @@
+import { defaultProvider, stark } from 'starknet';
+const { getSelectorFromName } = stark;
+
+
+/**
+ * !! IMPORTANT NOTE !! When fees are introduced all function invocations will go through the account account contract and this example will be deprecated.
+**/
+
+const CONTRACT_ADDRESS =
+  "0x03e19baa6cb2078631bcdb34844f3f7879449a544c9ce722681a54af08cff4b9";
+
+/**
+ * invokeFunction() example
+**/
+
+/** Reset the liquidity pool **/
+const addLiquidityResponse = await defaultProvider.LEGACYinvokeFunction(
+  {
+    contractAddress: CONTRACT_ADDRESS,
+    entrypoint: "init_pool",
+    calldata: ["1000000", "1000000"],
+  }
+);
+console.log(addLiquidityResponse);
+
+/**
+ * callContract() example
+**/
+
+/** Get the balance of the liquidity pool of token A **/
+const poolBalanceTokenA = await defaultProvider.callContract({
+  contractAddress: CONTRACT_ADDRESS,
+  entrypoint: "get_pool_token_balance",
+  calldata: ["1"], // Account 1 (no account implemented)
+});
+const balanceA = poolBalanceTokenA.result[0];
+console.log('token a liquidity pool balance: ', parseInt(balanceA, 16));
+
+/** Get the balance of the liquidity pool of token B **/
+const poolBalanceTokenB = await defaultProvider.callContract({
+  contractAddress: CONTRACT_ADDRESS,
+  entrypoint: "get_pool_token_balance",
+  calldata: ["2"],
+});
+const balanceB = poolBalanceTokenB.result[0];
+console.log('token b liquidity pool balance: ', parseInt(balanceB, 16));
+
+
+/** Make a swap */

package/www/code-examples/erc20.js

@@ -0,0 +1,10 @@
+import * as starknet from "starknet";
+
+const keyPair = starknet.ec.genKeyPair();
+const starkKey = starknet.ec.getStarkKey(keyPair);
+const starkKeyInt = starknet.number.toBN(starknet.encode.removeHexPrefix(starkKey), 16);
+
+const deployWalletTx = await provider.deployContract({contract: COMPILED_WALLET_CONTRACT_JSON, constructorCallData: [starkKeyInt], addressSalt: 0});
+
+await defaultProvider.waitForTx(deployWalletTx.transaction_hash);
+