starknet 2.1.1 → 2.4.0

package/dist/utils/shortString.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeShortString = exports.encodeShortString = exports.isShortString = exports.isASCII = void 0;
+var encode_1 = require("./encode");
+function isASCII(str) {
+    // eslint-disable-next-line no-control-regex
+    return /^[\x00-\x7F]*$/.test(str);
+}
+exports.isASCII = isASCII;
+// function to check if string has less or equal 31 characters
+function isShortString(str) {
+    return str.length <= 31;
+}
+exports.isShortString = isShortString;
+function encodeShortString(str) {
+    if (!isASCII(str))
+        throw new Error(str + " is not an ASCII string");
+    if (!isShortString(str))
+        throw new Error(str + " is too long");
+    return (0, encode_1.addHexPrefix)(str.replace(/./g, function (char) { return char.charCodeAt(0).toString(16); }));
+}
+exports.encodeShortString = encodeShortString;
+function decodeShortString(str) {
+    return (0, encode_1.removeHexPrefix)(str).replace(/.{2}/g, function (hex) { return String.fromCharCode(parseInt(hex, 16)); });
+}
+exports.decodeShortString = decodeShortString;

package/dist/utils/uint256.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="bn.js" />
+import { BigNumberish } from './number';
+export interface Uint256 {
+    low: BigNumberish;
+    high: BigNumberish;
+}
+export declare function uint256ToBN(uint256: Uint256): import("bn.js");
+export declare const UINT_128_MAX: import("bn.js");
+export declare const UINT_256_MAX: import("bn.js");
+export declare function isUint256(bn: BigNumberish): boolean;
+export declare function bnToUint256(bignumber: BigNumberish): Uint256;

package/dist/utils/uint256.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bnToUint256 = exports.isUint256 = exports.UINT_256_MAX = exports.UINT_128_MAX = exports.uint256ToBN = void 0;
+var encode_1 = require("./encode");
+var number_1 = require("./number");
+// function to convert Uint256 to BN
+function uint256ToBN(uint256) {
+    return (0, number_1.toBN)(uint256.high).shln(128).add((0, number_1.toBN)(uint256.low));
+}
+exports.uint256ToBN = uint256ToBN;
+exports.UINT_128_MAX = (0, number_1.toBN)(1).shln(128).sub((0, number_1.toBN)(1));
+exports.UINT_256_MAX = (0, number_1.toBN)(1).shln(256).sub((0, number_1.toBN)(1));
+// function to check if BN is smaller or equal 2**256-1
+function isUint256(bn) {
+    return (0, number_1.toBN)(bn).lte(exports.UINT_256_MAX);
+}
+exports.isUint256 = isUint256;
+// function to convert BN to Uint256
+function bnToUint256(bignumber) {
+    var bn = (0, number_1.toBN)(bignumber);
+    if (!isUint256(bn))
+        throw new Error('Number is too large');
+    return {
+        low: (0, encode_1.addHexPrefix)(bn.maskn(128).toString(16)),
+        high: (0, encode_1.addHexPrefix)(bn.shrn(128).toString(16)),
+    };
+}
+exports.bnToUint256 = bnToUint256;

package/index.d.ts

@@ -15,3 +15,5 @@ export * as json from './utils/json';
 export * as number from './utils/number';
 export * as stark from './utils/stark';
 export * as ec from './utils/ellipticCurve';
+export * as uint256 from './utils/uint256';
+export * as shortString from './utils/shortString';

package/index.js

@@ -44,7 +44,9 @@ var __importStar =
     return result;
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.ec =
+exports.shortString =
+  exports.uint256 =
+  exports.ec =
   exports.stark =
   exports.number =
   exports.json =
@@ -69,3 +71,5 @@ exports.json = __importStar(require('./utils/json'));
 exports.number = __importStar(require('./utils/number'));
 exports.stark = __importStar(require('./utils/stark'));
 exports.ec = __importStar(require('./utils/ellipticCurve'));
+exports.uint256 = __importStar(require('./utils/uint256'));
+exports.shortString = __importStar(require('./utils/shortString'));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "2.1.1",
+  "version": "2.4.0",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,6 +23,7 @@
     "zk",
     "rollup"
   ],
+  "repository": "github:seanjameshan/starknet.js",
   "author": "Sean Han",
   "license": "MIT",
   "devDependencies": {
@@ -40,6 +41,7 @@
     "@types/json-bigint": "^1.0.1",
     "@types/minimalistic-assert": "^1.0.1",
     "@types/pako": "^1.0.2",
+    "@types/url-join": "^4.0.1",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
     "eslint": "^7.32.0",
@@ -65,7 +67,8 @@
     "hash.js": "^1.1.7",
     "json-bigint": "^1.0.0",
     "minimalistic-assert": "^1.0.1",
-    "pako": "^2.0.4"
+    "pako": "^2.0.4",
+    "url-join": "^4.0.1"
   },
   "lint-staged": {
     "*.ts": "eslint --cache --fix",

package/provider/default.d.ts

@@ -27,7 +27,7 @@ export declare class Provider implements ProviderInterface {
   constructor(optionsOrProvider?: ProviderOptions | Provider);
   protected static getNetworkFromName(
     name: NetworkName
-  ): 'http://alpha-mainnet.starknet.io/' | 'https://alpha4.starknet.io';
+  ): 'https://alpha-mainnet.starknet.io' | 'https://alpha4.starknet.io';
   /**
    * Gets the smart contract address on the goerli testnet.
    *
@@ -40,11 +40,14 @@ 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 invokeTransaction - transaction to be invoked
    * @param blockId
    * @returns the result of the function on the smart contract.
    */
-  callContract(invokeTx: CallContractTransaction, blockId?: number): Promise<CallContractResponse>;
+  callContract(
+    invokeTransaction: CallContractTransaction,
+    blockId?: number
+  ): Promise<CallContractResponse>;
   /**
    * Gets the block information from a block ID.
    *
@@ -98,10 +101,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
    *

package/provider/default.js

@@ -152,6 +152,7 @@ var __importDefault =
 Object.defineProperty(exports, '__esModule', { value: true });
 exports.Provider = void 0;
 var axios_1 = __importDefault(require('axios'));
+var url_join_1 = __importDefault(require('url-join'));
 var json_1 = require('../utils/json');
 var number_1 = require('../utils/number');
 var stark_1 = require('../utils/stark');
@@ -175,14 +176,14 @@ var Provider = /** @class */ (function () {
           ? optionsOrProvider.baseUrl
           : Provider.getNetworkFromName(optionsOrProvider.network);
       this.baseUrl = baseUrl;
-      this.feederGatewayUrl = baseUrl + '/feeder_gateway';
-      this.gatewayUrl = baseUrl + '/gateway';
+      this.feederGatewayUrl = (0, url_join_1.default)(baseUrl, 'feeder_gateway');
+      this.gatewayUrl = (0, url_join_1.default)(baseUrl, 'gateway');
     }
   }
   Provider.getNetworkFromName = function (name) {
     switch (name) {
       case 'mainnet-alpha':
-        return 'http://alpha-mainnet.starknet.io/';
+        return 'https://alpha-mainnet.starknet.io';
       case 'georli-alpha':
       default:
         return 'https://alpha4.starknet.io';
@@ -202,7 +203,9 @@ var Provider = /** @class */ (function () {
           case 0:
             return [
               4 /*yield*/,
-              axios_1.default.get(this.feederGatewayUrl + '/get_contract_addresses'),
+              axios_1.default.get(
+                (0, url_join_1.default)(this.feederGatewayUrl, 'get_contract_addresses')
+              ),
             ];
           case 1:
             data = _a.sent().data;
@@ -216,11 +219,11 @@ var Provider = /** @class */ (function () {
    *
    * [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 invokeTransaction - transaction to be invoked
    * @param blockId
    * @returns the result of the function on the smart contract.
    */
-  Provider.prototype.callContract = function (invokeTx, blockId) {
+  Provider.prototype.callContract = function (invokeTransaction, blockId) {
     return __awaiter(this, void 0, void 0, function () {
       var data;
       return __generator(this, function (_a) {
@@ -229,10 +232,12 @@ var Provider = /** @class */ (function () {
             return [
               4 /*yield*/,
               axios_1.default.post(
-                this.feederGatewayUrl +
-                  '/call_contract?blockId=' +
-                  (blockId !== null && blockId !== void 0 ? blockId : 'null'),
-                __assign({ signature: [], calldata: [] }, invokeTx)
+                (0, url_join_1.default)(
+                  this.feederGatewayUrl,
+                  'call_contract',
+                  '?blockId=' + (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                ),
+                __assign({ signature: [], calldata: [] }, invokeTransaction)
               ),
             ];
           case 1:
@@ -259,9 +264,11 @@ var Provider = /** @class */ (function () {
             return [
               4 /*yield*/,
               axios_1.default.get(
-                this.feederGatewayUrl +
-                  '/get_block?blockId=' +
-                  (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                (0, url_join_1.default)(
+                  this.feederGatewayUrl,
+                  'get_block',
+                  '?blockId=' + (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                )
               ),
             ];
           case 1:
@@ -289,11 +296,14 @@ var Provider = /** @class */ (function () {
             return [
               4 /*yield*/,
               axios_1.default.get(
-                this.feederGatewayUrl +
-                  '/get_code?contractAddress=' +
-                  contractAddress +
-                  '&blockId=' +
-                  (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                (0, url_join_1.default)(
+                  this.feederGatewayUrl,
+                  'get_code',
+                  '?contractAddress=' +
+                    contractAddress +
+                    '&blockId=' +
+                    (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                )
               ),
             ];
           case 1:
@@ -323,13 +333,16 @@ var Provider = /** @class */ (function () {
             return [
               4 /*yield*/,
               axios_1.default.get(
-                this.feederGatewayUrl +
-                  '/get_storage_at?contractAddress=' +
-                  contractAddress +
-                  '&key=' +
-                  key +
-                  '&blockId=' +
-                  (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                (0, url_join_1.default)(
+                  this.feederGatewayUrl,
+                  'get_storage_at',
+                  '?contractAddress=' +
+                    contractAddress +
+                    '&key=' +
+                    key +
+                    '&blockId=' +
+                    (blockId !== null && blockId !== void 0 ? blockId : 'null')
+                )
               ),
             ];
           case 1:
@@ -357,9 +370,11 @@ var Provider = /** @class */ (function () {
             return [
               4 /*yield*/,
               axios_1.default.get(
-                this.feederGatewayUrl +
-                  '/get_transaction_status?transactionHash=' +
-                  (0, number_1.toHex)(txHashBn)
+                (0, url_join_1.default)(
+                  this.feederGatewayUrl,
+                  'get_transaction_status',
+                  '?transactionHash=' + (0, number_1.toHex)(txHashBn)
+                )
               ),
             ];
           case 1:
@@ -387,9 +402,11 @@ var Provider = /** @class */ (function () {
             return [
               4 /*yield*/,
               axios_1.default.get(
-                this.feederGatewayUrl +
-                  '/get_transaction?transactionHash=' +
-                  (0, number_1.toHex)(txHashBn)
+                (0, url_join_1.default)(
+                  this.feederGatewayUrl,
+                  'get_transaction',
+                  '?transactionHash=' + (0, number_1.toHex)(txHashBn)
+                )
               ),
             ];
           case 1:
@@ -404,27 +421,29 @@ var Provider = /** @class */ (function () {
    *
    * [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
    */
-  Provider.prototype.addTransaction = function (tx) {
+  Provider.prototype.addTransaction = function (transaction) {
     return __awaiter(this, void 0, void 0, function () {
       var signature, contract_address_salt, data;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
-            signature = tx.type === 'INVOKE_FUNCTION' && (0, stark_1.formatSignature)(tx.signature);
+            signature =
+              transaction.type === 'INVOKE_FUNCTION' &&
+              (0, stark_1.formatSignature)(transaction.signature);
             contract_address_salt =
-              tx.type === 'DEPLOY' &&
-              (0, number_1.toHex)((0, number_1.toBN)(tx.contract_address_salt));
+              transaction.type === 'DEPLOY' &&
+              (0, number_1.toHex)((0, number_1.toBN)(transaction.contract_address_salt));
             return [
               4 /*yield*/,
               axios_1.default.post(
-                this.gatewayUrl + '/add_transaction',
+                (0, url_join_1.default)(this.gatewayUrl, 'add_transaction'),
                 (0, json_1.stringify)(
                   __assign(
                     __assign(
-                      __assign({}, tx),
+                      __assign({}, transaction),
                       Array.isArray(signature) && { signature: signature }
                     ),
                     contract_address_salt && { contract_address_salt: contract_address_salt }

package/provider/interface.d.ts

@@ -27,12 +27,12 @@ export declare abstract class 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 invokeTransaction - transaction to be invoked
    * @param blockId
    * @returns the result of the function on the smart contract.
    */
   abstract callContract(
-    invokeTx: CallContractTransaction,
+    invokeTransaction: CallContractTransaction,
     blockId?: number
   ): Promise<CallContractResponse>;
   /**
@@ -88,10 +88,10 @@ export declare abstract class 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
    */
-  abstract addTransaction(tx: Transaction): Promise<AddTransactionResponse>;
+  abstract addTransaction(transaction: Transaction): Promise<AddTransactionResponse>;
   /**
    * Deploys a given compiled contract (json) to starknet
    *

package/signer/default.d.ts

@@ -10,8 +10,8 @@ export declare class Signer extends Provider implements SignerInterface {
    *
    * [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>;
 }

package/signer/default.js

@@ -216,19 +216,23 @@ var Signer = /** @class */ (function (_super) {
    *
    * [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
    */
-  Signer.prototype.addTransaction = function (tx) {
+  Signer.prototype.addTransaction = function (transaction) {
     return __awaiter(this, void 0, void 0, function () {
-      var result, nonceBn, calldataDecimal, msgHash, _a, r, s;
+      var nonceBn, result, calldataDecimal, msgHash, _a, r, s;
       return __generator(this, function (_b) {
         switch (_b.label) {
           case 0:
-            if (tx.type === 'DEPLOY')
-              return [2 /*return*/, _super.prototype.addTransaction.call(this, tx)];
+            if (transaction.type === 'DEPLOY')
+              return [2 /*return*/, _super.prototype.addTransaction.call(this, transaction)];
             (0,
-            minimalistic_assert_1.default)(!tx.signature, "Adding signatures to a signer tx currently isn't supported");
+            minimalistic_assert_1.default)(!transaction.signature, "Adding signatures to a signer transaction currently isn't supported");
+            if (!transaction.nonce) return [3 /*break*/, 1];
+            nonceBn = (0, number_1.toBN)(transaction.nonce);
+            return [3 /*break*/, 3];
+          case 1:
             return [
               4 /*yield*/,
               this.callContract({
@@ -236,17 +240,19 @@ var Signer = /** @class */ (function (_super) {
                 entry_point_selector: (0, stark_1.getSelectorFromName)('get_nonce'),
               }),
             ];
-          case 1:
+          case 2:
             result = _b.sent().result;
             nonceBn = (0, number_1.toBN)(result[0]);
-            calldataDecimal = (tx.calldata || []).map(function (x) {
+            _b.label = 3;
+          case 3:
+            calldataDecimal = (transaction.calldata || []).map(function (x) {
               return (0, number_1.toBN)(x).toString();
             });
             msgHash = (0, encode_1.addHexPrefix)(
               (0, hash_1.hashMessage)(
                 this.address,
-                tx.contract_address,
-                tx.entry_point_selector,
+                transaction.contract_address,
+                transaction.entry_point_selector,
                 calldataDecimal,
                 nonceBn.toString()
               )
@@ -260,8 +266,8 @@ var Signer = /** @class */ (function (_super) {
                 calldata: __spreadArray(
                   __spreadArray(
                     [
-                      tx.contract_address,
-                      tx.entry_point_selector,
+                      transaction.contract_address,
+                      transaction.entry_point_selector,
                       calldataDecimal.length.toString(),
                     ],
                     __read(calldataDecimal),

package/signer/interface.d.ts

@@ -7,8 +7,8 @@ export declare abstract class SignerInterface extends Provider {
    *
    * [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
    */
-  abstract addTransaction(tx: Transaction): Promise<AddTransactionResponse>;
+  abstract addTransaction(transaction: Transaction): Promise<AddTransactionResponse>;
 }

package/src/constants.ts

@@ -1,13 +1,11 @@
-import BN from 'bn.js';
-
 import { toBN } from './utils/number';
 
 export { IS_BROWSER } from './utils/encode';
 
-export const ZERO: BN = toBN(0);
-export const ONE: BN = toBN(1);
-export const TWO: BN = toBN(2);
-export const MASK_250: BN = TWO.pow(toBN(250)).sub(ONE); // 2 ** 250 - 1
+export const ZERO = toBN(0);
+export const ONE = toBN(1);
+export const TWO = toBN(2);
+export const MASK_250 = TWO.pow(toBN(250)).sub(ONE); // 2 ** 250 - 1
 
 /**
  * The following is taken from https://github.com/starkware-libs/starkex-resources/blob/master/crypto/starkware/crypto/signature/pedersen_params.json but converted to hex, because JS is very bad handling big integers by default

package/src/contract.ts

@@ -6,7 +6,9 @@ import { Abi, AbiEntry, FunctionAbi, StructAbi } from './types';
 import { BigNumberish, toBN } from './utils/number';
 import { getSelectorFromName } from './utils/stark';
 
-export type Args = { [inputName: string]: string | string[] };
+export type Args = {
+  [inputName: string]: string | string[] | { type: 'struct'; [k: string]: BigNumberish };
+};
 export type Calldata = string[];
 
 function parseFelt(candidate: string): BN {
@@ -30,6 +32,10 @@ export function compileCalldata(args: Args): Calldata {
   return Object.values(args).flatMap((value) => {
     if (Array.isArray(value))
       return [toBN(value.length).toString(), ...value.map((x) => toBN(x).toString())];
+    if (typeof value === 'object' && 'type' in value)
+      return Object.entries(value)
+        .filter(([k]) => k !== 'type')
+        .map(([, v]) => toBN(v).toString());
     return toBN(value).toString();
   });
 }
@@ -88,19 +94,16 @@ export class Contract {
       (abi) => abi.name === method && abi.type === 'function'
     ) as FunctionAbi;
     methodAbi.inputs.forEach((input) => {
-      if (args[input.name] !== undefined) {
+      const arg = args[input.name];
+      if (arg !== undefined) {
         if (input.type === 'felt') {
-          assert(
-            typeof args[input.name] === 'string',
-            `arg ${input.name} should be a felt (string)`
-          );
-          assert(
-            isFelt(args[input.name] as string),
-            `arg ${input.name} should be decimal or hexadecimal`
-          );
+          assert(typeof arg === 'string', `arg ${input.name} should be a felt (string)`);
+          assert(isFelt(arg as string), `arg ${input.name} should be decimal or hexadecimal`);
+        } else if (typeof arg === 'object' && 'type' in arg) {
+          assert(arg.type === 'struct', `arg ${input.name} should be a struct`);
         } else {
-          assert(Array.isArray(args[input.name]), `arg ${input.name} should be a felt* (string[])`);
-          (args[input.name] as string[]).forEach((felt, i) => {
+          assert(Array.isArray(arg), `arg ${input.name} should be a felt* (string[])`);
+          (arg as string[]).forEach((felt, i) => {
             assert(
               typeof felt === 'string',
               `arg ${input.name}[${i}] should be a felt (string) as part of a felt* (string[])`

package/src/index.ts

@@ -16,3 +16,5 @@ export * as json from './utils/json';
 export * as number from './utils/number';
 export * as stark from './utils/stark';
 export * as ec from './utils/ellipticCurve';
+export * as uint256 from './utils/uint256';
+export * as shortString from './utils/shortString';