starknet 0.1.2 → 1.1.1

package/__tests__/index.test.ts

@@ -1,4 +1,15 @@
-import * as starknet from '../index';
+import fs from 'fs';
+import starknet, {
+  CompiledContract,
+  compressProgram,
+  randomAddress,
+  makeAddress,
+  JsonParser,
+} from '..';
+
+const compiledArgentAccount = JsonParser.parse(
+  fs.readFileSync('./__mocks__/ArgentAccount.json').toString('ascii')
+);
 
 describe('starknet endpoints', () => {
   describe('feeder gateway endpoints', () => {
@@ -29,10 +40,44 @@ describe('starknet endpoints', () => {
     test('getTransaction()', () => {
       return expect(starknet.getTransaction(286136)).resolves.not.toThrow();
     });
-    xtest('addTransaction()', () => {});
   });
 
-  describe('gateway endpoints', () => {
-    xtest('addTransaction()', () => {});
+  describe('addTransaction()', () => {
+    test('type: "DEPLOY"', async () => {
+      const inputContract = compiledArgentAccount as unknown as CompiledContract;
+
+      const contractDefinition = {
+        ...inputContract,
+        program: compressProgram(inputContract.program),
+      };
+
+      const response = await starknet.addTransaction({
+        type: 'DEPLOY',
+        contract_address: randomAddress(),
+        contract_definition: contractDefinition,
+      });
+      expect(response.code).toBe('TRANSACTION_RECEIVED');
+      expect(response.tx_id).toBeGreaterThan(0);
+
+      // I want to show the tx number to the tester, so he/she can trace the transaction in the explorer.
+      // eslint-disable-next-line no-console
+      console.log('txId:', response.tx_id);
+    });
+    xtest('type: "INVOKE_FUNCTION"', () => {});
+
+    test('deployContract()', async () => {
+      const inputContract = compiledArgentAccount as unknown as CompiledContract;
+
+      const response = await starknet.deployContract(
+        inputContract,
+        makeAddress('0x20b5B1b8aFd65F1FCB755a449000cFC4aBCA0D40')
+      );
+      expect(response.code).toBe('TRANSACTION_RECEIVED');
+      expect(response.tx_id).toBeGreaterThan(0);
+
+      // I want to show the tx number to the tester, so he/she can trace the transaction in the explorer.
+      // eslint-disable-next-line no-console
+      console.log('txId:', response.tx_id);
+    });
   });
 });

package/__tests__/utils.browser.test.ts

@@ -0,0 +1,30 @@
+/**
+ * @jest-environment jsdom
+ */
+
+import fs from 'fs';
+import { compressProgram, isBrowser, JsonParser } from '..';
+
+const compiledArgentAccount = JsonParser.parse(
+  fs.readFileSync('./__mocks__/ArgentAccount.json').toString('ascii')
+);
+
+test('isBrowser', () => {
+  expect(isBrowser).toBe(true);
+});
+describe('compressProgram()', () => {
+  test('compresses a contract program', () => {
+    const inputContract = compiledArgentAccount as any;
+
+    const compressed = compressProgram(inputContract.program);
+
+    expect(compressed).toMatchSnapshot();
+  });
+  test('works with strings', () => {
+    const inputProgram = JsonParser.stringify(compiledArgentAccount.program);
+
+    const compressed = compressProgram(inputProgram);
+
+    expect(compressed).toMatchSnapshot();
+  });
+});

package/__tests__/utils.test.ts

@@ -0,0 +1,35 @@
+import fs from 'fs';
+import { compressProgram, makeAddress, isBrowser, JsonParser } from '..';
+
+const compiledArgentAccount = JsonParser.parse(
+  fs.readFileSync('./__mocks__/ArgentAccount.json').toString('ascii')
+);
+
+test('isNode', () => {
+  expect(isBrowser).toBe(false);
+});
+describe('compressProgram()', () => {
+  test('compresses a contract program', () => {
+    const inputProgram = compiledArgentAccount.program;
+
+    const compressed = compressProgram(inputProgram);
+
+    expect(compressed).toMatchSnapshot();
+  });
+  test('works with strings', () => {
+    const inputProgram = JsonParser.stringify(compiledArgentAccount.program);
+
+    const compressed = compressProgram(inputProgram);
+
+    expect(compressed).toMatchSnapshot();
+  });
+});
+describe('makeAddress()', () => {
+  test('test on eth address', () => {
+    const ethAddress = '0xdFD0F27FCe99b50909de0bDD328Aed6eAbe76BC5';
+
+    const starkAddress = makeAddress(ethAddress);
+
+    expect(starkAddress).toBe('0xdfd0f27fce99b50909de0bdd328aed6eabe76bc5');
+  });
+});

package/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const CONTRACT_ADDRESS_BITS = 251;
+export declare const CONTRACT_ADDRESS_LOWER_BOUND = 1;
+export declare const CONTRACT_ADDRESS_UPPER_BOUND: number;

package/constants.js

@@ -0,0 +1,9 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.CONTRACT_ADDRESS_UPPER_BOUND =
+  exports.CONTRACT_ADDRESS_LOWER_BOUND =
+  exports.CONTRACT_ADDRESS_BITS =
+    void 0;
+exports.CONTRACT_ADDRESS_BITS = 251;
+exports.CONTRACT_ADDRESS_LOWER_BOUND = 1;
+exports.CONTRACT_ADDRESS_UPPER_BOUND = Math.pow(2, exports.CONTRACT_ADDRESS_BITS);

package/dist/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const CONTRACT_ADDRESS_BITS = 251;
+export declare const CONTRACT_ADDRESS_LOWER_BOUND = 1;
+export declare const CONTRACT_ADDRESS_UPPER_BOUND: number;

package/dist/constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONTRACT_ADDRESS_UPPER_BOUND = exports.CONTRACT_ADDRESS_LOWER_BOUND = exports.CONTRACT_ADDRESS_BITS = void 0;
+exports.CONTRACT_ADDRESS_BITS = 251;
+exports.CONTRACT_ADDRESS_LOWER_BOUND = 1;
+exports.CONTRACT_ADDRESS_UPPER_BOUND = Math.pow(2, exports.CONTRACT_ADDRESS_BITS);

package/dist/index.d.ts

@@ -1,10 +1,12 @@
+import { compressProgram } from './utils';
+import type { GetBlockResponse, GetCode, GetContractAddressesResponse, GetTransactionResponse, GetTransactionStatusResponse, Transaction, AddTransactionResponse, CompiledContract } from './types';
 /**
  * Gets the smart contract address on the goerli testnet.
  *
- * 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
+ * [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
  */
-export declare function getContractAddresses(): Promise<object>;
+export declare function getContractAddresses(): Promise<GetContractAddressesResponse>;
 /**
  * Calls a function on the StarkNet contract.
  *
@@ -23,7 +25,7 @@ export declare function callContract(invokeTx: object, blockId: number): Promise
  * @param blockId
  * @returns the block object { block_id, previous_block_id, state_root, status, timestamp, transaction_receipts, transactions }
  */
-export declare function getBlock(blockId: number): Promise<object>;
+export declare function getBlock(blockId: number): Promise<GetBlockResponse>;
 /**
  * Gets the code of the deployed contract.
  *
@@ -31,9 +33,9 @@ export declare 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 declare function getCode(contractAddress: string, blockId: number): Promise<object>;
+export declare function getCode(contractAddress: string, blockId: number): Promise<GetCode>;
 /**
  * Gets the contract's storage variable at a specific key.
  *
@@ -53,7 +55,7 @@ export declare function getStorageAt(contractAddress: string, key: number, block
  * @param txId
  * @returns the transaction status object { block_id, tx_status: NOT_RECEIVED | RECEIVED | PENDING | REJECTED | ACCEPTED_ONCHAIN }
  */
-export declare function getTransactionStatus(txId: number): Promise<object>;
+export declare function getTransactionStatus(txId: number): Promise<GetTransactionStatusResponse>;
 /**
  * Gets the transaction information from a tx id.
  *
@@ -62,7 +64,7 @@ export declare 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 declare function getTransaction(txId: number): Promise<object>;
+export declare function getTransaction(txId: number): Promise<GetTransactionResponse>;
 /**
  * Invoke a function on the starknet contract
  *
@@ -71,7 +73,17 @@ export declare 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 declare function addTransaction(tx: object): Promise<object>;
+export declare function addTransaction(tx: Transaction): Promise<AddTransactionResponse>;
+/**
+ * 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 declare function deployContract(contract: CompiledContract | string, address?: string): Promise<AddTransactionResponse>;
+export * from './utils';
+export * from './types';
 declare const _default: {
     getContractAddresses: typeof getContractAddresses;
     callContract: typeof callContract;
@@ -81,5 +93,7 @@ declare const _default: {
     getTransactionStatus: typeof getTransactionStatus;
     getTransaction: typeof getTransaction;
     addTransaction: typeof addTransaction;
+    compressProgram: typeof compressProgram;
+    deployContract: typeof deployContract;
 };
 export default _default;

package/dist/index.js

@@ -1,18 +1,40 @@
 "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.addTransaction = exports.getTransaction = exports.getTransactionStatus = exports.getStorageAt = exports.getCode = exports.getBlock = exports.callContract = exports.getContractAddresses = void 0;
+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 API_URL = 'https://alpha2.starknet.io/';
+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.
  *
- * 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
+ * [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) {
@@ -25,6 +47,7 @@ function getContractAddresses() {
     });
 }
 exports.getContractAddresses = getContractAddresses;
+// TODO: add proper type
 /**
  * Calls a function on the StarkNet contract.
  *
@@ -71,7 +94,7 @@ exports.getBlock = getBlock;
  *
  * @param contractAddress
  * @param blockId
- * @returns ABI of compiled contract in JSON
+ * @returns Bytecode and ABI of compiled contract
  */
 function getCode(contractAddress, blockId) {
     return new Promise(function (resolve, reject) {
@@ -84,6 +107,7 @@ function getCode(contractAddress, blockId) {
     });
 }
 exports.getCode = getCode;
+// TODO: add proper type
 /**
  * Gets the contract's storage variable at a specific key.
  *
@@ -162,6 +186,26 @@ function addTransaction(tx) {
     });
 }
 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,
@@ -171,4 +215,6 @@ exports.default = {
     getTransactionStatus: getTransactionStatus,
     getTransaction: getTransaction,
     addTransaction: addTransaction,
+    compressProgram: utils_1.compressProgram,
+    deployContract: deployContract,
 };

package/dist/types.d.ts

@@ -0,0 +1,89 @@
+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/dist/types.js

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

package/dist/utils.d.ts

@@ -0,0 +1,21 @@
+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/dist/utils.js

@@ -0,0 +1,44 @@
+"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;