StarkPerpetual v3.1

CMakeLists.txt

@@ -1,18 +1,9 @@
-cmake_minimum_required (VERSION 3.5)
+cmake_minimum_required (VERSION 3.22)
 
 project(StarkEx-Perpetual VERSION 0.1.0)
-include(CTest)
 
-enable_testing()
-
-if (NOT DEFINED CMAKE_BUILD_TYPE)
-    set(CMAKE_BUILD_TYPE Debug)
-endif()
-
-# Python library macro.
-find_program(PYTHON "python3")
-
-include("src/cmake_utils/cmake_rules.cmake")
+include(CMakeLists_common.txt)
 include("src/starkware/cairo/lang/cairo_cmake_rules.cmake")
 
+
 add_subdirectory(src)

CMakeLists_common.txt

@@ -0,0 +1,16 @@
+set (PYTHON_COMMAND python3.9)
+
+include(CTest)
+
+enable_testing()
+
+if (NOT DEFINED CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE Debug)
+endif()
+
+# Python library macro.
+find_program(PYTHON "python3")
+
+include("src/cmake_utils/cmake_rules.cmake")
+
+

Dockerfile

@@ -1,16 +1,26 @@
-FROM ubuntu:18.04
+FROM ciimage/python:3.9 as base_image
 
-RUN apt update
-RUN apt install -y cmake python3.7 libgmp3-dev g++ python3-pip python3.7-dev npm
+RUN apt update && apt install -y make libgmp3-dev g++ python3-pip python3.9-dev npm unzip
+# Installing cmake via apt doesn't bring the most up-to-date version.
+RUN pip install cmake==3.22
+RUN curl -sL https://deb.nodesource.com/setup_12.x -o nodesource_setup.sh && bash nodesource_setup.sh && apt install -y nodejs
 
 COPY . /app/
 
 # Build.
 WORKDIR /app/
+RUN rm -rf build
 RUN ./build.sh
 
+FROM base_image
+
 # Run tests.
 WORKDIR /app/build/Release
 RUN ctest -V
 
+WORKDIR /app/src/services/perpetual/public/js/
+RUN npm install -g yarn
+RUN yarn install
+RUN yarn test
+
 WORKDIR /app/

LICENSE

@@ -1,14 +1,201 @@
-The files in this repository are governed by several licenses,
-which are located under the licenses/ directory.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-All code in this project except for the files under
-'src/starkware/cairo/' and its subdirectories is
-subject to the Apache License,
-which can be found under 'licenses/ApacheLicense.txt'.
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-The code under 'src/starkware/cairo/' and its subdirectories is
-subject to the Cairo Toolchain License (Source Available), which
-can be found under 'licenses/CairoToolchainLicense.txt'.
+   1. Definitions.
 
-For more information regarding licenses visit
-https://starkware.co/licenses/.
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 StarkWare Industries Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -1,10 +1,44 @@
-# Stark Exchange Perpetual Resources
+# StarkEx Perpetual Resources
 
-StarkEx is a STARK-powered scalability engine for crypto exchanges. StarkEx uses cryptographic
-proofs to attest to the validity of a batch of transactions (such as trades and transfers)
-and updates a commitment to the state of the exchange onchain.
+## Overview
+​
+This repository contains the Cairo code and a collection of tools used by StarkEx Perpetual,
+StarkWare's scalability solution for derivatives trading.
+If you are not familiar with StarkEx, you can read more about it [here](https://docs.starkware.co/starkex/).
 
-StarkEx allows exchanges to provide non-custodial trading at scale with high liquidity and lower
-costs.
+Note: The Cairo code that proves spot trading, can be found [in another repo](https://github.com/starkware-libs/starkex-for-spot-trading).
 
-This repo holds the Cairo program and a collection of tools to support StarkPerpetual - the Stark Exchange for derivatives trading.
+If you are not familiar with the Cairo language, you can find more details about it [here](https://www.cairo-lang.org/).
+
+The Cairo code is published to allow a permissionless audit of StarkEx business logic,
+as enforced by the StarkEx smart-contract
+
+
+## Repository Contents
+​
+**src/starkware/cairo/dex**, **src/services/exchange/cairo**, **src/services/perpetual/cairo**
+The full Cairo program that StarkEx Perpetual executes.
+It includes a Python file, *generate_program_hash_test.py*, that calculates the hash of the
+Cairo code and compares it to the pre-calculated value found at *program_hash.json*
+​
+
+**src/starkware/crypto/starkware/crypto/signature**, **src/services/perpetual/public**
+The Python implementation of the cryptographic primitives used by StarkEx.
+These implementations, or equivalent implementations in other languages such as JS, are used by StarkEx user's wallets in order to generate and sign on orders.
+
+
+### Usage:
+​
+1. Run the repo's tests by running the command:\
+    `docker build .`
+
+2. Verify that the same hash is used by StarkEx on Mainnet by running the script
+*src/services/extract_cairo_hash.py* in the following way:\
+    `./src/services/exchange/extract_cairo_hash.py --main_address <checksummed_main_address> --node_endpoint <your_node_endpoint> `
+​
+
+You can find the relevant addresses and current versions for the
+different StarkEx deployments [here](https://docs.starkware.co/starkex/deployments-addresses.html).
+
+When comparing the hash, please make sure you checkout the tag that corresponds to the
+deployed version from this repo.

bazel_utils/gen_python_exe.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+
+"""
+A helper script for python.bzl.
+Generates an executable file that runs a python module.
+"""
+
+from argparse import ArgumentParser
+
+
+def main():
+    parser = ArgumentParser(description="Generates an executable file for py_exe().")
+    parser.add_argument("--name", help="The name of the target", required=True)
+    parser.add_argument("--module", help="The name of the module to run", required=True)
+    args = parser.parse_args()
+
+    print(
+        f"""\
+import os
+import subprocess
+import sys
+
+cmd = [
+    sys.executable, "-u", "-m", {args.module!r}
+] + sys.argv[1:]
+proc = subprocess.run(cmd)
+sys.exit(proc.returncode)
+"""
+    )
+
+
+if __name__ == "__main__":
+    main()

bazel_utils/pytest_wrapper.py

@@ -0,0 +1,7 @@
+import sys
+
+import pytest
+
+# if using 'bazel test ...'
+if __name__ == "__main__":
+    sys.exit(pytest.main(sys.argv[1:]))