starknet 2.3.1 → 2.7.0

package/CHANGELOG.md

@@ -1,3 +1,46 @@
+# [2.7.0](https://github.com/seanjameshan/starknet.js/compare/v2.6.0...v2.7.0) (2022-01-03)
+
+### Bug Fixes
+
+- add response to the waitForTx error ([e25bdfd](https://github.com/seanjameshan/starknet.js/commit/e25bdfd428fd36e105ed272ea39462845bae5805))
+
+### Features
+
+- **blockHash:** add blockHash and fix test cases ([4e107eb](https://github.com/seanjameshan/starknet.js/commit/4e107eb7e97a9b8d2efd74b2074a7d82365c932e))
+
+# [2.6.0](https://github.com/seanjameshan/starknet.js/compare/v2.5.0...v2.6.0) (2021-12-29)
+
+### Bug Fixes
+
+- correct network name ([66e14c9](https://github.com/seanjameshan/starknet.js/commit/66e14c926f015a2dfbd50d3e54ba4e008fb43aa8))
+- network name ([965f215](https://github.com/seanjameshan/starknet.js/commit/965f21580ef68bf84c105e93bfb3b98f75b31f93))
+
+### Features
+
+- introduce blockNumber ([657dac1](https://github.com/seanjameshan/starknet.js/commit/657dac1d77e840a7fc663d3a180515443a7e834f))
+
+# [2.5.0](https://github.com/seanjameshan/starknet.js/compare/v2.4.0...v2.5.0) (2021-12-13)
+
+### Bug Fixes
+
+- add jsdoc comment ([4cd969f](https://github.com/seanjameshan/starknet.js/commit/4cd969f82eb4a5d8c08feb59c42fb3e7195af50e))
+- remove eip712 reference ([039a360](https://github.com/seanjameshan/starknet.js/commit/039a360873f9a1cdedc7a498b6e1732183957143))
+- remove unused types ([e528f7d](https://github.com/seanjameshan/starknet.js/commit/e528f7d75f4560d2affe3ca99426e01fbee6dfb5))
+- review ([a3813c9](https://github.com/seanjameshan/starknet.js/commit/a3813c9931c178d58c2521b926fb3fdff6944635))
+
+### Features
+
+- add `getKeyPairFromPublicKey` method ([66d543d](https://github.com/seanjameshan/starknet.js/commit/66d543dca1bb302654f0f1588a27f7794bfa49be))
+- add tests ([b414a83](https://github.com/seanjameshan/starknet.js/commit/b414a839a1fdd56084a58d6efb4747e8f5455628))
+- allow multi sig ([fc1e086](https://github.com/seanjameshan/starknet.js/commit/fc1e0866154d2bf29f26374639a34fec438bae5e))
+- support eip712 for starknet ([d597082](https://github.com/seanjameshan/starknet.js/commit/d59708211fc497d801699a7168dad1a5cc9648fd))
+
+# [2.4.0](https://github.com/seanjameshan/starknet.js/compare/v2.3.1...v2.4.0) (2021-12-09)
+
+### Features
+
+- allow custom nonce ([17666de](https://github.com/seanjameshan/starknet.js/commit/17666de94db6875bbf8e88555773b8862a4a32cf))
+
 ## [2.3.1](https://github.com/seanjameshan/starknet.js/compare/v2.3.0...v2.3.1) (2021-12-01)
 
 ### Bug Fixes

package/__tests__/account.test.ts

@@ -104,7 +104,7 @@ describe('deploy and test Wallet', () => {
       )
     );
 
-    const { r, s } = ec.sign(starkKeyPair, msgHash);
+    const signature = ec.sign(starkKeyPair, msgHash);
     const { code, transaction_hash } = await wallet.invoke(
       'execute',
       {
@@ -113,7 +113,7 @@ describe('deploy and test Wallet', () => {
         calldata: [erc20Address, '10'],
         nonce: nonce.toString(),
       },
-      [number.toHex(r), number.toHex(s)]
+      signature
     );
 
     expect(code).toBe('TRANSACTION_RECEIVED');
@@ -151,7 +151,7 @@ test('build tx', async () => {
       .toString()
   );
 
-  const { r, s } = ec.sign(keyPair, msgHash);
+  const [r, s] = ec.sign(keyPair, msgHash);
   expect(r.toString()).toBe(
     '706800951915233622090196542158919402159816118214143837213294331713137614072'
   );

package/__tests__/provider.test.ts

@@ -13,38 +13,49 @@ describe('defaultProvider', () => {
       expect(typeof GpsStatementVerifier).toBe('string');
       expect(typeof Starknet).toBe('string');
     });
-    test('getBlock()', () => {
-      return expect(defaultProvider.getBlock(870)).resolves.not.toThrow();
+    test('getBlock(blockHash=0x3bca19c3d5983e21e9537669b15f951f0664f0747a083dc714e0b9648b8575d, blockNumber=undefined)', () => {
+      return expect(
+        defaultProvider.getBlock(
+          '0x3bca19c3d5983e21e9537669b15f951f0664f0747a083dc714e0b9648b8575d'
+        )
+      ).resolves.not.toThrow();
     });
-    test('getBlock(blockId=null)', () => {
+    test('getBlock(blockHash=undefined, blockNumber=36657)', () => {
+      return expect(defaultProvider.getBlock(undefined, 36657)).resolves.not.toThrow();
+    });
+    test('getBlock(blockHash=undefined, blockNumber=null)', () => {
       return expect(defaultProvider.getBlock()).resolves.not.toThrow();
     });
     test('getCode()', () => {
       return expect(
         defaultProvider.getCode(
-          '0x163a1542a64402ffc93e39a4962eec51ce126f2e634631d3f1f6770a76e3a61',
-          870
+          '0x01d1f307c073bb786a66e6e042ec2a9bdc385a3373bb3738d95b966d5ce56166',
+          undefined,
+          36663
         )
       ).resolves.not.toThrow();
     });
-    test('getCode(blockId=null)', () => {
+    test('getCode(blockHash=undefined, blockNumber=null)', () => {
       return expect(
-        defaultProvider.getCode('0x163a1542a64402ffc93e39a4962eec51ce126f2e634631d3f1f6770a76e3a61')
+        defaultProvider.getCode(
+          '0x01d1f307c073bb786a66e6e042ec2a9bdc385a3373bb3738d95b966d5ce56166'
+        )
       ).resolves.not.toThrow();
     });
     test('getStorageAt()', () => {
       return expect(
         defaultProvider.getStorageAt(
-          '0x163a1542a64402ffc93e39a4962eec51ce126f2e634631d3f1f6770a76e3a61',
+          '0x01d1f307c073bb786a66e6e042ec2a9bdc385a3373bb3738d95b966d5ce56166',
           0,
-          870
+          undefined,
+          36663
         )
       ).resolves.not.toThrow();
     });
-    test('getStorageAt(blockId=null)', () => {
+    test('getStorageAt(blockHash=undefined, blockNumber=null)', () => {
       return expect(
         defaultProvider.getStorageAt(
-          '0x163a1542a64402ffc93e39a4962eec51ce126f2e634631d3f1f6770a76e3a61',
+          '0x01d1f307c073bb786a66e6e042ec2a9bdc385a3373bb3738d95b966d5ce56166',
           0
         )
       ).resolves.not.toThrow();
@@ -52,14 +63,14 @@ describe('defaultProvider', () => {
     test('getTransactionStatus()', async () => {
       return expect(
         defaultProvider.getTransactionStatus(
-          '0x72add9621ecdcb07405a4f943fe410bf57003ca250400f01ce70f8a6fc72147'
+          '0x37013e1cb9c133e6fe51b4b371b76b317a480f56d80576730754c1662582348'
         )
       ).resolves.not.toThrow();
     });
     test('getTransaction()', async () => {
       return expect(
         defaultProvider.getTransaction(
-          '0x72add9621ecdcb07405a4f943fe410bf57003ca250400f01ce70f8a6fc72147'
+          '0x37013e1cb9c133e6fe51b4b371b76b317a480f56d80576730754c1662582348'
         )
       ).resolves.not.toThrow();
     });

package/__tests__/signer.test.ts

@@ -99,4 +99,21 @@ describe('deploy and test Wallet', () => {
 
     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);
+  });
 });

package/__tests__/utils/ellipticalCurve.test.ts

@@ -40,7 +40,7 @@ test('hashMessage()', () => {
   );
   expect(hashMsg).toBe('0x7f15c38ea577a26f4f553282fcfe4f1feeb8ecfaad8f221ae41abf8224cbddd');
   const keyPair = getKeyPair(privateKey);
-  const { r, s } = sign(keyPair, removeHexPrefix(hashMsg));
+  const [r, s] = sign(keyPair, removeHexPrefix(hashMsg));
   expect(r.toString()).toStrictEqual(
     toBN('2458502865976494910213617956670505342647705497324144349552978333078363662855').toString()
   );

package/__tests__/utils/typedData.test.ts

@@ -0,0 +1,72 @@
+import { encodeType, getMessageHash, getStructHash, getTypeHash } from '../../src/utils/typedData';
+
+const typedDataExample = {
+  types: {
+    StarkNetDomain: [
+      { name: 'name', type: 'felt' },
+      { name: 'version', type: 'felt' },
+      { name: 'chainId', type: 'felt' },
+    ],
+    Person: [
+      { name: 'name', type: 'felt' },
+      { name: 'wallet', type: 'felt' },
+    ],
+    Mail: [
+      { name: 'from', type: 'Person' },
+      { name: 'to', type: 'Person' },
+      { name: 'contents', type: 'felt' },
+    ],
+  },
+  primaryType: 'Mail',
+  domain: {
+    name: 'StarkNet Mail',
+    version: '1',
+    chainId: 1,
+  },
+  message: {
+    from: {
+      name: 'Cow',
+      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
+    },
+    to: {
+      name: 'Bob',
+      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
+    },
+    contents: 'Hello, Bob!',
+  },
+};
+
+describe('typedData', () => {
+  test('should get right type encoding', () => {
+    const typeEncoding = encodeType(typedDataExample, 'Mail');
+    expect(typeEncoding).toMatchInlineSnapshot(
+      `"Mail(from:Person,to:Person,contents:felt)Person(name:felt,wallet:felt)"`
+    );
+  });
+  test('should get right type hash', () => {
+    const typeHashDomain = getTypeHash(typedDataExample, 'StarkNetDomain');
+    expect(typeHashDomain).toMatchInlineSnapshot(
+      `"0x1bfc207425a47a5dfa1a50a4f5241203f50624ca5fdf5e18755765416b8e288"`
+    );
+    const typeHashPerson = getTypeHash(typedDataExample, 'Person');
+    expect(typeHashPerson).toMatchInlineSnapshot(
+      `"0x2896dbe4b96a67110f454c01e5336edc5bbc3635537efd690f122f4809cc855"`
+    );
+    const typeHashMail = getTypeHash(typedDataExample, 'Mail');
+    expect(typeHashMail).toMatchInlineSnapshot(
+      `"0x13d89452df9512bf750f539ba3001b945576243288137ddb6c788457d4b2f79"`
+    );
+  });
+  test('should get right hash for StarkNetDomain', () => {
+    const hash = getStructHash(typedDataExample, 'StarkNetDomain', typedDataExample.domain as any);
+    expect(hash).toMatchInlineSnapshot(
+      `"0x54833b121883a3e3aebff48ec08a962f5742e5f7b973469c1f8f4f55d470b07"`
+    );
+  });
+  test('should get right hash for entire message', () => {
+    const hash = getMessageHash(typedDataExample, '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826');
+    expect(hash).toMatchInlineSnapshot(
+      `"0x6fcff244f63e38b9d88b9e3378d44757710d1b244282b435cb472053c8d78d0"`
+    );
+  });
+});

package/contract.d.ts

@@ -1,5 +1,5 @@
 import { Provider } from './provider';
-import { Abi, StructAbi } from './types';
+import { Abi, Signature, StructAbi } from './types';
 import { BigNumberish } from './utils/number';
 export declare type Args = {
   [inputName: string]:
@@ -33,7 +33,7 @@ export declare class Contract {
   invoke(
     method: string,
     args?: Args,
-    signature?: [BigNumberish, BigNumberish]
+    signature?: Signature
   ): Promise<import('./types').AddTransactionResponse>;
   call(method: string, args?: Args): Promise<Args>;
 }

package/dist/contract.d.ts

@@ -1,5 +1,5 @@
 import { Provider } from './provider';
-import { Abi, StructAbi } from './types';
+import { Abi, Signature, StructAbi } from './types';
 import { BigNumberish } from './utils/number';
 export declare type Args = {
     [inputName: string]: string | string[] | {
@@ -27,6 +27,6 @@ export declare class Contract {
     private validateMethodAndArgs;
     private parseResponseField;
     private parseResponse;
-    invoke(method: string, args?: Args, signature?: [BigNumberish, BigNumberish]): Promise<import("./types").AddTransactionResponse>;
+    invoke(method: string, args?: Args, signature?: Signature): Promise<import("./types").AddTransactionResponse>;
     call(method: string, args?: Args): Promise<Args>;
 }

package/dist/index.d.ts

@@ -17,3 +17,4 @@ export * as stark from './utils/stark';
 export * as ec from './utils/ellipticCurve';
 export * as uint256 from './utils/uint256';
 export * as shortString from './utils/shortString';
+export * as typedData from './utils/typedData';

package/dist/index.js

@@ -22,7 +22,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.shortString = exports.uint256 = exports.ec = exports.stark = exports.number = exports.json = exports.hash = exports.encode = exports.constants = void 0;
+exports.typedData = exports.shortString = exports.uint256 = exports.ec = exports.stark = exports.number = exports.json = exports.hash = exports.encode = exports.constants = void 0;
 /**
  * Main
  */
@@ -42,3 +42,4 @@ exports.stark = __importStar(require("./utils/stark"));
 exports.ec = __importStar(require("./utils/ellipticCurve"));
 exports.uint256 = __importStar(require("./utils/uint256"));
 exports.shortString = __importStar(require("./utils/shortString"));
+exports.typedData = __importStar(require("./utils/typedData"));

package/dist/provider/default.d.ts

@@ -1,7 +1,7 @@
-import { AddTransactionResponse, CallContractResponse, CallContractTransaction, CompiledContract, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, Transaction } from '../types';
+import { AddTransactionResponse, BlockNumber, CallContractResponse, CallContractTransaction, CompiledContract, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, Signature, Transaction } from '../types';
 import { BigNumberish } from '../utils/number';
 import { ProviderInterface } from './interface';
-declare type NetworkName = 'mainnet-alpha' | 'georli-alpha';
+declare type NetworkName = 'mainnet-alpha' | 'goerli-alpha';
 declare type ProviderOptions = {
     network: NetworkName;
 } | {
@@ -23,50 +23,54 @@ export declare class Provider implements ProviderInterface {
     /**
      * Calls a function on the StarkNet contract.
      *
-     * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L17-L25)
+     * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L25-L39)
      *
-     * @param invokeTx - transaction to be invoked
-     * @param blockId
+     * @param invokeTransaction - transaction to be invoked
+     * @param blockHash
+     * @param blockNumber
      * @returns the result of the function on the smart contract.
      */
-    callContract(invokeTx: CallContractTransaction, blockId?: number): Promise<CallContractResponse>;
+    callContract(invokeTransaction: CallContractTransaction, blockHash?: BigNumberish, blockNumber?: BlockNumber): Promise<CallContractResponse>;
     /**
-     * Gets the block information from a block ID.
+     * Gets the block information
      *
-     * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L27-L31)
+     * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L41-L53)
      *
-     * @param blockId
-     * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
+     * @param blockHash
+     * @param blockNumber
+     * @returns the block object { block_number, previous_block_number, state_root, status, timestamp, transaction_receipts, transactions }
      */
-    getBlock(blockId?: number): Promise<GetBlockResponse>;
+    getBlock(blockHash?: BigNumberish, blockNumber?: BlockNumber): Promise<GetBlockResponse>;
     /**
      * Gets the code of the deployed contract.
      *
-     * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L33-L36)
+     * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L55-L68)
      *
      * @param contractAddress
-     * @param blockId
+     * @param blockHash
+     * @param blockNumber
      * @returns Bytecode and ABI of compiled contract
      */
-    getCode(contractAddress: string, blockId?: number): Promise<GetCodeResponse>;
+    getCode(contractAddress: string, blockHash?: BigNumberish, blockNumber?: BlockNumber): Promise<GetCodeResponse>;
     /**
      * Gets the contract's storage variable at a specific key.
      *
-     * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L38-L46)
+     * [Reference](https://github.com/starkware-libs/cairo-lang/blob/fc97bdd8322a7df043c87c371634b26c15ed6cee/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L70-L85)
      *
      * @param contractAddress
      * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
-     * @param blockId
+     * @param blockHash
+     * @param blockNumber
      * @returns the value of the storage variable
      */
-    getStorageAt(contractAddress: string, key: number, blockId?: number): Promise<object>;
+    getStorageAt(contractAddress: string, key: number, blockHash?: BigNumberish, blockNumber?: BlockNumber): Promise<object>;
     /**
      * Gets the status of a transaction.
      *
      * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L48-L52)
      *
      * @param txHash
-     * @returns the transaction status object { block_id, tx_status: NOT_RECEIVED | RECEIVED | PENDING | REJECTED | ACCEPTED_ONCHAIN }
+     * @returns the transaction status object { block_number, tx_status: NOT_RECEIVED | RECEIVED | PENDING | REJECTED | ACCEPTED_ONCHAIN }
      */
     getTransactionStatus(txHash: BigNumberish): Promise<GetTransactionStatusResponse>;
     /**
@@ -75,7 +79,7 @@ export declare class Provider implements ProviderInterface {
      * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L54-L58)
      *
      * @param txHash
-     * @returns the transacton object { transaction_id, status, transaction, block_id?, block_number?, transaction_index?, transaction_failure_reason? }
+     * @returns the transacton object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
      */
     getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
     /**
@@ -83,10 +87,10 @@ export declare class Provider implements ProviderInterface {
      *
      * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/gateway/gateway_client.py#L13-L17)
      *
-     * @param tx - transaction to be invoked
+     * @param transaction - transaction to be invoked
      * @returns a confirmation of invoking a function on the starknet contract
      */
-    addTransaction(tx: Transaction): Promise<AddTransactionResponse>;
+    addTransaction(transaction: Transaction): Promise<AddTransactionResponse>;
     /**
      * Deploys a given compiled contract (json) to starknet
      *
@@ -104,7 +108,7 @@ export declare class Provider implements ProviderInterface {
      * @param signature - (optional) signature to send along
      * @returns response from addTransaction
      */
-    invokeFunction(contractAddress: string, entrypointSelector: string, calldata?: string[], signature?: [BigNumberish, BigNumberish]): Promise<AddTransactionResponse>;
+    invokeFunction(contractAddress: string, entrypointSelector: string, calldata?: string[], signature?: Signature): Promise<AddTransactionResponse>;
     waitForTx(txHash: BigNumberish, retryInterval?: number): Promise<void>;
 }
 export {};