starknet 2.9.0 → 3.0.0

package/types/index.js

@@ -0,0 +1,28 @@
+'use strict';
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        Object.defineProperty(o, k2, {
+          enumerable: true,
+          get: function () {
+            return m[k];
+          },
+        });
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __exportStar =
+  (this && this.__exportStar) ||
+  function (m, exports) {
+    for (var p in m)
+      if (p !== 'default' && !Object.prototype.hasOwnProperty.call(exports, p))
+        __createBinding(exports, m, p);
+  };
+Object.defineProperty(exports, '__esModule', { value: true });
+__exportStar(require('./lib'), exports);
+__exportStar(require('./api'), exports);
+__exportStar(require('./signer'), exports);

package/types/lib.d.ts

@@ -0,0 +1,64 @@
+import type { ec as EC } from 'elliptic';
+
+import type { BigNumberish } from '../utils/number';
+export declare type KeyPair = EC.KeyPair;
+export declare type Signature = BigNumberish[];
+export declare type RawCalldata = BigNumberish[];
+export declare type DeployContractPayload = {
+  contract: CompiledContract | string;
+  constructorCalldata?: RawCalldata;
+  addressSalt?: BigNumberish;
+};
+export declare type Invocation = {
+  contractAddress: string;
+  entrypoint: string;
+  calldata?: RawCalldata;
+  signature?: Signature;
+};
+export declare type ExecuteInvocation = Omit<Invocation, 'signature'>;
+export declare type InvocationsDetails = {
+  nonce?: BigNumberish;
+};
+export declare type Call = Omit<Invocation, 'signature' | 'nonce'>;
+export declare type Status =
+  | 'NOT_RECEIVED'
+  | 'RECEIVED'
+  | 'PENDING'
+  | 'ACCEPTED_ON_L2'
+  | 'ACCEPTED_ON_L1'
+  | 'REJECTED';
+export declare type TransactionStatus = 'TRANSACTION_RECEIVED';
+export declare type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
+export declare type EntryPointType = 'EXTERNAL';
+export declare type CompressedProgram = string;
+export declare type AbiEntry = {
+  name: string;
+  type: 'felt' | 'felt*' | string;
+};
+export declare type FunctionAbi = {
+  inputs: AbiEntry[];
+  name: string;
+  outputs: AbiEntry[];
+  stateMutability?: 'view';
+  type: 'function';
+};
+export declare type StructAbi = {
+  members: (AbiEntry & {
+    offset: number;
+  })[];
+  name: string;
+  size: number;
+  type: 'struct';
+};
+export declare type Abi = Array<FunctionAbi | StructAbi>;
+export declare type EntryPointsByType = object;
+export declare type Program = Record<any, any>;
+export declare type BlockNumber = 'pending' | null | number;
+export declare type CompiledContract = {
+  abi: Abi;
+  entry_points_by_type: EntryPointsByType;
+  program: Program;
+};
+export declare type CompressedCompiledContract = Omit<CompiledContract, 'program'> & {
+  program: CompressedProgram;
+};

package/types/lib.js

@@ -0,0 +1,2 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });

package/types/signer.d.ts

@@ -0,0 +1,4 @@
+import { InvocationsDetails } from './lib';
+export interface InvocationsSignerDetails extends Required<InvocationsDetails> {
+  walletAddress: string;
+}

package/types/signer.js

@@ -0,0 +1,2 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });

package/utils/number.d.ts

@@ -10,3 +10,6 @@ export declare function assertInRange(
   upperBound: BigNumberish,
   inputName?: string
 ): void;
+export declare function bigNumberishArrayToDecimalStringArray(
+  rawCalldata: BigNumberish[]
+): string[];

package/utils/number.js

@@ -5,7 +5,8 @@ var __importDefault =
     return mod && mod.__esModule ? mod : { default: mod };
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.assertInRange =
+exports.bigNumberishArrayToDecimalStringArray =
+  exports.assertInRange =
   exports.hexToDecimalString =
   exports.toHex =
   exports.toBN =
@@ -50,3 +51,9 @@ function assertInRange(input, lowerBound, upperBound, inputName) {
   );
 }
 exports.assertInRange = assertInRange;
+function bigNumberishArrayToDecimalStringArray(rawCalldata) {
+  return rawCalldata.map(function (x) {
+    return toBN(x).toString(10);
+  });
+}
+exports.bigNumberishArrayToDecimalStringArray = bigNumberishArrayToDecimalStringArray;

package/__tests__/signer.test.ts

@@ -1,125 +0,0 @@
-import fs from 'fs';
-
-import typedDataExample from '../__mocks__/typedDataExample.json';
-import {
-  CompiledContract,
-  Contract,
-  Signer,
-  compileCalldata,
-  defaultProvider,
-  ec,
-  json,
-  number,
-  stark,
-} from '../src';
-
-const compiledArgentAccount: CompiledContract = json.parse(
-  fs.readFileSync('./__mocks__/ArgentAccount.json').toString('ascii')
-);
-const compiledErc20: CompiledContract = json.parse(
-  fs.readFileSync('./__mocks__/ERC20.json').toString('ascii')
-);
-
-describe('deploy and test Wallet', () => {
-  const privateKey = stark.randomAddress();
-
-  const starkKeyPair = ec.getKeyPair(privateKey);
-  const starkKeyPub = ec.getStarkKey(starkKeyPair);
-  let walletAddress: string;
-  let erc20: Contract;
-  let erc20Address: string;
-  let signer: Signer;
-
-  beforeAll(async () => {
-    const { code: codeErc20, address: erc20AddressLocal } = await defaultProvider.deployContract(
-      compiledErc20,
-      []
-    );
-    erc20Address = erc20AddressLocal;
-    erc20 = new Contract(compiledErc20.abi, erc20Address);
-
-    expect(codeErc20).toBe('TRANSACTION_RECEIVED');
-
-    const { code, address: walletAddressLocal } = await defaultProvider.deployContract(
-      compiledArgentAccount,
-      compileCalldata({
-        signer: starkKeyPub,
-        guardian: '0',
-        L1_address: '0',
-      }),
-      starkKeyPub
-    );
-    walletAddress = walletAddressLocal;
-    expect(code).toBe('TRANSACTION_RECEIVED');
-
-    const { code: codeErc20Mint, transaction_hash: txErc20Mint } = await erc20.invoke('mint', {
-      recipient: walletAddress,
-      amount: '1000',
-    });
-
-    expect(codeErc20Mint).toBe('TRANSACTION_RECEIVED');
-
-    signer = new Signer(defaultProvider, walletAddressLocal, starkKeyPair);
-
-    await defaultProvider.waitForTx(txErc20Mint);
-  });
-  test('same wallet address', () => {
-    expect(walletAddress).toBe(signer.address);
-  });
-  test('read nonce', async () => {
-    const { result } = await signer.callContract({
-      contract_address: signer.address,
-      entry_point_selector: stark.getSelectorFromName('get_nonce'),
-    });
-    const nonce = result[0];
-
-    expect(number.toBN(nonce).toString()).toStrictEqual(number.toBN(0).toString());
-  });
-  test('read balance of wallet', async () => {
-    const { res } = await erc20.call('balance_of', {
-      user: walletAddress,
-    });
-
-    expect(number.toBN(res as string).toString()).toStrictEqual(number.toBN(1000).toString());
-  });
-  test('execute by wallet owner', async () => {
-    const { code, transaction_hash } = await signer.addTransaction({
-      type: 'INVOKE_FUNCTION',
-      contract_address: erc20Address,
-      entry_point_selector: stark.getSelectorFromName('transfer'),
-      calldata: [erc20Address, '10'],
-    });
-
-    expect(code).toBe('TRANSACTION_RECEIVED');
-    await defaultProvider.waitForTx(transaction_hash);
-  });
-  test('read balance of wallet after transfer', async () => {
-    const { res } = await erc20.call('balance_of', {
-      user: walletAddress,
-    });
-
-    expect(number.toBN(res as string).toString()).toStrictEqual(number.toBN(990).toString());
-  });
-  test('execute with custom nonce', async () => {
-    const { result } = await signer.callContract({
-      contract_address: signer.address,
-      entry_point_selector: stark.getSelectorFromName('get_nonce'),
-    });
-    const nonce = parseInt(result[0], 10);
-    const { code, transaction_hash } = await signer.addTransaction({
-      type: 'INVOKE_FUNCTION',
-      contract_address: erc20Address,
-      entry_point_selector: stark.getSelectorFromName('transfer'),
-      calldata: [erc20Address, '10'],
-      nonce,
-    });
-
-    expect(code).toBe('TRANSACTION_RECEIVED');
-    await defaultProvider.waitForTx(transaction_hash);
-  });
-  test('sign and verify offchain message', async () => {
-    const signature = await signer.signMessage(typedDataExample);
-
-    expect(await signer.verifyMessage(typedDataExample, signature)).toBe(true);
-  });
-});

package/src/types.ts

@@ -1,131 +0,0 @@
-import type { ec as EC } from 'elliptic';
-
-import type { BigNumberish } from './utils/number';
-
-export type KeyPair = EC.KeyPair;
-export type Signature = BigNumberish[];
-
-export type GetContractAddressesResponse = {
-  Starknet: string;
-  GpsStatementVerifier: string;
-};
-
-export type Status =
-  | 'NOT_RECEIVED'
-  | 'RECEIVED'
-  | 'PENDING'
-  | 'ACCEPTED_ON_L2'
-  | 'ACCEPTED_ON_L1'
-  | 'REJECTED';
-export type TransactionStatus = 'TRANSACTION_RECEIVED';
-export type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
-export type EntryPointType = 'EXTERNAL';
-export type CompressedProgram = string;
-
-export type AbiEntry = { name: string; type: 'felt' | 'felt*' | string };
-
-export type FunctionAbi = {
-  inputs: AbiEntry[];
-  name: string;
-  outputs: AbiEntry[];
-  stateMutability?: 'view';
-  type: 'function';
-};
-
-export type StructAbi = {
-  members: (AbiEntry & { offset: number })[];
-  name: string;
-  size: number;
-  type: 'struct';
-};
-
-export type Abi = FunctionAbi | StructAbi;
-
-export type EntryPointsByType = object;
-export type Program = object;
-export type BlockNumber = 'pending' | null | number;
-
-export type CompiledContract = {
-  abi: Abi[];
-  entry_points_by_type: EntryPointsByType;
-  program: Program;
-};
-
-export type CompressedCompiledContract = Omit<CompiledContract, 'program'>;
-
-export type DeployTransaction = {
-  type: 'DEPLOY';
-  contract_definition: CompressedCompiledContract;
-  contract_address_salt: BigNumberish;
-  constructor_calldata: string[];
-  nonce?: BigNumberish;
-};
-
-export type InvokeFunctionTransaction = {
-  type: 'INVOKE_FUNCTION';
-  contract_address: string;
-  signature?: Signature;
-  entry_point_type?: EntryPointType;
-  entry_point_selector: string;
-  calldata?: string[];
-  nonce?: BigNumberish;
-};
-
-export type CallContractTransaction = Omit<InvokeFunctionTransaction, 'type'>;
-
-export type Transaction = DeployTransaction | InvokeFunctionTransaction;
-
-export type CallContractResponse = {
-  result: string[];
-};
-
-export type GetBlockResponse = {
-  block_number: number;
-  state_root: string;
-  block_hash: string;
-  transactions: {
-    [txHash: string]: Transaction;
-  };
-  timestamp: number;
-  transaction_receipts: {
-    [txHash: string]: {
-      block_hash: string;
-      transaction_hash: string;
-      l2_to_l1_messages: {
-        to_address: string;
-        payload: string[];
-        from_address: string;
-      }[];
-      block_number: BlockNumber;
-      status: Status;
-      transaction_index: number;
-    };
-  };
-  previous_block_hash: string;
-  status: Status;
-};
-
-export type GetCodeResponse = {
-  bytecode: string[];
-  abi: Abi[];
-};
-
-export type GetTransactionStatusResponse = {
-  tx_status: Status;
-  block_hash: string;
-};
-
-export type GetTransactionResponse = {
-  status: Status;
-  transaction: Transaction;
-  block_hash: string;
-  block_number: BlockNumber;
-  transaction_index: number;
-  transaction_hash: string;
-};
-
-export type AddTransactionResponse = {
-  code: TransactionStatus;
-  transaction_hash: string;
-  address?: string;
-};

package/types.d.ts

@@ -1,116 +0,0 @@
-import type { ec as EC } from 'elliptic';
-
-import type { BigNumberish } from './utils/number';
-export declare type KeyPair = EC.KeyPair;
-export declare type Signature = BigNumberish[];
-export declare type GetContractAddressesResponse = {
-  Starknet: string;
-  GpsStatementVerifier: string;
-};
-export declare type Status =
-  | 'NOT_RECEIVED'
-  | 'RECEIVED'
-  | 'PENDING'
-  | 'ACCEPTED_ON_L2'
-  | 'ACCEPTED_ON_L1'
-  | 'REJECTED';
-export declare type TransactionStatus = 'TRANSACTION_RECEIVED';
-export declare type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
-export declare type EntryPointType = 'EXTERNAL';
-export declare type CompressedProgram = string;
-export declare type AbiEntry = {
-  name: string;
-  type: 'felt' | 'felt*' | string;
-};
-export declare type FunctionAbi = {
-  inputs: AbiEntry[];
-  name: string;
-  outputs: AbiEntry[];
-  stateMutability?: 'view';
-  type: 'function';
-};
-export declare type StructAbi = {
-  members: (AbiEntry & {
-    offset: number;
-  })[];
-  name: string;
-  size: number;
-  type: 'struct';
-};
-export declare type Abi = FunctionAbi | StructAbi;
-export declare type EntryPointsByType = object;
-export declare type Program = object;
-export declare type BlockNumber = 'pending' | null | number;
-export declare type CompiledContract = {
-  abi: Abi[];
-  entry_points_by_type: EntryPointsByType;
-  program: Program;
-};
-export declare type CompressedCompiledContract = Omit<CompiledContract, 'program'>;
-export declare type DeployTransaction = {
-  type: 'DEPLOY';
-  contract_definition: CompressedCompiledContract;
-  contract_address_salt: BigNumberish;
-  constructor_calldata: string[];
-  nonce?: BigNumberish;
-};
-export declare type InvokeFunctionTransaction = {
-  type: 'INVOKE_FUNCTION';
-  contract_address: string;
-  signature?: Signature;
-  entry_point_type?: EntryPointType;
-  entry_point_selector: string;
-  calldata?: string[];
-  nonce?: BigNumberish;
-};
-export declare type CallContractTransaction = Omit<InvokeFunctionTransaction, 'type'>;
-export declare type Transaction = DeployTransaction | InvokeFunctionTransaction;
-export declare type CallContractResponse = {
-  result: string[];
-};
-export declare type GetBlockResponse = {
-  block_number: number;
-  state_root: string;
-  block_hash: string;
-  transactions: {
-    [txHash: string]: Transaction;
-  };
-  timestamp: number;
-  transaction_receipts: {
-    [txHash: string]: {
-      block_hash: string;
-      transaction_hash: string;
-      l2_to_l1_messages: {
-        to_address: string;
-        payload: string[];
-        from_address: string;
-      }[];
-      block_number: BlockNumber;
-      status: Status;
-      transaction_index: number;
-    };
-  };
-  previous_block_hash: string;
-  status: Status;
-};
-export declare type GetCodeResponse = {
-  bytecode: string[];
-  abi: Abi[];
-};
-export declare type GetTransactionStatusResponse = {
-  tx_status: Status;
-  block_hash: string;
-};
-export declare type GetTransactionResponse = {
-  status: Status;
-  transaction: Transaction;
-  block_hash: string;
-  block_number: BlockNumber;
-  transaction_index: number;
-  transaction_hash: string;
-};
-export declare type AddTransactionResponse = {
-  code: TransactionStatus;
-  transaction_hash: string;
-  address?: string;
-};