chiklisp-puzzles 0.1.0__tar.gz

chiklisp_puzzles-0.1.0/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 by Richard Kiss
+
+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.

chiklisp_puzzles-0.1.0/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.1
+Name: chiklisp_puzzles
+Version: 0.1.0
+Summary: Some canonical puzzles deployed on chik-blockchain
+Author-email: Richard Kiss <him@richardkiss.com>
+License: Copyright 2023 by Richard Kiss
+        
+        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.
+        
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# chiklisp_puzzles
+
+This project contains several standard and legacy puzzles commonly used on the chik network.
+
+Note that it uses `enscons` to build, as the more commonly used `setuptools` does not easily allow fine-grained control of the contents of the `sdist` and `wheel` files.
+
+In particular, this example takes pains to include the source files `runtime_build` or `*.clsp` in the sdist but not the wheel.
+
+## Use
+
+To load a puzzle, do something like
+
+```python
+from chiklisp_puzzles import load_puzzle
+
+program = load_puzzle("p2_delegated_puzzle_or_hidden_puzzle")
+```
+
+## License
+- This project is licensed under the Apache 2 License. See the LICENSE file for more details.

chiklisp_puzzles-0.1.0/README.md

@@ -0,0 +1,20 @@
+# chiklisp_puzzles
+
+This project contains several standard and legacy puzzles commonly used on the chik network.
+
+Note that it uses `enscons` to build, as the more commonly used `setuptools` does not easily allow fine-grained control of the contents of the `sdist` and `wheel` files.
+
+In particular, this example takes pains to include the source files `runtime_build` or `*.clsp` in the sdist but not the wheel.
+
+## Use
+
+To load a puzzle, do something like
+
+```python
+from chiklisp_puzzles import load_puzzle
+
+program = load_puzzle("p2_delegated_puzzle_or_hidden_puzzle")
+```
+
+## License
+- This project is licensed under the Apache 2 License. See the LICENSE file for more details.

chiklisp_puzzles-0.1.0/chiklisp_puzzles/__init__.py

@@ -0,0 +1,7 @@
+from klvm_rs import Program
+
+
+def load_puzzle(puzzle_name: str) -> Program:
+    from chiklisp_loader import load_program
+
+    return load_program("chiklisp_puzzles.puzzles", f"{puzzle_name}.hex")

chiklisp_puzzles-0.1.0/chiklisp_puzzles/puzzles/calculate_synthetic_public_key.clsp

@@ -0,0 +1,5 @@
+(mod
+  (public_key hidden_puzzle_hash)
+
+  (point_add public_key (pubkey_for_exp (sha256 public_key hidden_puzzle_hash)))
+)

chiklisp_puzzles-0.1.0/chiklisp_puzzles/puzzles/p2_conditions.clsp

@@ -0,0 +1,3 @@
+(mod (conditions)
+  (qq (q . (unquote conditions)))
+)

chiklisp_puzzles-0.1.0/chiklisp_puzzles/puzzles/p2_delegated_puzzle_or_hidden_puzzle.clsp

@@ -0,0 +1,91 @@
+; build a pay-to delegated puzzle or hidden puzzle
+; coins can be unlocked by signing a delegated puzzle and its solution
+; OR by revealing the hidden puzzle and the underlying original key
+
+; glossary of parameter names:
+
+; hidden_puzzle: a "hidden puzzle" that can be revealed and used as an alternate
+;   way to unlock the underlying funds
+;
+; synthetic_key_offset: a private key cryptographically generated using the hidden
+;   puzzle and as inputs `original_public_key`
+;
+; SYNTHETIC_PUBLIC_KEY: the public key that is the sum of `original_public_key` and the
+;   public key corresponding to `synthetic_key_offset`
+;
+; original_public_key: a public key, where knowledge of the corresponding private key
+;   represents ownership of the file
+;
+; delegated_puzzle: a delegated puzzle, as in "graftroot", which should return the
+;   desired conditions.
+;
+; solution: the solution to the delegated puzzle
+
+
+(mod
+  ; A puzzle should commit to `SYNTHETIC_PUBLIC_KEY`
+  ;
+  ; The solution should pass in 0 for `original_public_key` if it wants to use
+  ; an arbitrary `delegated_puzzle` (and `solution`) signed by the
+  ; `SYNTHETIC_PUBLIC_KEY` (whose corresponding private key can be calculated
+  ; if you know the private key for `original_public_key`)
+  ;
+  ; Or you can solve the hidden puzzle by revealing the `original_public_key`,
+  ; the hidden puzzle in `delegated_puzzle`, and a solution to the hidden puzzle.
+
+  (SYNTHETIC_PUBLIC_KEY original_public_key delegated_puzzle solution)
+
+  ; "assert" is a macro that wraps repeated instances of "if"
+  ; usage: (assert A0 A1 ... An R)
+  ; all of A0, A1, ... An must evaluate to non-null, or an exception is raised
+  ; return the value of R (if we get that far)
+
+  (defmacro assert items
+    (if (r items)
+        (list if (f items) (c assert (r items)) (q . (x)))
+        (f items)
+    )
+  )
+
+  (include condition_codes.clib)
+
+  ;; hash a tree
+  ;; This is used to calculate a puzzle hash given a puzzle program.
+  (defun sha256tree1
+    (TREE)
+    (if (l TREE)
+        (sha256 2 (sha256tree1 (f TREE)) (sha256tree1 (r TREE)))
+        (sha256 1 TREE)
+    )
+  )
+
+  ; "is_hidden_puzzle_correct" returns true iff the hidden puzzle is correctly encoded
+
+  (defun-inline is_hidden_puzzle_correct (SYNTHETIC_PUBLIC_KEY original_public_key delegated_puzzle)
+    (=
+      SYNTHETIC_PUBLIC_KEY
+      (point_add
+        original_public_key
+        (pubkey_for_exp (sha256 original_public_key (sha256tree1 delegated_puzzle)))
+      )
+    )
+  )
+
+  ; "possibly_prepend_aggsig" is the main entry point
+
+  (defun-inline possibly_prepend_aggsig (SYNTHETIC_PUBLIC_KEY original_public_key delegated_puzzle conditions)
+    (if original_public_key
+        (assert
+          (is_hidden_puzzle_correct SYNTHETIC_PUBLIC_KEY original_public_key delegated_puzzle)
+          conditions
+        )
+        (c (list AGG_SIG_ME SYNTHETIC_PUBLIC_KEY (sha256tree1 delegated_puzzle)) conditions)
+    )
+  )
+
+  ; main entry point
+
+  (possibly_prepend_aggsig
+    SYNTHETIC_PUBLIC_KEY original_public_key delegated_puzzle
+  (a delegated_puzzle solution))
+)

chiklisp_puzzles-0.1.0/chiklisp_puzzles/puzzles/runtime_build

@@ -0,0 +1,19 @@
+import pathlib
+
+from chiklisp_builder import ChiklispBuild
+
+from chiklisp_stdlib import STABLE_INCLUDE_DIRECTORY
+
+PUZZLE_PATHS = [
+    pathlib.Path(_)
+    for _ in [
+        "p2_conditions.clsp",
+        "p2_delegated_puzzle_or_hidden_puzzle.clsp",
+        "calculate_synthetic_public_key.clsp",
+    ]
+]
+
+BUILD_ARGUMENTS = {
+    puzzle_path.with_suffix(".hex").name: ChiklispBuild([STABLE_INCLUDE_DIRECTORY])
+    for puzzle_path in PUZZLE_PATHS
+}

chiklisp_puzzles-0.1.0/chiklisp_puzzles.egg-info/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.1
+Name: chiklisp-puzzles
+Version: 0.1.0
+Summary: Some canonical puzzles deployed on chik-blockchain
+Author-email: Richard Kiss <him@richardkiss.com>
+License: Copyright 2023 by Richard Kiss
+        
+        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.
+        
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# chiklisp_puzzles
+
+This project contains several standard and legacy puzzles commonly used on the chik network.
+
+Note that it uses `enscons` to build, as the more commonly used `setuptools` does not easily allow fine-grained control of the contents of the `sdist` and `wheel` files.
+
+In particular, this example takes pains to include the source files `runtime_build` or `*.clsp` in the sdist but not the wheel.
+
+## Use
+
+To load a puzzle, do something like
+
+```python
+from chiklisp_puzzles import load_puzzle
+
+program = load_puzzle("p2_delegated_puzzle_or_hidden_puzzle")
+```
+
+## License
+- This project is licensed under the Apache 2 License. See the LICENSE file for more details.

chiklisp_puzzles-0.1.0/chiklisp_puzzles.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+chiklisp_puzzles/__init__.py
+chiklisp_puzzles.egg-info/PKG-INFO
+chiklisp_puzzles.egg-info/SOURCES.txt
+chiklisp_puzzles.egg-info/dependency_links.txt
+chiklisp_puzzles.egg-info/requires.txt
+chiklisp_puzzles.egg-info/top_level.txt
+chiklisp_puzzles/puzzles/calculate_synthetic_public_key.clsp
+chiklisp_puzzles/puzzles/p2_conditions.clsp
+chiklisp_puzzles/puzzles/p2_delegated_puzzle_or_hidden_puzzle.clsp
+chiklisp_puzzles/puzzles/runtime_build
+tests/test_load.py

chiklisp_puzzles-0.1.0/chiklisp_puzzles.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

chiklisp_puzzles-0.1.0/chiklisp_puzzles.egg-info/requires.txt

@@ -0,0 +1 @@
+chiklisp_loader>=0.1.0

chiklisp_puzzles-0.1.0/chiklisp_puzzles.egg-info/top_level.txt

@@ -0,0 +1 @@
+chiklisp_puzzles

chiklisp_puzzles-0.1.0/pyproject.toml

@@ -0,0 +1,18 @@
+[project]
+name = "chiklisp_puzzles"
+description = "Some canonical puzzles deployed on chik-blockchain"
+authors = [{name = "Richard Kiss", email = "him@richardkiss.com"}]
+license = {file = "LICENSE"}
+readme = "README.md"
+version = "0.1.0"
+dependencies = ["chiklisp_loader>=0.1.0"]
+
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel",
+    "chiklisp_builder>=0.1.0",
+    "chiklisp_stdlib>=0.1.0",
+    "klvm_rs",
+]
+build-backend = "setuptools.build_meta"

chiklisp_puzzles-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

chiklisp_puzzles-0.1.0/setup.py

@@ -0,0 +1,11 @@
+from setuptools import setup, find_packages
+from runtime_builder import build_runtime_setuptools
+
+
+setup(
+    packages=["chiklisp_puzzles", "chiklisp_puzzles.puzzles"],
+    package_data={"chiklisp_puzzles.puzzles": ["*.hex", "*.clsp", "runtime_build"]},
+    cmdclass={
+        "build_runtime_builder_artifacts": build_runtime_setuptools("chiklisp_puzzles.puzzles"),
+    },
+)

chiklisp_puzzles-0.1.0/tests/test_load.py

@@ -0,0 +1,21 @@
+from chiklisp_puzzles import load_puzzle
+
+
+def check(puzzle_name: str, expected_hash: str):
+    program = load_puzzle(puzzle_name)
+    assert program.tree_hash().hex() == expected_hash
+
+
+def test_load():
+    check(
+        "p2_delegated_puzzle_or_hidden_puzzle",
+        "e9aaa49f45bad5c889b86ee3341550c155cfdd10c3a6757de618d20612fffd52",
+    )
+    check(
+        "p2_conditions",
+        "1c77d7d5efde60a7a1d2d27db6d746bc8e568aea1ef8586ca967a0d60b83cc36",
+    )
+    check(
+        "calculate_synthetic_public_key",
+        "624c5d5704d0decadfc0503e71bbffb6cdfe45025bce7cf3e6864d1eafe8f65e",
+    )