add some scrypt articles

KaKeimei · KaKeimei · commit ef2fa8e4c3a5 · 2024-06-30T15:31:28.000+09:00
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/contract/scrypt-language/functions.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/contract/scrypt-language/functions.md
@@ -1,4 +1,56 @@
 ---
 sidebar_position: 4
 ---
+
 # 函数
+
+如何定义和使用用户自己的函数。
+
+## 私有函数和公有函数
+
+用户可以自己指定函数，但是函数默认为private，只能在合约内部被看到。
+
+public函数专门用来解锁合约，默认返回true，如果require条件不满足就会中断并返回false。
+
+## 静态函数
+
+静态函数可以直接使用Contract名称作为前缀进行调用，也可以在内部直接调用，静态函数不修改任何外部状态。
+
+## return关键字
+
+由于脚本不支持return语法，因此return必须要位于函数的最后位置，这个限制暂时无法解除，会有方法进行绕过。
+
+## 递归调用
+
+递归调用不被许可。
+
+## 库函数
+
+Scrypt提供一些方便的公共库函数可以进行直接调用。
+Math
+
+- int abs(int a)
+- int min(int a, int b)
+- int max(int a, int b)
+- bool within(int x, int min, int max)
+  Hashing
+- Ripemd160 ripemd160(bytes b)
+- Sha1 sha1(bytes b)
+- Sha256 sha256(bytes b)
+- Ripemd160 hash160(bytes b)。ripemd160(sha256(b))
+- Sha256 hash256(bytes b)sha256(sha256(b))
+- Sha256 flattenSha256(T a)
+  Signature Verification
+- bool checkSig(Sig sig, PubKey pk)
+- Returns true if the signature matches the public key. Returns false if the signature is an empty byte array.
+  Otherwise, the entire contract fails immediately, due to the NULLFAIL rule.
+- bool checkMultiSig(Sig\[M] sigs, PubKey\[N] pks)
+- Returns true if and only M signatures match M out of N public keys.
+  Returns false if all signatures are an empty byte array. Otherwise, the entire contract fails immediately.
+  Byte操作
+- Convert to and from int，使用unpack或者pack方法相互转换
+- bytes num2bin(int num, int size)
+- len() Returns the length of byte.
+- Slicing Opeartor - b\[start:end]前闭后开，如果start被忽略，则start为0，如果end被忽略，end是length
+- 字节拼接 bytes b = b'00112233' + b'334455'   b == b'00112233334455'
+- reverseBytes(bytes b, static const int size)
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/contract/scrypt-language/loop.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/contract/scrypt-language/loop.md
@@ -2,3 +2,58 @@
 sidebar_position: 3
 ---
 # 循环
+
+介绍如何在Scrypt合约中使用循环。
+
+比特币脚本内部没有提供循环功能，sCrypt实现循环的方式是重复loop内部的数据脚本n次。
+
+```c
+loop (maxLoopCount) [: loopIndex]{
+    loopBody
+}
+
+loop (10) {x = x * 2;} // 等效于x = x * 2;展开十次
+```
+由于循环展开是发生在编译期，因此循环次数必须在编译期已知，并且是常量。
+
+## 循环增量
+
+循环增量是指在循环体内对循环变量进行递增或递减操作。
+
+```c
+// int[3][4] matrix;
+// i & j are induction variables
+loop (3) : i {
+    // i is the outer loop index
+    loop (4) : j {
+        // j is the inner loop index
+        matrix[i][j] = i + j;
+    }
+}
+```
+
+## 循环内部可以增加if条件
+```c
+loop (3) {
+    // place condition here
+    if (x < 8) {
+        x = x * 2;
+    }
+}
+```
+
+## 退出循环
+
+在循环体内使用如下方式退出循环：
+
+```c
+bool done = false;
+loop (3) {
+    if (!done) {
+        x = x * 2;
+        if (x >= 8) {
+            done = true;
+        }
+    }
+}
+```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/contract/scrypt-language/standard-contracts.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/contract/scrypt-language/standard-contracts.md
@@ -1,4 +1,109 @@
 ---
 sidebar_position: 5
 ---
+
 # 标准合约
+
+本文档介绍了sCrypt语言的标准合约以及工具库。
+
+合约之间可以互相调用，可以在一个合约中new出一个其他合约的对象，要求其他合约被解锁之后，当前合约才可以被解锁。
+
+比如在P2PKH的合约中，可以要求P2PKH的解锁条件中同时满足HashPuzzle和P2PK两个合约。最终表现在链上的形态是一个大Utxo合约中封装了好几个小的合约代码，要求小合约代码全部被解锁才可以解锁大合约。
+
+## Import
+
+可以将不同的合约或者library封装在不同的文件中，然后使用import语句来导入合约。
+
+## Library
+
+library是一种特殊的合约，它只能被其他合约所调用，不能包含任何public方法。主要用来整理相关的参数和静态方法。
+
+官方提供了一些标准合约，用来处理一些常见的场景，这些标准合约不需要被import就可以使用。
+
+https://scryptdoc.readthedocs.io/en/latest/contracts.html#full-list
+
+| Contract         | Constructor Parameters | Public Function                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+|------------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Utils            | None                   | `toLEUnsigned(int n, int l) : bytes`<br/>`fromLEUnsigned(bytes b) : int`<br/>`readVarint(bytes b) : bytes`<br/>`writeVarint(bytes b) : bytes`<br/>`buildOutput(bytes outputScript, int outputSatoshis) : bytes`<br/>`buildPublicKeyHashScript(PubKeyHash pubKeyHash) : bytes`<br/>`buildOpreturnScript(bytes data) : bytes`<br/>`isFirstCall(SigHashPreimage preimage) : bool`                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| Tx               | None                   | `checkPreimage(SigHashPreimage preimage) : bool`<br/>`checkPreimageOpt(SigHashPreimage rawTx) : bool`<br/>`checkPreimageOpt_(SigHashPreimage rawTx) : bool`<br/>`checkPreimageSigHashType(SigHashPreimage txPreimage, SigHashType sigHashType) : bool`<br/>`checkPreimageAdvanced(SigHashPreimage rawTx, PrivKey privKey, PubKey pubKey, int inverseK, int r, bytes rBigEndian, SigHashType sigHashType) : bool`<br/>`checkPreimageOCS(SigHashPreimage preimage) : bool`<br/>`checkPreimageOptOCS(SigHashPreimage rawTx) : bool`<br/>`checkPreimageOptOCS_(SigHashPreimage rawTx) : bool`<br/>`checkPreimageSigHashTypeOCS(SigHashPreimage txPreimage, SigHashType sigHashType) : bool`<br/>`checkPreimageAdvancedOCS(SigHashPreimage rawTx, PrivKey privKey, PubKey pubKey, int inverseK, int r, bytes rBigEndian, SigHashType sigHashType) : bool` |
+| SigHash          | None                   | `nVersion(SigHashPreimage preimage) : bytes`<br/>`hashPrevouts(SigHashPreimage preimage) : bytes`<br/>`hashSequence(SigHashPreimage preimage) : bytes`<br/>`outpoint(SigHashPreimage preimage) : bytes`<br/>`scriptCode(SigHashPreimage preimage) : bytes`<br/>`valueRaw(SigHashPreimage preimage) : bytes`<br/>`value(SigHashPreimage preimage) : int`<br/>`nSequenceRaw(SigHashPreimage preimage) : bytes`<br/>`nSequence(SigHashPreimage preimage) : int`<br/>`hashOutputs(SigHashPreimage preimage) : bytes`<br/>`nLocktimeRaw(SigHashPreimage preimage) : bytes`<br/>`nLocktime(SigHashPreimage preimage) : int`<br/>`sigHashType(SigHashPreimage preimage) : SigHashType`                                                                                                                                                                      |
+| HashedMap\<K, V> | bytes data             | `set(SortedItem\<K> keyWithIdx, V val) : bool`<br/>`canGet(SortedItem\<K> keyWithIdx, V val) : bool`<br/>`delete(SortedItem\<K> keyWithIdx) : bool`<br/>`has(SortedItem\<K> keyWithIdx) : bool`<br/>`clear() : bool`<br/>`size() : int`<br/>`data() : bytes`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| HashedSet\<V>    | bytes data             | `add(SortedItem<\V> entryWithIdx) : bool`<br/>`delete(SortedItem<\V> entryWithIdx) : bool`<br/>`has(SortedItem<\V> entryWithIdx) : bool`<br/>`clear() : bool`<br/>`size() : int`<br/>`data() : bytes`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+
+## Utils
+
+Util 是一些常用的工具类和方法，包含的方法列表如下：
+
+![img.png](/img/scrypt-utils.png)
+
+## Tx
+
+Tx library 包含读取当前交易信息的重要内容。这是实现有状态合约和约束后续合约的核心功能。
+
+核心原理是使用一个伪操作吗OP_PUSH_TX，将当前交易的原像（preImage）推送到合约运行时中进行校验。preImage作为解锁参数的一部分，可以让合约感知到解锁自己的交易所具备的特点，针对这些特点来对交易能否解锁进行约束。（https://github.com/bitcoin-sv/bitcoin-sv/blob/master/doc/abc/replay-protected-sighash.md）
+
+注意，交易原像需要SIGHASH_FORKID的签名类型才可以生效，校验原像之前一定要校验签名类型SIG_HASH_ALL
+
+交易原像包括以下信息：
+
+1. nVersion of the transaction (4-byte little endian)
+2. hashPrevouts (32-byte hash)
+3. hashSequence (32-byte hash)
+4. outpoint (32-byte hash + 4-byte little endian)
+5. scriptCode of the input (serialized as scripts inside CTxOuts)
+6. value of the output spent by this input (8-byte little endian)
+7. nSequence of the input (4-byte little endian)
+8. hashOutputs (32-byte hash)
+9. nLocktime of the transaction (4-byte little endian)
+10. sighash type of the signature (4-byte little endian)
+
+校验原像主要包括
+
+- checkPreimage() 原版pushTx
+- checkPreImageAdvanced() 高级版，增加更多可选参数
+- checkPreImageOCS() 增加了OCS操作码的签名校验，不需要校验所有原像，只需要校验到checkPreimageOCS之前的一段即可，也就是签名使用部分原像的时候可以使用这个操作码，降低脚本体积。
+
+## SigHash
+
+SigHash库主要用来访问原像中的数据，比如Sighash.scriptCode来获取scriptCode字段，使用SigHash.value 来获取value字段等。
+
+交易原像包括以下信息（https://github.com/bitcoin-sv/bitcoin-sv/blob/master/doc/abc/replay-protected-sighash.md）：
+
+1. nVersion of the transaction (4-byte little endian) （SPENDING TX的版本）
+2. hashPrevouts (32-byte hash) （SPENDING TX所有input outpoint的hash）
+3. hashSequence (32-byte hash) （SPENDING TX所有input的nSequence的hash）
+4. outpoint (32-byte hash + 4-byte little endian) （SPENDING TX当前input对应的outpoint）
+5. scriptCode of the input (serialized as scripts inside CTxOuts) （SPENT TX点位对应的UTXO脚本）
+6. value of the output spent by this input (8-byte little endian) （SPENT TX点位对应的金额）
+7. nSequence of the input (4-byte little endian) （SPENT TX点位对应的sequence）
+8. hashOutputs (32-byte hash) （SPENDING TX当前所有output脚本和金额的hash，这是限制后续交易格式的核心）
+9. nLocktime of the transaction (4-byte little endian) （SPENDING TX的nLockTime）
+10. sighash type of the signature (4-byte little endian) （SIGHASH类型）
+
+## HashedMap
+
+hashMap
+提供一种类似于map的功能，大部分的功能不仅需要key，也需要index。可以简单认为，这种map中的key是一个聚合类型，包含key本身和用来排序的index。称为SortedItem\<T>
+
+## HashedSet
+
+提供类似set的功能，和hashmap类似，也需要SortedItem整体作为key
+
+## Constants
+
+提供一些常用业务常量。
+
+```cpp
+// number of bytes to denote input sequence
+static const int InputSeqLen = 4;
+// number of bytes to denote output value
+static const int OutputValueLen = 8;
+// number of bytes to denote a public key (compressed)
+static const int PubKeyLen = 33;
+// number of bytes to denote a public key hash
+static const int PubKeyHashLen = 20;
+// number of bytes to denote a tx id
+static const int TxIdLen = 32;
+// number of bytes to denote a outpoint
+static const int OutpointLen = 36;
+```
diff --git a/static/img/scrypt-utils.png b/static/img/scrypt-utils.png
