PyMavryk docs refactored

Author: TristanAllaire

README.md

@@ -1,9 +1,9 @@
 # PyMavryk
 
-[![Twitter](https://badgen.net/badge/icon/TezosBakingBad?icon=twitter&label=)](https://twitter.com/TezosBakingBad)
-[![Monthly downloads](https://static.pepy.tech/badge/pytezos/month)](https://pepy.tech/project/pytezos)
+[![Twitter](https://badgen.net/badge/icon/MavrykDynamics?icon=twitter&label=)](https://twitter.com/MavrykDynamics)
+[![Monthly downloads](https://static.pepy.tech/badge/pymavryk/month)](https://pepy.tech/project/pymavryk)
 [![GitHub stars](https://img.shields.io/github/stars/mavryk-network/pymavryk?color=2c2c2c&style=plain)](https://github.com/mavryk-network/pymavryk)
-[![Python Version](https://img.shields.io/pypi/pyversions/pytezos?color=2c2c2c)](https://www.python.org)
+[![Python Version](https://img.shields.io/pypi/pyversions/pymavryk?color=2c2c2c)](https://www.python.org)
 <br>
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/mavryk-network/pymavryk/master?filepath=michelson_quickstart.ipynb)
 [![License: MIT](https://img.shields.io/github/license/mavryk-network/pymavryk?color=2c2c2c)](https://github.com/mavryk-network/pymavryk/blob/next/LICENSE)
@@ -157,20 +157,6 @@ If you are working in Jupyter/Google Colab or any other interactive console, you
 >>> pymavryk
 ```
 
-### Publications
-
-* Pymavryk 2.0 release with embedded docs and smart contract interaction engine  
-https://medium.com/coinmonks/high-level-interface-for-michelson-contracts-and-not-only-7264db76d7ae
-
-* Materials from TQuorum:Berlin workshop - building an app on top of PyMavryk and ConseilPy  
-https://medium.com/coinmonks/atomic-tips-berlin-workshop-materials-c5c8ee3f46aa
-
-* Materials from the EETH hackathon - setting up a local development infrastructure, deploying and interacting with a contract  
-https://medium.com/tezoscommons/preparing-for-the-tezos-hackathon-with-baking-bad-45f2d5fca519
-
-* Introducing integration testing engine  
-https://medium.com/tezoscommons/testing-michelson-contracts-with-pytezos-513718499e93
-
 ### Contact
 
 * Telegram chat: [@MavrykNetwork](https://t.me/MavrykNetwork)

docs/source/pymavryk_cli.rst

@@ -4,12 +4,12 @@ PyMavryk CLI
 Tutorials
 +++++++++++
 
-Check out this guide by Vadim from Airalab: https://blog.aira.life/tezos-dont-forget-the-mother-console-fd2001261e50?gi=2fe6dfe4fd7f
+Check out this guide by Vadim from Airalab (made for PyTezos but compatible with PyMavryk): https://blog.aira.life/tezos-dont-forget-the-mother-console-fd2001261e50?gi=2fe6dfe4fd7f
 
 Examples
 ++++++++++
 
-See how PyMavryk CLI is used in a Travis CI pipeline: https://github.com/atomex-me/atomex-fa12-ligo/blob/master/.travis.yml
+See how PyMavryk CLI is used in a Travis CI pipeline (made for PyTezos but compatible with PyMavryk): https://github.com/atomex-me/atomex-fa12-ligo/blob/master/.travis.yml
 
 Reference
 +++++++++++

src/michelson_kernel/README.md

@@ -80,8 +80,6 @@ pip uninstall pymavryk
 ```
 
 ### How it works
-* Technical details of the REPL implementation  
-https://forum.tezosagora.org/t/michelson-repl-in-a-jupyter-notebook/1749
 * Interactive tutorial demonstrating REPL features  
 https://mybinder.org/v2/gh/mavryk-network/pymavryk/binder?filepath=michelson_quickstart.ipynb
 * Same, but a rendered version  

src/pymavryk/crypto/hash.py

@@ -58,8 +58,6 @@ def block_payload_hash(predecessor: str, payload_round: int, operation_hashes: L
     :param payload_round: round number (int32)
     :param operation_hashes: flat list of non-consensus (validation pass > 0) operation hashes
     """
-    # https://gitlab.com/tezos/tezos/-/blob/master/src/proto_alpha/lib_delegate/block_forge.ml#L166
-    # https://gitlab.com/tezos/tezos/-/blob/master/src/proto_012_Psithaca/lib_protocol/block_payload_repr.ml#L41
     payload = [
         base58_decode(predecessor.encode()),
         payload_round.to_bytes(4, 'big'),

src/pymavryk/crypto/key.py

@@ -182,7 +182,7 @@ def from_public_point(
     ) -> 'Key':
         """Creates a key object from a public elliptic point.
 
-        :param public_point: elliptic point in the compressed format (see https://tezos.stackexchange.com/a/623/309)
+        :param public_point: elliptic point in the compressed format
         :param curve: b'sp' for Secp256k1, b'p2' for P256/Secp256r1, b'ed' for Ed25519 (default), b'BL' for BLS12-381
         """
         return cls(public_point, curve=curve)
@@ -319,7 +319,7 @@ def from_mnemonic(
 
     @classmethod
     def from_faucet(cls, source: Union[str, dict]) -> 'Key':
-        """Import key from a faucet file: https://teztnets.xyz/
+        """Import key from a faucet file: https://testnets.mavryk.network/
 
         :param source: path to the json file
         :rtype: Key

src/pymavryk/michelson/repl.py

@@ -35,7 +35,7 @@ class InterpreterResult:
 
 class Interpreter:
     """Michelson interpreter reimplemented in Python.
-    Based on the following reference: https://tezos.gitlab.io/michelson-reference/
+    Based on the following reference: https://mavryk-network.gitlab.io/michelson-reference/
     """
 
     def __init__(

src/pymavryk/michelson/types/chest.py

@@ -3,7 +3,7 @@
 
 class ChestType(BytesType, prim='chest'):
     ...
-    # TODO: https://gitlab.com/tezos/tezos/-/merge_requests/2940/diffs#2c09e5627158501e568f7f4a7c9245c90c357217
+    # TODO:
 
 
 class ChestKeyType(BytesType, prim='chest_key'):

src/pymavryk/operation/content.py

@@ -71,8 +71,6 @@ def endorsement_with_slot(self, endorsement: dict, slot: int):
     def seed_nonce_revelation(self, level: int, nonce: str):
         """Reveal the nonce committed operation in the previous cycle.
 
-        More info https://tezos.stackexchange.com/questions/567/what-are-nonce-revelations
-
         :param level: When nonce hash was committed
         :param nonce: Hex string
         :returns: dict or OperationGroup
@@ -134,8 +132,6 @@ def double_baking_evidence(self, bh1: str, bh2: str):
     def activate_account(self, activation_code='', pkh=''):
         """Activate recommended allocations for contributions to the TF fundraiser.
 
-        More info https://activate.tezos.com/
-
         :param activation_code: Secret code from pdf, leave empty for autocomplete
         :param pkh: Public key hash, leave empty for autocomplete
         :returns: dict or OperationGroup
@@ -210,7 +206,6 @@ def reveal(
         :param public_key: Public key to reveal, Base58 encoded
         :param source: Public key hash of the key revealed, leave None to use signatory address
         :param counter: Current account counter, leave None for autocomplete
-            (More info https://tezos.stackexchange.com/questions/632/how-counter-grows)
         :param fee: Leave None for autocomplete
         :param gas_limit: Leave None for autocomplete
         :param storage_limit: Leave None for autocomplete
@@ -286,7 +281,6 @@ def origination(
 
         :param script: {"code": $Micheline, "storage": $Micheline}
         :param balance: Amount transferred on the balance, WARNING: there is no default way to withdraw funds.
-            More info: https://tezos.stackexchange.com/questions/1315/can-i-withdraw-funds-from-an-empty-smart-contract
         :param delegate: Set contract delegate, default None
         :param source: Address from which funds will be sent, leave None to use signatory address
         :param counter: Current account counter, leave None for autocomplete

src/pymavryk/sandbox/parameters.py

@@ -45,7 +45,7 @@
     "amount": "38323962971",
     "pkh": "mv1JVZzbrGpKfripWo2GiWZ7wkzoeKHna498",
     "password": "ZuPOpZgMNM",
-    "email": "nbhcylbg.xllfjgrk@tezos.example.org",
+    "email": "nbhcylbg.xllfjgrk@mavryk.example.org",
 }
 
 sandbox_addresses = {

tests/unit_tests/test_michelson/test_repl/ill_typed/failwith_big_map.tz

@@ -1,5 +1,4 @@
 # This contract uses FAILWITH to expose a big map diff
-# See https://gitlab.com/tezos/tezos/-/issues/1708#note_667884499
 
 parameter (big_map int int);