starknet 0.1.4 → 1.1.0

package/index.js

@@ -0,0 +1,261 @@
+'use strict';
+var __assign =
+  (this && this.__assign) ||
+  function () {
+    __assign =
+      Object.assign ||
+      function (t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+          s = arguments[i];
+          for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+        }
+        return t;
+      };
+    return __assign.apply(this, arguments);
+  };
+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 __exportStar =
+  (this && this.__exportStar) ||
+  function (m, exports) {
+    for (var p in m)
+      if (p !== 'default' && !Object.prototype.hasOwnProperty.call(exports, p))
+        __createBinding(exports, m, p);
+  };
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.deployContract =
+  exports.addTransaction =
+  exports.getTransaction =
+  exports.getTransactionStatus =
+  exports.getStorageAt =
+  exports.getCode =
+  exports.getBlock =
+  exports.callContract =
+  exports.getContractAddresses =
+    void 0;
+var axios_1 = __importDefault(require('axios'));
+var utils_1 = require('./utils');
+var API_URL = 'https://alpha2.starknet.io';
+var FEEDER_GATEWAY_URL = API_URL + '/feeder_gateway';
+var GATEWAY_URL = API_URL + '/gateway';
+/**
+ * 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 starknet smart contract addresses
+ */
+function getContractAddresses() {
+  return new Promise(function (resolve, reject) {
+    axios_1.default
+      .get(FEEDER_GATEWAY_URL + '/get_contract_addresses')
+      .then(function (resp) {
+        resolve(resp.data);
+      })
+      .catch(reject);
+  });
+}
+exports.getContractAddresses = getContractAddresses;
+// TODO: add proper type
+/**
+ * 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)
+ *
+ * @param invokeTx - transaction to be invoked (WIP)
+ * @param blockId
+ * @returns the result of the function on the smart contract.
+ */
+function callContract(invokeTx, blockId) {
+  return new Promise(function (resolve, reject) {
+    axios_1.default
+      .post(FEEDER_GATEWAY_URL + '/call_contract?blockId=' + blockId, invokeTx)
+      .then(function (resp) {
+        resolve(resp.data);
+      })
+      .catch(reject);
+  });
+}
+exports.callContract = callContract;
+/**
+ * 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 }
+ */
+function getBlock(blockId) {
+  return new Promise(function (resolve, reject) {
+    axios_1.default
+      .get(FEEDER_GATEWAY_URL + '/get_block?blockId=' + blockId)
+      .then(function (resp) {
+        resolve(resp.data);
+      })
+      .catch(reject);
+  });
+}
+exports.getBlock = getBlock;
+/**
+ * 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
+ * @returns Bytecode and ABI of compiled contract
+ */
+function getCode(contractAddress, blockId) {
+  return new Promise(function (resolve, reject) {
+    axios_1.default
+      .get(
+        FEEDER_GATEWAY_URL + '/get_code?contractAddress=' + contractAddress + '&blockId=' + blockId
+      )
+      .then(function (resp) {
+        resolve(resp.data);
+      })
+      .catch(reject);
+  });
+}
+exports.getCode = getCode;
+// TODO: add proper type
+/**
+ * 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)
+ *
+ * @param contractAddress
+ * @param key - from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
+ * @param blockId
+ * @returns the value of the storage variable
+ */
+function getStorageAt(contractAddress, key, blockId) {
+  return new Promise(function (resolve, reject) {
+    axios_1.default
+      .get(
+        FEEDER_GATEWAY_URL +
+          '/get_storage_at?contractAddress=' +
+          contractAddress +
+          '&key=' +
+          key +
+          '&blockId=' +
+          blockId
+      )
+      .then(function (resp) {
+        resolve(resp.data);
+      })
+      .catch(reject);
+  });
+}
+exports.getStorageAt = getStorageAt;
+/**
+ * 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 txId
+ * @returns the transaction status object { block_id, tx_status: NOT_RECEIVED | RECEIVED | PENDING | REJECTED | ACCEPTED_ONCHAIN }
+ */
+function getTransactionStatus(txId) {
+  return new Promise(function (resolve, reject) {
+    axios_1.default
+      .get(FEEDER_GATEWAY_URL + '/get_transaction_status?transactionId=' + txId)
+      .then(function (resp) {
+        resolve(resp.data);
+      })
+      .catch(reject);
+  });
+}
+exports.getTransactionStatus = getTransactionStatus;
+/**
+ * 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)
+ *
+ * @param txId
+ * @returns the transacton object { transaction_id, status, transaction, block_id?, block_number?, transaction_index?, transaction_failure_reason? }
+ */
+function getTransaction(txId) {
+  return new Promise(function (resolve, reject) {
+    axios_1.default
+      .get(FEEDER_GATEWAY_URL + '/get_transaction?transactionId=' + txId)
+      .then(function (resp) {
+        resolve(resp.data);
+      })
+      .catch(reject);
+  });
+}
+exports.getTransaction = getTransaction;
+/**
+ * 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)
+ *
+ * @param tx - transaction to be invoked (WIP)
+ * @returns a confirmation of invoking a function on the starknet contract
+ */
+function addTransaction(tx) {
+  return new Promise(function (resolve, reject) {
+    axios_1.default
+      .post(GATEWAY_URL + '/add_transaction', tx)
+      .then(function (resp) {
+        resolve(resp.data);
+      })
+      .catch(reject);
+  });
+}
+exports.addTransaction = addTransaction;
+/**
+ * Deploys a given compiled contract (json) to starknet
+ *
+ * @param contract - a json object containing the compiled contract
+ * @param address - (optional, defaults to a random address) the address where the contract should be deployed (alpha)
+ * @returns a confirmation of sending a transaction on the starknet contract
+ */
+function deployContract(contract, address) {
+  if (address === void 0) {
+    address = (0, utils_1.randomAddress)();
+  }
+  var parsedContract = typeof contract === 'string' ? utils_1.JsonParser.parse(contract) : contract;
+  var contractDefinition = __assign(__assign({}, parsedContract), {
+    program: (0, utils_1.compressProgram)(parsedContract.program),
+  });
+  return addTransaction({
+    type: 'DEPLOY',
+    contract_address: address,
+    contract_definition: contractDefinition,
+  });
+}
+exports.deployContract = deployContract;
+__exportStar(require('./utils'), exports);
+__exportStar(require('./types'), exports);
+exports.default = {
+  getContractAddresses: getContractAddresses,
+  callContract: callContract,
+  getBlock: getBlock,
+  getCode: getCode,
+  getStorageAt: getStorageAt,
+  getTransactionStatus: getTransactionStatus,
+  getTransaction: getTransaction,
+  addTransaction: addTransaction,
+  compressProgram: utils_1.compressProgram,
+  deployContract: deployContract,
+};

package/package.json

@@ -1,15 +1,19 @@
 {
   "name": "starknet",
-  "version": "0.1.4",
+  "version": "1.1.0",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "prepare": "npm run build",
+    "prepare": "npm run build && husky install",
     "build": "tsc",
+    "pretest": "npm run lint",
     "test": "jest",
+    "posttest": "npm run format",
     "test:watch": "jest --watch",
-    "docs": "typedoc --theme ./node_modules/typedoc-github-wiki-theme/dist --readme none --name 'StarkNet.js Docs' --excludeNotDocumented"
+    "docs": "typedoc --readme none --name 'StarkNet.js Docs' --excludeNotDocumented --disableSources",
+    "format": "prettier --loglevel warn --write \"**/*.{ts,js,md,yml,json}\"",
+    "lint": "eslint . --cache --fix --ext .ts"
   },
   "keywords": [
     "starknet",
@@ -24,22 +28,42 @@
   "devDependencies": {
     "@babel/preset-env": "^7.15.8",
     "@babel/preset-typescript": "^7.15.0",
+    "@commitlint/cli": "^13.2.1",
+    "@commitlint/config-conventional": "^13.2.0",
+    "@semantic-release/changelog": "^6.0.0",
+    "@semantic-release/commit-analyzer": "^9.0.1",
+    "@semantic-release/git": "^10.0.0",
+    "@semantic-release/npm": "^8.0.2",
+    "@semantic-release/release-notes-generator": "^10.0.2",
     "@types/jest": "^27.0.2",
+    "@types/json-bigint": "^1.0.1",
+    "@types/pako": "^1.0.2",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
     "eslint": "^7.32.0",
     "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-config-airbnb-typescript": "^14.0.1",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.25.2",
     "eslint-plugin-prettier": "^4.0.0",
+    "husky": "^7.0.2",
     "jest": "^27.3.0",
+    "lint-staged": "^11.2.3",
     "prettier": "^2.4.1",
     "typedoc": "^0.22.6",
-    "typedoc-github-wiki-theme": "^0.6.0",
     "typedoc-plugin-markdown": "^3.11.3",
     "typescript": "^4.4.4"
   },
   "dependencies": {
-    "axios": "^0.23.0"
+    "axios": "^0.23.0",
+    "json-bigint": "^1.0.0",
+    "pako": "^2.0.4"
+  },
+  "lint-staged": {
+    "*.ts": "eslint --cache --fix",
+    "*.{ts,js,md,yml,json}": "prettier --write"
+  },
+  "jest": {
+    "testTimeout": 20000
   }
 }

package/src/constants.ts

@@ -0,0 +1,3 @@
+export const CONTRACT_ADDRESS_BITS = 251;
+export const CONTRACT_ADDRESS_LOWER_BOUND = 1;
+export const CONTRACT_ADDRESS_UPPER_BOUND = 2 ** CONTRACT_ADDRESS_BITS;

package/src/index.ts

@@ -1,26 +1,38 @@
 import axios from 'axios';
+import { randomAddress, compressProgram, JsonParser } from './utils';
+import type {
+  GetBlockResponse,
+  GetCode,
+  GetContractAddressesResponse,
+  GetTransactionResponse,
+  GetTransactionStatusResponse,
+  Transaction,
+  AddTransactionResponse,
+  CompiledContract,
+} from './types';
 
-const API_URL: string = 'https://alpha2.starknet.io/';
-const FEEDER_GATEWAY_URL: string = `${API_URL}/feeder_gateway`;
-const GATEWAY_URL: string = `${API_URL}/gateway`;
+const API_URL = 'https://alpha2.starknet.io';
+const FEEDER_GATEWAY_URL = `${API_URL}/feeder_gateway`;
+const GATEWAY_URL = `${API_URL}/gateway`;
 
 /**
  * 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 starknet smart contract address
+ * @returns starknet smart contract addresses
  */
-export function getContractAddresses(): Promise<object> {
+export function getContractAddresses(): Promise<GetContractAddressesResponse> {
   return new Promise((resolve, reject) => {
     axios
-      .get(`${FEEDER_GATEWAY_URL}/get_contract_addresses`)
-      .then((resp: any) => {
+      .get<GetContractAddressesResponse>(`${FEEDER_GATEWAY_URL}/get_contract_addresses`)
+      .then((resp) => {
         resolve(resp.data);
       })
       .catch(reject);
   });
 }
 
+// TODO: add proper type
 /**
  * Calls a function on the StarkNet contract.
  *
@@ -49,10 +61,10 @@ export function callContract(invokeTx: object, blockId: number): Promise<object>
  * @param blockId
  * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
  */
-export function getBlock(blockId: number): Promise<object> {
+export function getBlock(blockId: number): Promise<GetBlockResponse> {
   return new Promise((resolve, reject) => {
     axios
-      .get(`${FEEDER_GATEWAY_URL}/get_block?blockId=${blockId}`)
+      .get<GetBlockResponse>(`${FEEDER_GATEWAY_URL}/get_block?blockId=${blockId}`)
       .then((resp: any) => {
         resolve(resp.data);
       })
@@ -67,19 +79,22 @@ export function getBlock(blockId: number): Promise<object> {
  *
  * @param contractAddress
  * @param blockId
- * @returns ABI of compiled contract in JSON
+ * @returns Bytecode and ABI of compiled contract
  */
-export function getCode(contractAddress: string, blockId: number): Promise<object> {
+export function getCode(contractAddress: string, blockId: number): Promise<GetCode> {
   return new Promise((resolve, reject) => {
     axios
-      .get(`${FEEDER_GATEWAY_URL}/get_code?contractAddress=${contractAddress}&blockId=${blockId}`)
-      .then((resp: any) => {
+      .get<GetCode>(
+        `${FEEDER_GATEWAY_URL}/get_code?contractAddress=${contractAddress}&blockId=${blockId}`
+      )
+      .then((resp) => {
         resolve(resp.data);
       })
       .catch(reject);
   });
 }
 
+// TODO: add proper type
 /**
  * Gets the contract's storage variable at a specific key.
  *
@@ -115,11 +130,13 @@ export function getStorageAt(
  * @param txId
  * @returns the transaction status object { block_id, tx_status: NOT_RECEIVED | RECEIVED | PENDING | REJECTED | ACCEPTED_ONCHAIN }
  */
-export function getTransactionStatus(txId: number): Promise<object> {
+export function getTransactionStatus(txId: number): Promise<GetTransactionStatusResponse> {
   return new Promise((resolve, reject) => {
     axios
-      .get(`${FEEDER_GATEWAY_URL}/get_transaction_status?transactionId=${txId}`)
-      .then((resp: any) => {
+      .get<GetTransactionStatusResponse>(
+        `${FEEDER_GATEWAY_URL}/get_transaction_status?transactionId=${txId}`
+      )
+      .then((resp) => {
         resolve(resp.data);
       })
       .catch(reject);
@@ -134,11 +151,11 @@ export function getTransactionStatus(txId: number): Promise<object> {
  * @param txId
  * @returns the transacton object { transaction_id, status, transaction, block_id?, block_number?, transaction_index?, transaction_failure_reason? }
  */
-export function getTransaction(txId: number): Promise<object> {
+export function getTransaction(txId: number): Promise<GetTransactionResponse> {
   return new Promise((resolve, reject) => {
     axios
-      .get(`${FEEDER_GATEWAY_URL}/get_transaction?transactionId=${txId}`)
-      .then((resp: any) => {
+      .get<GetTransactionResponse>(`${FEEDER_GATEWAY_URL}/get_transaction?transactionId=${txId}`)
+      .then((resp) => {
         resolve(resp.data);
       })
       .catch(reject);
@@ -153,7 +170,7 @@ export function getTransaction(txId: number): Promise<object> {
  * @param tx - transaction to be invoked (WIP)
  * @returns a confirmation of invoking a function on the starknet contract
  */
-export function addTransaction(tx: object): Promise<object> {
+export function addTransaction(tx: Transaction): Promise<AddTransactionResponse> {
   return new Promise((resolve, reject) => {
     axios
       .post(`${GATEWAY_URL}/add_transaction`, tx)
@@ -164,6 +181,33 @@ export function addTransaction(tx: object): Promise<object> {
   });
 }
 
+/**
+ * Deploys a given compiled contract (json) to starknet
+ *
+ * @param contract - a json object containing the compiled contract
+ * @param address - (optional, defaults to a random address) the address where the contract should be deployed (alpha)
+ * @returns a confirmation of sending a transaction on the starknet contract
+ */
+export function deployContract(
+  contract: CompiledContract | string,
+  address: string = randomAddress()
+): Promise<AddTransactionResponse> {
+  const parsedContract =
+    typeof contract === 'string' ? (JsonParser.parse(contract) as CompiledContract) : contract;
+  const contractDefinition = {
+    ...parsedContract,
+    program: compressProgram(parsedContract.program),
+  };
+
+  return addTransaction({
+    type: 'DEPLOY',
+    contract_address: address,
+    contract_definition: contractDefinition,
+  });
+}
+
+export * from './utils';
+export * from './types';
 export default {
   getContractAddresses,
   callContract,
@@ -173,4 +217,6 @@ export default {
   getTransactionStatus,
   getTransaction,
   addTransaction,
+  compressProgram,
+  deployContract,
 };

package/src/types.ts

@@ -0,0 +1,95 @@
+export interface GetContractAddressesResponse {
+  Starknet: string;
+  GpsStatementVerifier: string;
+}
+
+export type Status = 'NOT_RECEIVED' | 'RECEIVED' | 'PENDING' | 'REJECTED' | 'ACCEPTED_ONCHAIN';
+export type TxStatus = 'TRANSACTION_RECEIVED';
+export type Type = 'DEPLOY' | 'INVOKE_FUNCTION';
+export type EntryPointType = 'EXTERNAL';
+export type CompressedProgram = string;
+
+export interface Abi {
+  inputs: { name: string; type: string }[];
+  name: string;
+  outputs: { name: string; type: string }[];
+  type: string;
+}
+export type EntryPointsByType = object;
+export 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 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/src/utils.ts

@@ -0,0 +1,44 @@
+import { gzip } from 'pako';
+import Json from 'json-bigint';
+import { CompressedProgram, Program } from './types';
+import { CONTRACT_ADDRESS_LOWER_BOUND, CONTRACT_ADDRESS_UPPER_BOUND } from './constants';
+
+export const isBrowser = typeof window !== 'undefined';
+
+export const btoaUniversal = (b: ArrayBuffer): string =>
+  isBrowser ? btoa(String.fromCharCode.apply(null, b as any)) : Buffer.from(b).toString('base64');
+
+export function randomIntFromInterval(min: number, max: number) {
+  return Math.floor(Math.random() * (max - min + 1) + min);
+}
+
+export function randomAddress(): string {
+  return `0x${randomIntFromInterval(
+    CONTRACT_ADDRESS_LOWER_BOUND,
+    CONTRACT_ADDRESS_UPPER_BOUND
+  ).toString(16)}`;
+}
+
+export function makeAddress(input: string): string {
+  return `0x${input.replace(/^0x/, '').toLowerCase()}`;
+}
+
+export const JsonParser = Json({
+  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
+ */
+export function compressProgram(jsonProgram: Program | string): CompressedProgram {
+  const stringified =
+    typeof jsonProgram === 'string' ? jsonProgram : JsonParser.stringify(jsonProgram);
+  const compressedProgram = gzip(stringified);
+  const base64 = btoaUniversal(compressedProgram);
+  return base64;
+}

package/tsconfig.eslint.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src/**/*", "__tests__/**/*"]
+}