From e5da98e4d5a57a65704ab922cb0213972c26028c Mon Sep 17 00:00:00 2001 From: Nicolas Ayache Date: Tue, 30 May 2023 09:41:02 +0200 Subject: [PATCH] Doc/Michelson: redirect operations on crypto primitives to interactive reference. --- docs/alpha/michelson.rst | 64 ++++++---------------------------------- 1 file changed, 9 insertions(+), 55 deletions(-) diff --git a/docs/alpha/michelson.rst b/docs/alpha/michelson.rst index 0ce06c64ff0b..795e2259d729 100644 --- a/docs/alpha/michelson.rst +++ b/docs/alpha/michelson.rst @@ -967,68 +967,22 @@ Bytes can be converted to natural numbers and integers. Cryptographic primitives ~~~~~~~~~~~~~~~~~~~~~~~~ -- ``HASH_KEY``: Compute the b58check of a public key. - -:: - - :: key : 'S -> key_hash : 'S +A detailed description of the following instructions can be found in the `interactive Michelson reference manual `__. +- ``HASH_KEY``: Compute the b58check of a public key (`documentation `__). - ``BLAKE2B``: Compute a cryptographic hash of the value contents using the - Blake2b-256 cryptographic hash function. - -:: - - :: bytes : 'S -> bytes : 'S - + Blake2b-256 cryptographic hash function (`documentation `__). - ``KECCAK``: Compute a cryptographic hash of the value contents using the - Keccak-256 cryptographic hash function. - -:: - - :: bytes : 'S -> bytes : 'S - + Keccak-256 cryptographic hash function (`documentation `__). - ``SHA256``: Compute a cryptographic hash of the value contents using the - Sha256 cryptographic hash function. - -:: - - :: bytes : 'S -> bytes : 'S - + Sha256 cryptographic hash function (`documentation `__). - ``SHA512``: Compute a cryptographic hash of the value contents using the - Sha512 cryptographic hash function. - -:: - - :: bytes : 'S -> bytes : 'S - + Sha512 cryptographic hash function (`documentation `__). - ``SHA3``: Compute a cryptographic hash of the value contents using the - SHA3-256 cryptographic hash function. - -:: - - :: bytes : 'S -> bytes : 'S - + SHA3-256 cryptographic hash function (`documentation `__). - ``CHECK_SIGNATURE``: Check that a sequence of bytes has been signed - with a given key. - -:: - - :: key : signature : bytes : 'S -> bool : 'S - -- ``COMPARE``: Key hash, key and signature comparison - -:: - - :: key_hash : key_hash : 'S -> int : 'S - :: key : key : 'S -> int : 'S - :: signature : signature : 'S -> int : 'S - - > COMPARE / x : y : S => -1 : S - iff x < y - > COMPARE / x : y : S => 0 : S - iff x = y - > COMPARE / x : y : S => 1 : S - iff x > y + with a given key (`documentation `__). +- ``COMPARE``: Key hash, key and signature comparison (`documentation `__). BLS12-381 primitives ~~~~~~~~~~~~~~~~~~~~~~~~ -- GitLab