starknet 2.3.0 → 2.6.0

package/CHANGELOG.md

@@ -1,3 +1,45 @@
+# [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
+
+- allow structs in calldata ([fd2bdc0](https://github.com/seanjameshan/starknet.js/commit/fd2bdc0a1756544e4162fa5baaa7d3aec6f97bee))
+- struct compiling ([84617ae](https://github.com/seanjameshan/starknet.js/commit/84617aefe1218f421ca446b2a3c9959252d326e6))
+- struct data ([313dff5](https://github.com/seanjameshan/starknet.js/commit/313dff57f54050747c65b32b3378762c349d9c8c))
+- uint256 type ([2e05902](https://github.com/seanjameshan/starknet.js/commit/2e05902268f76bda2ae9b4e75782fa78876c2f00))
+
 # [2.3.0](https://github.com/seanjameshan/starknet.js/compare/v2.2.0...v2.3.0) (2021-12-01)
 
 ### Features

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

@@ -16,7 +16,7 @@ describe('defaultProvider', () => {
     test('getBlock()', () => {
       return expect(defaultProvider.getBlock(870)).resolves.not.toThrow();
     });
-    test('getBlock(blockId=null)', () => {
+    test('getBlock(blockNumber=null)', () => {
       return expect(defaultProvider.getBlock()).resolves.not.toThrow();
     });
     test('getCode()', () => {
@@ -27,7 +27,7 @@ describe('defaultProvider', () => {
         )
       ).resolves.not.toThrow();
     });
-    test('getCode(blockId=null)', () => {
+    test('getCode(blockNumber=null)', () => {
       return expect(
         defaultProvider.getCode('0x163a1542a64402ffc93e39a4962eec51ce126f2e634631d3f1f6770a76e3a61')
       ).resolves.not.toThrow();
@@ -41,7 +41,7 @@ describe('defaultProvider', () => {
         )
       ).resolves.not.toThrow();
     });
-    test('getStorageAt(blockId=null)', () => {
+    test('getStorageAt(blockNumber=null)', () => {
       return expect(
         defaultProvider.getStorageAt(
           '0x163a1542a64402ffc93e39a4962eec51ce126f2e634631d3f1f6770a76e3a61',

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,8 +1,14 @@
 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[];
+  [inputName: string]:
+    | string
+    | string[]
+    | {
+        type: 'struct';
+        [k: string]: BigNumberish;
+      };
 };
 export declare type Calldata = string[];
 export declare function compileCalldata(args: Args): Calldata;
@@ -27,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/contract.js

@@ -216,6 +216,18 @@ function compileCalldata(args) {
         ),
         false
       );
+    if (typeof value === 'object' && 'type' in value)
+      return Object.entries(value)
+        .filter(function (_a) {
+          var _b = __read(_a, 1),
+            k = _b[0];
+          return k !== 'type';
+        })
+        .map(function (_a) {
+          var _b = __read(_a, 2),
+            v = _b[1];
+          return (0, number_1.toBN)(v).toString();
+        });
     return (0, number_1.toBN)(value).toString();
   });
 }
@@ -274,22 +286,28 @@ var Contract = /** @class */ (function () {
       return abi.name === method && abi.type === 'function';
     });
     methodAbi.inputs.forEach(function (input) {
-      if (args[input.name] !== undefined) {
+      var arg = args[input.name];
+      if (arg !== undefined) {
         if (input.type === 'felt') {
           (0, minimalistic_assert_1.default)(
-            typeof args[input.name] === 'string',
+            typeof arg === 'string',
             'arg ' + input.name + ' should be a felt (string)'
           );
           (0, minimalistic_assert_1.default)(
-            isFelt(args[input.name]),
+            isFelt(arg),
             'arg ' + input.name + ' should be decimal or hexadecimal'
           );
+        } else if (typeof arg === 'object' && 'type' in arg) {
+          (0, minimalistic_assert_1.default)(
+            arg.type === 'struct',
+            'arg ' + input.name + ' should be a struct'
+          );
         } else {
           (0, minimalistic_assert_1.default)(
-            Array.isArray(args[input.name]),
+            Array.isArray(arg),
             'arg ' + input.name + ' should be a felt* (string[])'
           );
-          args[input.name].forEach(function (felt, i) {
+          arg.forEach(function (felt, i) {
             (0,
             minimalistic_assert_1.default)(typeof felt === 'string', 'arg ' + input.name + '[' + i + '] should be a felt (string) as part of a felt* (string[])');
             (0,

package/dist/contract.d.ts

@@ -1,8 +1,11 @@
 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[];
+    [inputName: string]: string | string[] | {
+        type: 'struct';
+        [k: string]: BigNumberish;
+    };
 };
 export declare type Calldata = string[];
 export declare function compileCalldata(args: Args): Calldata;
@@ -24,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/contract.js

@@ -101,6 +101,16 @@ function compileCalldata(args) {
     return Object.values(args).flatMap(function (value) {
         if (Array.isArray(value))
             return __spreadArray([(0, number_1.toBN)(value.length).toString()], __read(value.map(function (x) { return (0, number_1.toBN)(x).toString(); })), false);
+        if (typeof value === 'object' && 'type' in value)
+            return Object.entries(value)
+                .filter(function (_a) {
+                var _b = __read(_a, 1), k = _b[0];
+                return k !== 'type';
+            })
+                .map(function (_a) {
+                var _b = __read(_a, 2), v = _b[1];
+                return (0, number_1.toBN)(v).toString();
+            });
         return (0, number_1.toBN)(value).toString();
     });
 }
@@ -145,14 +155,18 @@ var Contract = /** @class */ (function () {
         // ensure args match abi type
         var methodAbi = this.abi.find(function (abi) { return abi.name === method && abi.type === 'function'; });
         methodAbi.inputs.forEach(function (input) {
-            if (args[input.name] !== undefined) {
+            var arg = args[input.name];
+            if (arg !== undefined) {
                 if (input.type === 'felt') {
-                    (0, minimalistic_assert_1.default)(typeof args[input.name] === 'string', "arg " + input.name + " should be a felt (string)");
-                    (0, minimalistic_assert_1.default)(isFelt(args[input.name]), "arg " + input.name + " should be decimal or hexadecimal");
+                    (0, minimalistic_assert_1.default)(typeof arg === 'string', "arg " + input.name + " should be a felt (string)");
+                    (0, minimalistic_assert_1.default)(isFelt(arg), "arg " + input.name + " should be decimal or hexadecimal");
+                }
+                else if (typeof arg === 'object' && 'type' in arg) {
+                    (0, minimalistic_assert_1.default)(arg.type === 'struct', "arg " + input.name + " should be a struct");
                 }
                 else {
-                    (0, minimalistic_assert_1.default)(Array.isArray(args[input.name]), "arg " + input.name + " should be a felt* (string[])");
-                    args[input.name].forEach(function (felt, i) {
+                    (0, minimalistic_assert_1.default)(Array.isArray(arg), "arg " + input.name + " should be a felt* (string[])");
+                    arg.forEach(function (felt, i) {
                         (0, minimalistic_assert_1.default)(typeof felt === 'string', "arg " + input.name + "[" + i + "] should be a felt (string) as part of a felt* (string[])");
                         (0, minimalistic_assert_1.default)(isFelt(felt), "arg " + input.name + "[" + i + "] should be decimal or hexadecimal as part of a felt* (string[])");
                     });

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;
 } | {
@@ -25,30 +25,30 @@ 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#L17-L25)
      *
-     * @param invokeTx - transaction to be invoked
-     * @param blockId
+     * @param invokeTransaction - transaction to be invoked
+     * @param blockNumber
      * @returns the result of the function on the smart contract.
      */
-    callContract(invokeTx: CallContractTransaction, blockId?: number): Promise<CallContractResponse>;
+    callContract(invokeTransaction: CallContractTransaction, blockNumber?: BlockNumber): Promise<CallContractResponse>;
     /**
      * Gets the block information from a block ID.
      *
      * [Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L27-L31)
      *
-     * @param blockId
-     * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
+     * @param blockNumber
+     * @returns the block object { block_number, previous_block_number, state_root, status, timestamp, transaction_receipts, transactions }
      */
-    getBlock(blockId?: number): Promise<GetBlockResponse>;
+    getBlock(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)
      *
      * @param contractAddress
-     * @param blockId
+     * @param blockNumber
      * @returns Bytecode and ABI of compiled contract
      */
-    getCode(contractAddress: string, blockId?: number): Promise<GetCodeResponse>;
+    getCode(contractAddress: string, blockNumber?: BlockNumber): Promise<GetCodeResponse>;
     /**
      * Gets the contract's storage variable at a specific key.
      *
@@ -56,17 +56,17 @@ export declare class Provider implements ProviderInterface {
      *
      * @param contractAddress
      * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
-     * @param blockId
+     * @param blockNumber
      * @returns the value of the storage variable
      */
-    getStorageAt(contractAddress: string, key: number, blockId?: number): Promise<object>;
+    getStorageAt(contractAddress: string, key: number, 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 +75,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 +83,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 +104,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 {};