starknet 3.1.0 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/__mocks__/ArgentAccount.json +68548 -51944
  3. package/__mocks__/TestDapp.json +12962 -0
  4. package/__tests__/account.test.ts +61 -48
  5. package/__tests__/accountContract.test.ts +50 -70
  6. package/__tests__/contract.test.ts +28 -16
  7. package/__tests__/fixtures.ts +13 -0
  8. package/__tests__/provider.test.ts +3 -15
  9. package/__tests__/utils/__snapshots__/utils.browser.test.ts.snap +2 -2
  10. package/__tests__/utils/__snapshots__/utils.test.ts.snap +2 -2
  11. package/__tests__/utils/ellipticalCurve.test.ts +20 -13
  12. package/__tests__/utils/utils.test.ts +3 -3
  13. package/account/default.d.ts +4 -4
  14. package/account/default.js +42 -90
  15. package/account/interface.d.ts +2 -2
  16. package/dist/account/default.d.ts +3 -3
  17. package/dist/account/default.js +30 -55
  18. package/dist/account/interface.d.ts +2 -2
  19. package/dist/index.d.ts +1 -0
  20. package/dist/index.js +1 -0
  21. package/dist/provider/default.js +28 -12
  22. package/dist/signer/default.d.ts +1 -1
  23. package/dist/signer/default.js +6 -18
  24. package/dist/signer/interface.d.ts +3 -2
  25. package/dist/types/api.d.ts +5 -0
  26. package/dist/types/lib.d.ts +3 -3
  27. package/dist/utils/ellipticCurve.js +1 -1
  28. package/dist/utils/hash.d.ts +12 -2
  29. package/dist/utils/hash.js +37 -9
  30. package/dist/utils/stark.d.ts +0 -8
  31. package/dist/utils/stark.js +1 -14
  32. package/dist/utils/transaction.d.ts +19 -0
  33. package/dist/utils/transaction.js +75 -0
  34. package/dist/utils/typedData/index.d.ts +1 -1
  35. package/dist/utils/typedData/index.js +2 -3
  36. package/index.d.ts +1 -0
  37. package/index.js +1 -0
  38. package/package.json +1 -1
  39. package/provider/default.js +39 -14
  40. package/signer/default.d.ts +1 -1
  41. package/signer/default.js +10 -44
  42. package/signer/interface.d.ts +3 -2
  43. package/src/account/default.ts +21 -42
  44. package/src/account/interface.ts +2 -2
  45. package/src/index.ts +1 -0
  46. package/src/provider/default.ts +22 -17
  47. package/src/signer/default.ts +10 -26
  48. package/src/signer/interface.ts +3 -2
  49. package/src/types/api.ts +5 -0
  50. package/src/types/lib.ts +3 -4
  51. package/src/utils/ellipticCurve.ts +1 -1
  52. package/src/utils/hash.ts +39 -12
  53. package/src/utils/stark.ts +1 -14
  54. package/src/utils/transaction.ts +50 -0
  55. package/src/utils/typedData/index.ts +2 -3
  56. package/types/api.d.ts +5 -0
  57. package/types/lib.d.ts +3 -3
  58. package/utils/ellipticCurve.js +1 -1
  59. package/utils/hash.d.ts +15 -6
  60. package/utils/hash.js +42 -10
  61. package/utils/stark.d.ts +0 -8
  62. package/utils/stark.js +0 -14
  63. package/utils/transaction.d.ts +19 -0
  64. package/utils/transaction.js +99 -0
  65. package/utils/typedData/index.d.ts +1 -1
  66. package/utils/typedData/index.js +2 -3
@@ -3,13 +3,15 @@ import { Signer, SignerInterface } from '../signer';
3
3
  import {
4
4
  Abi,
5
5
  AddTransactionResponse,
6
- ExecuteInvocation,
6
+ Call,
7
7
  InvocationsDetails,
8
8
  KeyPair,
9
9
  Signature,
10
10
  } from '../types';
11
+ import { getSelectorFromName } from '../utils/hash';
11
12
  import { BigNumberish, bigNumberishArrayToDecimalStringArray, toBN, toHex } from '../utils/number';
12
- import { compileCalldata, getSelectorFromName } from '../utils/stark';
13
+ import { compileCalldata } from '../utils/stark';
14
+ import { fromCallsToExecuteCalldata } from '../utils/transaction';
13
15
  import { TypedData, getMessageHash } from '../utils/typedData';
14
16
  import { AccountInterface } from './interface';
15
17
 
@@ -41,51 +43,28 @@ export class Account extends Provider implements AccountInterface {
41
43
  * @returns a confirmation of invoking a function on the starknet contract
42
44
  */
43
45
  public async execute(
44
- transactions: ExecuteInvocation | ExecuteInvocation[],
45
- abis: Abi[] = [],
46
+ calls: Call | Call[],
47
+ abis: Abi[] | undefined = undefined,
46
48
  transactionsDetail: InvocationsDetails = {}
47
49
  ): Promise<AddTransactionResponse> {
48
- if (Array.isArray(transactions) && transactions.length !== 1) {
49
- throw new Error('Only one transaction at a time is currently supported');
50
- }
51
-
52
- const {
53
- contractAddress,
54
- calldata = [],
55
- entrypoint,
56
- ...invocation
57
- } = Array.isArray(transactions) ? transactions[0] : transactions;
58
- const { nonce } = transactionsDetail;
50
+ const transactions = Array.isArray(calls) ? calls : [calls];
59
51
 
60
- const nonceBn = toBN(nonce ?? (await this.getNonce()));
61
- const calldataDecimal = bigNumberishArrayToDecimalStringArray(calldata);
52
+ const signerDetails = {
53
+ walletAddress: this.address,
54
+ nonce: toBN(transactionsDetail.nonce ?? (await this.getNonce())),
55
+ maxFee: toBN(transactionsDetail.maxFee ?? '0'),
56
+ };
62
57
 
63
- const signature = await this.signer.signTransaction(
64
- [
65
- {
66
- ...invocation,
67
- contractAddress,
68
- calldata: calldataDecimal,
69
- entrypoint,
70
- },
71
- ],
72
- { walletAddress: this.address, nonce: nonceBn },
73
- abis
74
- );
58
+ const signature = await this.signer.signTransaction(transactions, signerDetails, abis);
75
59
 
76
- const entrypointSelector = getSelectorFromName(entrypoint);
60
+ const calldata = [...fromCallsToExecuteCalldata(transactions), signerDetails.nonce.toString()];
77
61
 
78
- return super.invokeFunction({
79
- contractAddress: this.address,
80
- entrypoint: 'execute',
81
- calldata: [
82
- contractAddress,
83
- entrypointSelector,
84
- calldataDecimal.length.toString(),
85
- ...calldataDecimal,
86
- nonceBn.toString(),
87
- ],
88
- signature,
62
+ return this.fetchEndpoint('add_transaction', undefined, {
63
+ type: 'INVOKE_FUNCTION',
64
+ contract_address: this.address,
65
+ entry_point_selector: getSelectorFromName('__execute__'),
66
+ calldata,
67
+ signature: bigNumberishArrayToDecimalStringArray(signature),
89
68
  });
90
69
  }
91
70
 
@@ -114,7 +93,7 @@ export class Account extends Provider implements AccountInterface {
114
93
  /**
115
94
  * Verify a signature of a JSON object
116
95
  *
117
- * @param json - JSON object to be verified
96
+ * @param hash - JSON object to be verified
118
97
  * @param signature - signature of the JSON object
119
98
  * @returns true if the signature is valid, false otherwise
120
99
  * @throws {Error} if the JSON object is not a valid JSON or the signature is not a valid signature
@@ -2,8 +2,8 @@ import { ProviderInterface } from '../provider';
2
2
  import {
3
3
  Abi,
4
4
  AddTransactionResponse,
5
+ Call,
5
6
  DeployContractPayload,
6
- ExecuteInvocation,
7
7
  InvocationsDetails,
8
8
  Signature,
9
9
  } from '../types';
@@ -41,7 +41,7 @@ export abstract class AccountInterface extends ProviderInterface {
41
41
  * @returns response from addTransaction
42
42
  */
43
43
  public abstract execute(
44
- transactions: ExecuteInvocation | ExecuteInvocation[],
44
+ transactions: Call | Call[],
45
45
  abis?: Abi[],
46
46
  transactionsDetail?: InvocationsDetails
47
47
  ): Promise<AddTransactionResponse>;
package/src/index.ts CHANGED
@@ -5,6 +5,7 @@ export * from './types';
5
5
  export * from './contract';
6
6
  export * from './provider';
7
7
  export * from './account';
8
+ export * from './signer';
8
9
 
9
10
  /**
10
11
  * Utils
@@ -17,21 +17,16 @@ import {
17
17
  Invocation,
18
18
  TransactionReceipt,
19
19
  } from '../types';
20
+ import { getSelectorFromName } from '../utils/hash';
20
21
  import { parse, stringify } from '../utils/json';
21
22
  import { BigNumberish, bigNumberishArrayToDecimalStringArray, toBN, toHex } from '../utils/number';
22
- import { compressProgram, getSelectorFromName, randomAddress } from '../utils/stark';
23
+ import { compressProgram, randomAddress } from '../utils/stark';
23
24
  import { ProviderInterface } from './interface';
24
25
  import { BlockIdentifier, getFormattedBlockIdentifier, txIdentifier } from './utils';
25
26
 
26
27
  type NetworkName = 'mainnet-alpha' | 'goerli-alpha';
27
28
 
28
- type ProviderOptions =
29
- | {
30
- network: NetworkName;
31
- }
32
- | {
33
- baseUrl: string;
34
- };
29
+ type ProviderOptions = { network: NetworkName } | { baseUrl: string };
35
30
 
36
31
  function wait(delay: number) {
37
32
  return new Promise((res) => setTimeout(res, delay));
@@ -133,14 +128,21 @@ export class Provider implements ProviderInterface {
133
128
  const queryString = this.getQueryString(query);
134
129
  const headers = this.getHeaders(method);
135
130
 
136
- const { data } = await axios.request<Endpoints[T]['RESPONSE']>({
137
- method,
138
- url: urljoin(baseUrl, endpoint, queryString),
139
- data: stringify(request),
140
- headers,
141
- });
142
-
143
- return data;
131
+ try {
132
+ const { data } = await axios.request<Endpoints[T]['RESPONSE']>({
133
+ method,
134
+ url: urljoin(baseUrl, endpoint, queryString),
135
+ data: stringify(request),
136
+ headers,
137
+ });
138
+ return data;
139
+ } catch (error: any) {
140
+ const data = error?.response?.data;
141
+ if (data?.message) {
142
+ throw new Error(`${data.code}: ${data.message}`);
143
+ }
144
+ throw error;
145
+ }
144
146
  }
145
147
 
146
148
  /**
@@ -344,7 +346,10 @@ export class Provider implements ProviderInterface {
344
346
  if (res.tx_status === 'ACCEPTED_ON_L1' || res.tx_status === 'ACCEPTED_ON_L2') {
345
347
  onchain = true;
346
348
  } else if (res.tx_status === 'REJECTED' || res.tx_status === 'NOT_RECEIVED') {
347
- const error = Error(res.tx_status) as Error & { response: GetTransactionStatusResponse };
349
+ const message = res.tx_failure_reason
350
+ ? `${res.tx_status}: ${res.tx_failure_reason.code}\n${res.tx_failure_reason.error_message}`
351
+ : res.tx_status;
352
+ const error = new Error(message) as Error & { response: GetTransactionStatusResponse };
348
353
  error.response = res;
349
354
  throw error;
350
355
  }
@@ -1,9 +1,6 @@
1
1
  import { Abi, Invocation, InvocationsSignerDetails, KeyPair, Signature } from '../types';
2
2
  import { getStarkKey, sign } from '../utils/ellipticCurve';
3
- import { addHexPrefix } from '../utils/encode';
4
- import { hashMessage } from '../utils/hash';
5
- import { bigNumberishArrayToDecimalStringArray, toBN } from '../utils/number';
6
- import { getSelectorFromName } from '../utils/stark';
3
+ import { hashMulticall } from '../utils/hash';
7
4
  import { TypedData, getMessageHash } from '../utils/typedData';
8
5
  import { SignerInterface } from './interface';
9
6
 
@@ -21,38 +18,25 @@ export class Signer implements SignerInterface {
21
18
  public async signTransaction(
22
19
  transactions: Invocation[],
23
20
  transactionsDetail: InvocationsSignerDetails,
24
- abis: Abi[] = []
21
+ abis?: Abi[]
25
22
  ): Promise<Signature> {
26
- if (transactions.length !== 1) {
27
- throw new Error('Only one transaction at a time is currently supported by this signer');
28
- }
29
- if (abis?.length !== 0 && abis.length !== transactions.length) {
23
+ if (abis && abis.length !== transactions.length) {
30
24
  throw new Error('ABI must be provided for each transaction or no transaction');
31
25
  }
32
26
  // now use abi to display decoded data somewhere, but as this signer is headless, we can't do that
33
27
 
34
- const { contractAddress, entrypoint, calldata = [] } = transactions[0];
35
- const { nonce, walletAddress } = transactionsDetail;
36
-
37
- const nonceBn = toBN(nonce);
38
- const entrypointSelector = getSelectorFromName(entrypoint);
39
- const calldataDecimal = bigNumberishArrayToDecimalStringArray(calldata);
40
-
41
- const msgHash = addHexPrefix(
42
- hashMessage(
43
- walletAddress,
44
- contractAddress,
45
- entrypointSelector,
46
- calldataDecimal,
47
- nonceBn.toString()
48
- )
28
+ const msgHash = hashMulticall(
29
+ transactionsDetail.walletAddress,
30
+ transactions,
31
+ transactionsDetail.nonce.toString(),
32
+ transactionsDetail.maxFee.toString()
49
33
  );
50
34
 
51
35
  return sign(this.keyPair, msgHash);
52
36
  }
53
37
 
54
- public async signMessage(typedData: TypedData, walletAddress: string): Promise<Signature> {
55
- const msgHash = getMessageHash(typedData, walletAddress);
38
+ public async signMessage(typedData: TypedData, accountAddress: string): Promise<Signature> {
39
+ const msgHash = getMessageHash(typedData, accountAddress);
56
40
  return sign(this.keyPair, msgHash);
57
41
  }
58
42
  }
@@ -13,11 +13,12 @@ export abstract class SignerInterface {
13
13
  * Sign an JSON object for off-chain usage with the starknet private key and return the signature
14
14
  * This adds a message prefix so it cant be interchanged with transactions
15
15
  *
16
- * @param json - JSON object to be signed
16
+ * @param typedData - JSON object to be signed
17
+ * @param accountAddress - account
17
18
  * @returns the signature of the JSON object
18
19
  * @throws {Error} if the JSON object is not a valid JSON
19
20
  */
20
- public abstract signMessage(typedData: TypedData, walletAddress: string): Promise<Signature>;
21
+ public abstract signMessage(typedData: TypedData, accountAddress: string): Promise<Signature>;
21
22
 
22
23
  /**
23
24
  * Signs a transaction with the starknet private key and returns the signature
package/src/types/api.ts CHANGED
@@ -137,6 +137,11 @@ export type GetCodeResponse = {
137
137
  export type GetTransactionStatusResponse = {
138
138
  tx_status: Status;
139
139
  block_hash: string;
140
+ tx_failure_reason?: {
141
+ tx_id: number;
142
+ code: string;
143
+ error_message: string;
144
+ };
140
145
  };
141
146
 
142
147
  export type GetTransactionResponse = {
package/src/types/lib.ts CHANGED
@@ -3,7 +3,7 @@ import type { ec as EC } from 'elliptic';
3
3
  import type { BigNumberish } from '../utils/number';
4
4
 
5
5
  export type KeyPair = EC.KeyPair;
6
- export type Signature = BigNumberish[];
6
+ export type Signature = string[];
7
7
  export type RawCalldata = BigNumberish[];
8
8
 
9
9
  export type DeployContractPayload = {
@@ -19,14 +19,13 @@ export type Invocation = {
19
19
  signature?: Signature;
20
20
  };
21
21
 
22
- export type ExecuteInvocation = Omit<Invocation, 'signature'>;
22
+ export type Call = Omit<Invocation, 'signature'>;
23
23
 
24
24
  export type InvocationsDetails = {
25
25
  nonce?: BigNumberish;
26
+ maxFee?: BigNumberish;
26
27
  };
27
28
 
28
- export type Call = Omit<Invocation, 'signature' | 'nonce'>;
29
-
30
29
  export type Status =
31
30
  | 'NOT_RECEIVED'
32
31
  | 'RECEIVED'
@@ -80,7 +80,7 @@ export function sign(keyPair: KeyPair, msgHash: string): Signature {
80
80
  assertInRange(r, ONE, toBN(addHexPrefix(MAX_ECDSA_VAL)), 'r');
81
81
  assertInRange(s, ONE, toBN(addHexPrefix(EC_ORDER)), 's');
82
82
  assertInRange(w, ONE, toBN(addHexPrefix(MAX_ECDSA_VAL)), 'w');
83
- return [r, s];
83
+ return [r.toString(), s.toString()];
84
84
  }
85
85
 
86
86
  function chunkArray(arr: any[], n: number): any[][] {
package/src/utils/hash.ts CHANGED
@@ -3,9 +3,14 @@ import { keccak256 } from 'ethereum-cryptography/keccak';
3
3
  import assert from 'minimalistic-assert';
4
4
 
5
5
  import { CONSTANT_POINTS, FIELD_PRIME, MASK_250, ONE, ZERO } from '../constants';
6
+ import { Call } from '../types';
6
7
  import { ec } from './ellipticCurve';
7
8
  import { addHexPrefix, buf2hex, utf8ToArray } from './encode';
8
- import { BigNumberish, toBN } from './number';
9
+ import { BigNumberish, bigNumberishArrayToDecimalStringArray, toBN, toHex } from './number';
10
+ import { encodeShortString } from './shortString';
11
+
12
+ export const transactionPrefix = encodeShortString('StarkNet Transaction');
13
+ export const transactionVersion = 0;
9
14
 
10
15
  function keccakHex(value: string): string {
11
16
  return addHexPrefix(buf2hex(keccak256(utf8ToArray(value))));
@@ -22,6 +27,18 @@ export function starknetKeccak(value: string): BN {
22
27
  return toBN(keccakHex(value)).and(MASK_250);
23
28
  }
24
29
 
30
+ /**
31
+ * Function to get the hex selector from a given function name
32
+ *
33
+ * [Reference](https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/public/abi.py#L25-L26)
34
+ * @param funcName - selectors abi function name
35
+ * @returns hex selector of given abi function name
36
+ */
37
+ export function getSelectorFromName(funcName: string) {
38
+ // sometimes BigInteger pads the hex string with zeros, which isnt allowed in the starknet api
39
+ return toHex(starknetKeccak(funcName));
40
+ }
41
+
25
42
  const constantPoints = CONSTANT_POINTS.map((coords: string[]) =>
26
43
  ec.curve.point(coords[0], coords[1])
27
44
  );
@@ -47,17 +64,27 @@ export function computeHashOnElements(data: BigNumberish[]) {
47
64
  return [...data, data.length].reduce((x, y) => pedersen([x, y]), 0).toString();
48
65
  }
49
66
 
50
- export function hashCalldata(calldata: string[]): string {
51
- return computeHashOnElements(calldata);
52
- }
53
-
54
- export function hashMessage(
67
+ export function hashMulticall(
55
68
  account: string,
56
- to: string,
57
- selector: string,
58
- calldata: string[],
59
- nonce: string
69
+ transactions: Call[],
70
+ nonce: string,
71
+ maxFee: string
60
72
  ) {
61
- const calldataHash = hashCalldata(calldata);
62
- return computeHashOnElements([account, to, selector, calldataHash, nonce]);
73
+ const hashArray = transactions
74
+ .map(({ contractAddress, entrypoint, calldata }) => [
75
+ contractAddress,
76
+ getSelectorFromName(entrypoint),
77
+ computeHashOnElements(calldata || []),
78
+ ])
79
+ .map(bigNumberishArrayToDecimalStringArray)
80
+ .map(computeHashOnElements);
81
+
82
+ return computeHashOnElements([
83
+ transactionPrefix,
84
+ account,
85
+ computeHashOnElements(hashArray),
86
+ nonce,
87
+ maxFee,
88
+ transactionVersion,
89
+ ]);
63
90
  }
@@ -3,9 +3,8 @@ import { gzip } from 'pako';
3
3
  import { Calldata, CompressedProgram, Program, RawArgs, Signature } from '../types';
4
4
  import { genKeyPair, getStarkKey } from './ellipticCurve';
5
5
  import { addHexPrefix, btoaUniversal } from './encode';
6
- import { starknetKeccak } from './hash';
7
6
  import { stringify } from './json';
8
- import { toBN, toHex } from './number';
7
+ import { toBN } from './number';
9
8
 
10
9
  /**
11
10
  * Function to compress compiled cairo program
@@ -20,18 +19,6 @@ export function compressProgram(jsonProgram: Program | string): CompressedProgra
20
19
  return btoaUniversal(compressedProgram);
21
20
  }
22
21
 
23
- /**
24
- * Function to get the hex selector from a given function name
25
- *
26
- * [Reference](https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/public/abi.py#L25-L26)
27
- * @param funcName - selectors abi function name
28
- * @returns hex selector of given abi function name
29
- */
30
- export function getSelectorFromName(funcName: string) {
31
- // sometimes BigInteger pads the hex string with zeros, which isnt allowed in the starknet api
32
- return toHex(starknetKeccak(funcName));
33
- }
34
-
35
22
  export function randomAddress(): string {
36
23
  const randomKeyPair = genKeyPair();
37
24
  return getStarkKey(randomKeyPair);
@@ -0,0 +1,50 @@
1
+ import { ParsedStruct } from '../contract';
2
+ import { Call } from '../types';
3
+ import { getSelectorFromName } from './hash';
4
+ import { BigNumberish, bigNumberishArrayToDecimalStringArray, toBN } from './number';
5
+
6
+ /**
7
+ * Transforms a list of Calls, each with their own calldata, into
8
+ * two arrays: one with the entrypoints, and one with the concatenated calldata.
9
+ * @param calls
10
+ * @returns
11
+ */
12
+ export const transformCallsToMulticallArrays = (calls: Call[]) => {
13
+ const callArray: ParsedStruct[] = [];
14
+ const calldata: BigNumberish[] = [];
15
+ calls.forEach((call) => {
16
+ const data = call.calldata || [];
17
+ callArray.push({
18
+ to: toBN(call.contractAddress).toString(10),
19
+ selector: toBN(getSelectorFromName(call.entrypoint)).toString(10),
20
+ data_offset: calldata.length.toString(),
21
+ data_len: data.length.toString(),
22
+ });
23
+ calldata.push(...data);
24
+ });
25
+ return {
26
+ callArray,
27
+ calldata: bigNumberishArrayToDecimalStringArray(calldata),
28
+ };
29
+ };
30
+
31
+ /**
32
+ * Transforms a list of calls in the full flattened calldata expected
33
+ * by the __execute__ protocol.
34
+ * @param calls
35
+ * @returns
36
+ */
37
+ export const fromCallsToExecuteCalldata = (calls: Call[]): string[] => {
38
+ const { callArray, calldata } = transformCallsToMulticallArrays(calls);
39
+ return [
40
+ callArray.length.toString(),
41
+ ...callArray
42
+ .map(
43
+ ({ to, selector, data_offset, data_len }) =>
44
+ [to, selector, data_offset, data_len] as string[]
45
+ )
46
+ .flat(),
47
+ calldata.length.toString(),
48
+ ...calldata,
49
+ ];
50
+ };
@@ -1,7 +1,6 @@
1
- import { computeHashOnElements } from '../hash';
1
+ import { computeHashOnElements, getSelectorFromName } from '../hash';
2
2
  import { BigNumberish, toBN, toHex } from '../number';
3
3
  import { encodeShortString } from '../shortString';
4
- import { getSelectorFromName } from '../stark';
5
4
  import { TypedData } from './types';
6
5
  import { validateTypedData } from './utils';
7
6
 
@@ -161,7 +160,7 @@ export const getStructHash = <T extends TypedData>(
161
160
  * with Keccak256.
162
161
  *
163
162
  * @param {TypedData} typedData
164
- * @param {boolean} hash
163
+ * @param {BigNumberish} account
165
164
  * @return {string}
166
165
  */
167
166
  export const getMessageHash = (typedData: TypedData, account: BigNumberish): string => {
package/types/api.d.ts CHANGED
@@ -127,6 +127,11 @@ export declare type GetCodeResponse = {
127
127
  export declare type GetTransactionStatusResponse = {
128
128
  tx_status: Status;
129
129
  block_hash: string;
130
+ tx_failure_reason?: {
131
+ tx_id: number;
132
+ code: string;
133
+ error_message: string;
134
+ };
130
135
  };
131
136
  export declare type GetTransactionResponse = {
132
137
  status: Status;
package/types/lib.d.ts CHANGED
@@ -2,7 +2,7 @@ import type { ec as EC } from 'elliptic';
2
2
 
3
3
  import type { BigNumberish } from '../utils/number';
4
4
  export declare type KeyPair = EC.KeyPair;
5
- export declare type Signature = BigNumberish[];
5
+ export declare type Signature = string[];
6
6
  export declare type RawCalldata = BigNumberish[];
7
7
  export declare type DeployContractPayload = {
8
8
  contract: CompiledContract | string;
@@ -15,11 +15,11 @@ export declare type Invocation = {
15
15
  calldata?: RawCalldata;
16
16
  signature?: Signature;
17
17
  };
18
- export declare type ExecuteInvocation = Omit<Invocation, 'signature'>;
18
+ export declare type Call = Omit<Invocation, 'signature'>;
19
19
  export declare type InvocationsDetails = {
20
20
  nonce?: BigNumberish;
21
+ maxFee?: BigNumberish;
21
22
  };
22
- export declare type Call = Omit<Invocation, 'signature' | 'nonce'>;
23
23
  export declare type Status =
24
24
  | 'NOT_RECEIVED'
25
25
  | 'RECEIVED'
@@ -136,7 +136,7 @@ function sign(keyPair, msgHash) {
136
136
  (0, number_1.toBN)((0, encode_1.addHexPrefix)(constants_1.MAX_ECDSA_VAL)),
137
137
  'w'
138
138
  );
139
- return [r, s];
139
+ return [r.toString(), s.toString()];
140
140
  }
141
141
  exports.sign = sign;
142
142
  function chunkArray(arr, n) {
package/utils/hash.d.ts CHANGED
@@ -1,6 +1,9 @@
1
1
  import BN from 'bn.js';
2
2
 
3
+ import { Call } from '../types';
3
4
  import { BigNumberish } from './number';
5
+ export declare const transactionPrefix: string;
6
+ export declare const transactionVersion = 0;
4
7
  /**
5
8
  * Function to get the starknet keccak hash from a string
6
9
  *
@@ -9,13 +12,19 @@ import { BigNumberish } from './number';
9
12
  * @returns starknet keccak hash as BigNumber
10
13
  */
11
14
  export declare function starknetKeccak(value: string): BN;
15
+ /**
16
+ * Function to get the hex selector from a given function name
17
+ *
18
+ * [Reference](https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/public/abi.py#L25-L26)
19
+ * @param funcName - selectors abi function name
20
+ * @returns hex selector of given abi function name
21
+ */
22
+ export declare function getSelectorFromName(funcName: string): string;
12
23
  export declare function pedersen(input: [BigNumberish, BigNumberish]): string;
13
24
  export declare function computeHashOnElements(data: BigNumberish[]): string;
14
- export declare function hashCalldata(calldata: string[]): string;
15
- export declare function hashMessage(
25
+ export declare function hashMulticall(
16
26
  account: string,
17
- to: string,
18
- selector: string,
19
- calldata: string[],
20
- nonce: string
27
+ transactions: Call[],
28
+ nonce: string,
29
+ maxFee: string
21
30
  ): string;
package/utils/hash.js CHANGED
@@ -39,11 +39,13 @@ var __importDefault =
39
39
  return mod && mod.__esModule ? mod : { default: mod };
40
40
  };
41
41
  Object.defineProperty(exports, '__esModule', { value: true });
42
- exports.hashMessage =
43
- exports.hashCalldata =
42
+ exports.hashMulticall =
44
43
  exports.computeHashOnElements =
45
44
  exports.pedersen =
45
+ exports.getSelectorFromName =
46
46
  exports.starknetKeccak =
47
+ exports.transactionVersion =
48
+ exports.transactionPrefix =
47
49
  void 0;
48
50
  var keccak_1 = require('ethereum-cryptography/keccak');
49
51
  var minimalistic_assert_1 = __importDefault(require('minimalistic-assert'));
@@ -51,6 +53,9 @@ var constants_1 = require('../constants');
51
53
  var ellipticCurve_1 = require('./ellipticCurve');
52
54
  var encode_1 = require('./encode');
53
55
  var number_1 = require('./number');
56
+ var shortString_1 = require('./shortString');
57
+ exports.transactionPrefix = (0, shortString_1.encodeShortString)('StarkNet Transaction');
58
+ exports.transactionVersion = 0;
54
59
  function keccakHex(value) {
55
60
  return (0, encode_1.addHexPrefix)(
56
61
  (0, encode_1.buf2hex)((0, keccak_1.keccak256)((0, encode_1.utf8ToArray)(value)))
@@ -67,6 +72,18 @@ function starknetKeccak(value) {
67
72
  return (0, number_1.toBN)(keccakHex(value)).and(constants_1.MASK_250);
68
73
  }
69
74
  exports.starknetKeccak = starknetKeccak;
75
+ /**
76
+ * Function to get the hex selector from a given function name
77
+ *
78
+ * [Reference](https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/public/abi.py#L25-L26)
79
+ * @param funcName - selectors abi function name
80
+ * @returns hex selector of given abi function name
81
+ */
82
+ function getSelectorFromName(funcName) {
83
+ // sometimes BigInteger pads the hex string with zeros, which isnt allowed in the starknet api
84
+ return (0, number_1.toHex)(starknetKeccak(funcName));
85
+ }
86
+ exports.getSelectorFromName = getSelectorFromName;
70
87
  var constantPoints = constants_1.CONSTANT_POINTS.map(function (coords) {
71
88
  return ellipticCurve_1.ec.curve.point(coords[0], coords[1]);
72
89
  });
@@ -99,12 +116,27 @@ function computeHashOnElements(data) {
99
116
  .toString();
100
117
  }
101
118
  exports.computeHashOnElements = computeHashOnElements;
102
- function hashCalldata(calldata) {
103
- return computeHashOnElements(calldata);
104
- }
105
- exports.hashCalldata = hashCalldata;
106
- function hashMessage(account, to, selector, calldata, nonce) {
107
- var calldataHash = hashCalldata(calldata);
108
- return computeHashOnElements([account, to, selector, calldataHash, nonce]);
119
+ function hashMulticall(account, transactions, nonce, maxFee) {
120
+ var hashArray = transactions
121
+ .map(function (_a) {
122
+ var contractAddress = _a.contractAddress,
123
+ entrypoint = _a.entrypoint,
124
+ calldata = _a.calldata;
125
+ return [
126
+ contractAddress,
127
+ getSelectorFromName(entrypoint),
128
+ computeHashOnElements(calldata || []),
129
+ ];
130
+ })
131
+ .map(number_1.bigNumberishArrayToDecimalStringArray)
132
+ .map(computeHashOnElements);
133
+ return computeHashOnElements([
134
+ exports.transactionPrefix,
135
+ account,
136
+ computeHashOnElements(hashArray),
137
+ nonce,
138
+ maxFee,
139
+ exports.transactionVersion,
140
+ ]);
109
141
  }
110
- exports.hashMessage = hashMessage;
142
+ exports.hashMulticall = hashMulticall;
package/utils/stark.d.ts CHANGED
@@ -7,14 +7,6 @@ import { Calldata, CompressedProgram, Program, RawArgs, Signature } from '../typ
7
7
  * @returns Compressed cairo program
8
8
  */
9
9
  export declare function compressProgram(jsonProgram: Program | string): CompressedProgram;
10
- /**
11
- * Function to get the hex selector from a given function name
12
- *
13
- * [Reference](https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/public/abi.py#L25-L26)
14
- * @param funcName - selectors abi function name
15
- * @returns hex selector of given abi function name
16
- */
17
- export declare function getSelectorFromName(funcName: string): string;
18
10
  export declare function randomAddress(): string;
19
11
  export declare function makeAddress(input: string): string;
20
12
  export declare function formatSignature(sig?: Signature): string[];