starknet 0.1.4 → 1.1.0

package/tsconfig.json

@@ -11,8 +11,13 @@
     // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
 
     /* Language and Environment */
-    "target": "es5",                                     /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
-    "lib": ["es2017", "es7", "es6", "dom"],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    "target": "es5" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    "lib": [
+      "es2017",
+      "es7",
+      "es6",
+      "dom"
+    ] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
     // "jsx": "preserve",                                /* Specify what JSX code is generated. */
     // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
     // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
@@ -24,7 +29,7 @@
     // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
 
     /* Modules */
-    "module": "commonjs",                                /* Specify what module code is generated. */
+    "module": "commonjs" /* Specify what module code is generated. */,
     // "rootDir": "./",                                  /* Specify the root folder within your source files. */
     // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
@@ -42,12 +47,12 @@
     // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
 
     /* Emit */
-    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
     // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
     // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
     // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
     // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
-    "outDir": "dist",                                   /* Specify an output folder for all emitted files. */
+    "outDir": "dist" /* Specify an output folder for all emitted files. */,
     // "removeComments": true,                           /* Disable emitting comments. */
     // "noEmit": true,                                   /* Disable emitting files from a compilation. */
     // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
@@ -68,12 +73,12 @@
     /* Interop Constraints */
     // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
     // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
-    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
     // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
-    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
 
     /* Type Checking */
-    "strict": true,                                      /* Enable all strict type-checking options. */
+    "strict": true /* Enable all strict type-checking options. */,
     // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
     // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
     // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
@@ -95,13 +100,10 @@
 
     /* Completeness */
     // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
-    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
   },
   "include": ["src/**/*"],
-  "exclude": [
-    "node_modules",
-    "**/*.test.ts"
-  ],
+  "exclude": ["node_modules"],
   "typedocOptions": {
     "entryPoints": ["src/index.ts"],
     "out": "docs"

package/types.d.ts

@@ -0,0 +1,94 @@
+export interface GetContractAddressesResponse {
+  Starknet: string;
+  GpsStatementVerifier: string;
+}
+export declare type Status =
+  | 'NOT_RECEIVED'
+  | 'RECEIVED'
+  | 'PENDING'
+  | 'REJECTED'
+  | 'ACCEPTED_ONCHAIN';
+export declare type TxStatus = 'TRANSACTION_RECEIVED';
+export declare type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
+export declare type EntryPointType = 'EXTERNAL';
+export declare type CompressedProgram = string;
+export interface Abi {
+  inputs: {
+    name: string;
+    type: string;
+  }[];
+  name: string;
+  outputs: {
+    name: string;
+    type: string;
+  }[];
+  type: string;
+}
+export declare type EntryPointsByType = object;
+export declare type Program = object;
+export interface CompiledContract {
+  abi: Abi;
+  entry_points_by_type: EntryPointsByType;
+  program: Program;
+}
+export interface CompressedCompiledContract extends Omit<CompiledContract, 'program'> {
+  program: CompressedProgram;
+}
+export interface DeployTransaction {
+  type: 'DEPLOY';
+  contract_definition: CompressedCompiledContract;
+  contract_address: string;
+}
+export interface InvokeFunctionTransaction {
+  type: 'INVOKE_FUNCTION';
+  contract_address: string;
+  entry_point_type?: EntryPointType;
+  entry_point_selector?: string;
+  calldata?: string[];
+}
+export declare type Transaction = DeployTransaction | InvokeFunctionTransaction;
+export interface GetBlockResponse {
+  sequence_number: number;
+  state_root: string;
+  block_id: number;
+  transactions: {
+    [txid: string]: Transaction;
+  };
+  timestamp: number;
+  transaction_receipts: {
+    [txid: string]: {
+      block_id: number;
+      transaction_id: number;
+      l2_to_l1_messages: {
+        to_address: string;
+        payload: string[];
+        from_address: string;
+      }[];
+      block_number: number;
+      status: Status;
+      transaction_index: number;
+    };
+  };
+  previous_block_id: number;
+  status: Status;
+}
+export interface GetCode {
+  bytecode: string[];
+  abi: Abi[];
+}
+export interface GetTransactionStatusResponse {
+  tx_status: Status;
+  block_id: number;
+}
+export interface GetTransactionResponse {
+  transaction_index: number;
+  transaction: Transaction;
+  block_id: number;
+  block_number: number;
+  status: Status;
+  transaction_id: number;
+}
+export interface AddTransactionResponse {
+  code: TxStatus;
+  tx_id: number;
+}

package/types.js

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

package/utils.d.ts

@@ -0,0 +1,29 @@
+import { CompressedProgram, Program } from './types';
+export declare const isBrowser: boolean;
+export declare const btoaUniversal: (b: ArrayBuffer) => string;
+export declare function randomIntFromInterval(min: number, max: number): number;
+export declare function randomAddress(): string;
+export declare function makeAddress(input: string): string;
+export declare const JsonParser: {
+  parse: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any;
+  stringify: {
+    (
+      value: any,
+      replacer?: ((this: any, key: string, value: any) => any) | undefined,
+      space?: string | number | undefined
+    ): string;
+    (
+      value: any,
+      replacer?: (string | number)[] | null | undefined,
+      space?: string | number | undefined
+    ): string;
+  };
+};
+/**
+ * Function to compress compiled cairo program
+ *
+ * [Reference](https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/gateway/transaction.py#L54-L58)
+ * @param jsonProgram - json file representing the compiled cairo program
+ * @returns Compressed cairo program
+ */
+export declare function compressProgram(jsonProgram: Program | string): CompressedProgram;

package/utils.js

@@ -0,0 +1,62 @@
+'use strict';
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.compressProgram =
+  exports.JsonParser =
+  exports.makeAddress =
+  exports.randomAddress =
+  exports.randomIntFromInterval =
+  exports.btoaUniversal =
+  exports.isBrowser =
+    void 0;
+var pako_1 = require('pako');
+var json_bigint_1 = __importDefault(require('json-bigint'));
+var constants_1 = require('./constants');
+exports.isBrowser = typeof window !== 'undefined';
+var btoaUniversal = function (b) {
+  return exports.isBrowser
+    ? btoa(String.fromCharCode.apply(null, b))
+    : Buffer.from(b).toString('base64');
+};
+exports.btoaUniversal = btoaUniversal;
+function randomIntFromInterval(min, max) {
+  return Math.floor(Math.random() * (max - min + 1) + min);
+}
+exports.randomIntFromInterval = randomIntFromInterval;
+function randomAddress() {
+  return (
+    '0x' +
+    randomIntFromInterval(
+      constants_1.CONTRACT_ADDRESS_LOWER_BOUND,
+      constants_1.CONTRACT_ADDRESS_UPPER_BOUND
+    ).toString(16)
+  );
+}
+exports.randomAddress = randomAddress;
+function makeAddress(input) {
+  return '0x' + input.replace(/^0x/, '').toLowerCase();
+}
+exports.makeAddress = makeAddress;
+exports.JsonParser = (0, json_bigint_1.default)({
+  alwaysParseAsBig: true,
+  useNativeBigInt: true,
+});
+/**
+ * Function to compress compiled cairo program
+ *
+ * [Reference](https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/gateway/transaction.py#L54-L58)
+ * @param jsonProgram - json file representing the compiled cairo program
+ * @returns Compressed cairo program
+ */
+function compressProgram(jsonProgram) {
+  var stringified =
+    typeof jsonProgram === 'string' ? jsonProgram : exports.JsonParser.stringify(jsonProgram);
+  var compressedProgram = (0, pako_1.gzip)(stringified);
+  var base64 = (0, exports.btoaUniversal)(compressedProgram);
+  return base64;
+}
+exports.compressProgram = compressProgram;

package/.eslintrc.json

@@ -1,26 +0,0 @@
-{
-    "env": {
-        "browser": true,
-        "es2021": true,
-        "node": true,
-        "jest": true
-    },
-    "extends": [
-        "airbnb-base",
-        "prettier",
-        "plugin:prettier/recommended",
-    ],
-    "globals": {
-        "Atomics": "readonly",
-        "SharedArrayBuffer": "readonly"
-    },
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "ecmaVersion": 12,
-        "sourceType": "module"
-    },
-    "plugins": [
-        "@typescript-eslint"
-    ],
-    "rules": {}
-}

package/babel.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript'],
-};

package/dist/__tests__/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/__tests__/index.test.js

@@ -1,49 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var starknet = __importStar(require("../index"));
-describe('starknet endpoints', function () {
-    describe('feeder gateway endpoints', function () {
-        test('getContractAddresses()', function () {
-            return expect(starknet.getContractAddresses()).resolves.not.toThrow();
-        });
-        xtest('callContract()', function () { });
-        test('getBlock()', function () {
-            return expect(starknet.getBlock(46500)).resolves.not.toThrow();
-        });
-        test('getCode()', function () {
-            return expect(starknet.getCode('0x5f778a983bf8760ad37868f4c869d70247c5546044a7f0386df96d8043d4e9d', 46500)).resolves.not.toThrow();
-        });
-        test('getStorageAt()', function () {
-            return expect(starknet.getStorageAt('0x5f778a983bf8760ad37868f4c869d70247c5546044a7f0386df96d8043d4e9d', 0, 46500)).resolves.not.toThrow();
-        });
-        test('getTransactionStatus()', function () {
-            return expect(starknet.getTransactionStatus(286136)).resolves.not.toThrow();
-        });
-        test('getTransaction()', function () {
-            return expect(starknet.getTransaction(286136)).resolves.not.toThrow();
-        });
-        xtest('addTransaction()', function () { });
-    });
-    describe('gateway endpoints', function () {
-        xtest('addTransaction()', function () { });
-    });
-});

package/docs/Home.md

@@ -1,220 +0,0 @@
-# StarkNet.js Docs
-
-## Table of contents
-
-### Functions
-
-- [addTransaction](../wiki/Home#addtransaction)
-- [callContract](../wiki/Home#callcontract)
-- [getBlock](../wiki/Home#getblock)
-- [getCode](../wiki/Home#getcode)
-- [getContractAddresses](../wiki/Home#getcontractaddresses)
-- [getStorageAt](../wiki/Home#getstorageat)
-- [getTransaction](../wiki/Home#gettransaction)
-- [getTransactionStatus](../wiki/Home#gettransactionstatus)
-
-## Functions
-
-### addTransaction
-
-▸ **addTransaction**(`tx`): `Promise`<`object`\>
-
-Invoke a function on the starknet contract
-
-[Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/gateway/gateway_client.py#L13-L17)
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `tx` | `object` | transaction to be invoked (WIP) |
-
-#### Returns
-
-`Promise`<`object`\>
-
-a confirmation of invoking a function on the starknet contract
-
-#### Defined in
-
-[index.ts:156](https://github.com/seanjameshan/starknet.js/blob/8e7389f/src/index.ts#L156)
-
-___
-
-### callContract
-
-▸ **callContract**(`invokeTx`, `blockId`): `Promise`<`object`\>
-
-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)
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `invokeTx` | `object` | transaction to be invoked (WIP) |
-| `blockId` | `number` |  |
-
-#### Returns
-
-`Promise`<`object`\>
-
-the result of the function on the smart contract.
-
-#### Defined in
-
-[index.ts:33](https://github.com/seanjameshan/starknet.js/blob/8e7389f/src/index.ts#L33)
-
-___
-
-### getBlock
-
-▸ **getBlock**(`blockId`): `Promise`<`object`\>
-
-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)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `blockId` | `number` |
-
-#### Returns
-
-`Promise`<`object`\>
-
-the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
-
-#### Defined in
-
-[index.ts:52](https://github.com/seanjameshan/starknet.js/blob/8e7389f/src/index.ts#L52)
-
-___
-
-### getCode
-
-▸ **getCode**(`contractAddress`, `blockId`): `Promise`<`object`\>
-
-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)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `contractAddress` | `string` |
-| `blockId` | `number` |
-
-#### Returns
-
-`Promise`<`object`\>
-
-ABI of compiled contract in JSON
-
-#### Defined in
-
-[index.ts:72](https://github.com/seanjameshan/starknet.js/blob/8e7389f/src/index.ts#L72)
-
-___
-
-### getContractAddresses
-
-▸ **getContractAddresses**(): `Promise`<`object`\>
-
-Gets the smart contract address on the goerli testnet.
-
-[Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L13-L15)
-
-#### Returns
-
-`Promise`<`object`\>
-
-starknet smart contract address
-
-#### Defined in
-
-[index.ts:13](https://github.com/seanjameshan/starknet.js/blob/8e7389f/src/index.ts#L13)
-
-___
-
-### getStorageAt
-
-▸ **getStorageAt**(`contractAddress`, `key`, `blockId`): `Promise`<`object`\>
-
-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)
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `contractAddress` | `string` |  |
-| `key` | `number` | from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP) |
-| `blockId` | `number` |  |
-
-#### Returns
-
-`Promise`<`object`\>
-
-the value of the storage variable
-
-#### Defined in
-
-[index.ts:93](https://github.com/seanjameshan/starknet.js/blob/8e7389f/src/index.ts#L93)
-
-___
-
-### getTransaction
-
-▸ **getTransaction**(`txId`): `Promise`<`object`\>
-
-Gets the transaction information from a tx id.
-
-[Reference](https://github.com/starkware-libs/cairo-lang/blob/f464ec4797361b6be8989e36e02ec690e74ef285/src/starkware/starknet/services/api/feeder_gateway/feeder_gateway_client.py#L54-L58)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `txId` | `number` |
-
-#### Returns
-
-`Promise`<`object`\>
-
-the transacton object { transaction_id, status, transaction, block_id?, block_number?, transaction_index?, transaction_failure_reason? }
-
-#### Defined in
-
-[index.ts:137](https://github.com/seanjameshan/starknet.js/blob/8e7389f/src/index.ts#L137)
-
-___
-
-### getTransactionStatus
-
-▸ **getTransactionStatus**(`txId`): `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)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `txId` | `number` |
-
-#### Returns
-
-`Promise`<`object`\>
-
-the transaction status object { block_id, tx_status: NOT_RECEIVED | RECEIVED | PENDING | REJECTED | ACCEPTED_ONCHAIN }
-
-#### Defined in
-
-[index.ts:118](https://github.com/seanjameshan/starknet.js/blob/8e7389f/src/index.ts#L118)

package/docs/_Sidebar.md

@@ -1,3 +0,0 @@
-## StarkNet.js Docs
-
-- [Home](../wiki/Home)