chore: import latex preamble

AztecProtocol · Apr 4, 2024 · 2cfe519 · 2cfe519
1 parent 028fc47
commit 2cfe519
Show file tree

Hide file tree

Showing 12 changed files with 115 additions and 442 deletions.
diff --git a/yellow-paper/docs/addresses-and-keys/address.md b/yellow-paper/docs/addresses-and-keys/address.md
@@ -73,7 +73,7 @@ address_crh(
 }
 ```
 
-The `public_keys` array can vary depending on the format of keys used by the address, but it is suggested it includes the master keys defined in the [keys section](./keys.md). For example:
+The `public_keys` array can vary depending on the format of keys used by the address, but it is suggested it includes the master keys defined in the [keys section](./keys.mdx). For example:
 
 ```rust
 let public_keys_hash: Field = poseidon2(

diff --git a/yellow-paper/docs/addresses-and-keys/diversified-and-stealth.md b/yellow-paper/docs/addresses-and-keys/diversified-and-stealth.md
@@ -2,7 +2,7 @@
 title: Diversified and Stealth Accounts
 ---
 
-The [keys specification](./keys.md) describes derivation mechanisms for diversified and stealth public keys. However, the protocol requires users to interact with addresses.
+The [keys specification](./keys.mdx) describes derivation mechanisms for diversified and stealth public keys. However, the protocol requires users to interact with addresses.
 
 ## Computing Addresses
 

diff --git a/...ple-usage/diversified-and-stealth-keys.md → ...le-usage/diversified-and-stealth-keys.mdx b/...ple-usage/diversified-and-stealth-keys.md → ...le-usage/diversified-and-stealth-keys.mdx
@@ -1,90 +1,7 @@
-$$
-\gdef\sk{\color{red}{sk}}
+<!-- @dev: if you want to import the preamble, remember to make the importing file a `.mdx` file. -->
 
-\gdef\nskm{\color{red}{nsk_m}}
-\gdef\tskm{\color{red}{tsk_m}}
-\gdef\ivskm{\color{red}{ivsk_m}}
-\gdef\ovskm{\color{red}{ovsk_m}}
-
-\gdef\Npkm{\color{green}{Npk_m}}
-\gdef\Tpkm{\color{green}{Tpk_m}}
-\gdef\Ivpkm{\color{green}{Ivpk_m}}
-\gdef\Ovpkm{\color{green}{Ovpk_m}}
-
-
-\gdef\address{\color{green}{address}}
-\gdef\codehash{\color{green}{code\_hash}}
-\gdef\constructorhash{\color{green}{constructor\_hash}}
-\gdef\classid{\color{green}{class\id}}
-
-
-\gdef\nskapp{\color{red}{nsk_{app}}}
-\gdef\tskapp{\color{red}{tsk_{app}}}
-\gdef\ivskapp{\color{red}{ivsk_{app}}}
-\gdef\ovskapp{\color{red}{ovsk_{app}}}
-
-\gdef\Nkapp{\color{orange}{Nk_{app}}}
-
-\gdef\Npkapp{\color{green}{Npk_{app}}}
-
-
-\gdef\Ivpkapp{\color{green}{Ivpk_{app}}}
-
-
-\gdef\happL{\color{green}{h_{app}^L}}
-\gdef\happn{\color{green}{h_{app}^n}}
-\gdef\happiv{\color{green}{h_{app}^{iv}}}
-
-
-\gdef\d{\color{green}{d}}
-\gdef\Gd{\color{green}{G_d}}
-
-\gdef\Ivpkappd{\color{violet}{Ivpk_{app,d}}}
-\gdef\shareableIvpkappd{\color{violet}{\widetilde{Ivpk_{app,d}}}}
-\gdef\Ivpkmd{\color{violet}{Ivpk_{m,d}}}
-\gdef\shareableIvpkmd{\color{violet}{\widetilde{Ivpk_{m,d}}}}
-
-
-\gdef\ivskappstealth{\color{red}{ivsk_{app,stealth}}}
-\gdef\Ivpkappdstealth{\color{violet}{Ivpk_{app,d,stealth}}}
-\gdef\Pkappdstealth{\color{violet}{Pk_{app,d,stealth}}}
-\gdef\ivskmstealth{\color{red}{ivsk_{m,stealth}}}
-\gdef\Ivpkmdstealth{\color{violet}{Ivpk_{m,d,stealth}}}
-\gdef\Pkmdstealth{\color{violet}{Pk_{m,d,stealth}}}
-
-\gdef\hstealth{\color{violet}{h_{stealth}}}
-
-
-\gdef\esk{\color{red}{esk}}
-\gdef\Epk{\color{green}{Epk}}
-\gdef\Epkd{\color{green}{Epk_d}}
-\gdef\eskheader{\color{red}{esk_{header}}}
-\gdef\Epkheader{\color{green}{Epk_{header}}}
-\gdef\Epkdheader{\color{green}{Epk_{d,header}}}
-
-\gdef\sharedsecret{\color{violet}{\text{S}}}
-\gdef\sharedsecretmheader{\color{violet}{\text{S_{m,header}}}}
-\gdef\sharedsecretappheader{\color{violet}{\text{S_{app,header}}}}
-
-
-\gdef\hmencheader{\color{violet}{h_{m,enc,header}}}
-\gdef\happencheader{\color{violet}{h_{app,enc,header}}}
-\gdef\hmenc{\color{violet}{h_{m,enc}}}
-\gdef\happenc{\color{violet}{h_{app,enc}}}
-\gdef\incomingenckey{\color{violet}{h_{incoming\_enc\_key}}}
-
-
-\gdef\plaintext{\color{red}{\text{plaintext}}}
-\gdef\ciphertext{\color{green}{\text{ciphertext}}}
-\gdef\ciphertextheader{\color{green}{\text{ciphertext\_header}}}
-\gdef\payload{\color{green}{\text{payload}}}
-
-
-\gdef\tagg{\color{green}{\text{tag}}}
-\gdef\Taghs{\color{green}{\text{Tag}_{hs}}}
-
-
-$$
+import LatexPreamble from "../keys-latex-preamble.md";
+<LatexPreamble />;
 
 ## Deriving diversified public keys
 

diff --git a/...and-keys/example-usage/encrypt-and-tag.md → ...nd-keys/example-usage/encrypt-and-tag.mdx b/...and-keys/example-usage/encrypt-and-tag.md → ...nd-keys/example-usage/encrypt-and-tag.mdx
@@ -1,91 +1,7 @@
-$$
+<!-- @dev: if you want to import the preamble, remember to make the importing file a `.mdx` file. -->
 
-\gdef\sk{\color{red}{sk}}
-
-\gdef\nskm{\color{red}{nsk_m}}
-\gdef\tskm{\color{red}{tsk_m}}
-\gdef\ivskm{\color{red}{ivsk_m}}
-\gdef\ovskm{\color{red}{ovsk_m}}
-
-\gdef\Npkm{\color{green}{Npk_m}}
-\gdef\Tpkm{\color{green}{Tpk_m}}
-\gdef\Ivpkm{\color{green}{Ivpk_m}}
-\gdef\Ovpkm{\color{green}{Ovpk_m}}
-
-
-\gdef\address{\color{green}{address}}
-\gdef\codehash{\color{green}{code\_hash}}
-\gdef\constructorhash{\color{green}{constructor\_hash}}
-\gdef\classid{\color{green}{class\id}}
-
-
-\gdef\nskapp{\color{red}{nsk_{app}}}
-\gdef\tskapp{\color{red}{tsk_{app}}}
-\gdef\ivskapp{\color{red}{ivsk_{app}}}
-\gdef\ovskapp{\color{red}{ovsk_{app}}}
-
-\gdef\Nkapp{\color{orange}{Nk_{app}}}
-
-\gdef\Npkapp{\color{green}{Npk_{app}}}
-
-
-\gdef\Ivpkapp{\color{green}{Ivpk_{app}}}
-
-
-\gdef\happL{\color{green}{h_{app}^L}}
-\gdef\happn{\color{green}{h_{app}^n}}
-\gdef\happiv{\color{green}{h_{app}^{iv}}}
-
-
-\gdef\d{\color{green}{d}}
-\gdef\Gd{\color{green}{G_d}}
-
-\gdef\Ivpkappd{\color{violet}{Ivpk_{app,d}}}
-\gdef\shareableIvpkappd{\color{violet}{\widetilde{Ivpk_{app,d}}}}
-\gdef\Ivpkmd{\color{violet}{Ivpk_{m,d}}}
-\gdef\shareableIvpkmd{\color{violet}{\widetilde{Ivpk_{m,d}}}}
-
-
-\gdef\ivskappstealth{\color{red}{ivsk_{app,stealth}}}
-\gdef\Ivpkappdstealth{\color{violet}{Ivpk_{app,d,stealth}}}
-\gdef\Pkappdstealth{\color{violet}{Pk_{app,d,stealth}}}
-\gdef\ivskmstealth{\color{red}{ivsk_{m,stealth}}}
-\gdef\Ivpkmdstealth{\color{violet}{Ivpk_{m,d,stealth}}}
-\gdef\Pkmdstealth{\color{violet}{Pk_{m,d,stealth}}}
-
-\gdef\hstealth{\color{violet}{h_{stealth}}}
-
-
-\gdef\esk{\color{red}{esk}}
-\gdef\Epk{\color{green}{Epk}}
-\gdef\Epkd{\color{green}{Epk_d}}
-\gdef\eskheader{\color{red}{esk_{header}}}
-\gdef\Epkheader{\color{green}{Epk_{header}}}
-\gdef\Epkdheader{\color{green}{Epk_{d,header}}}
-
-\gdef\sharedsecret{\color{violet}{\text{S}}}
-\gdef\sharedsecretmheader{\color{violet}{\text{S_{m,header}}}}
-\gdef\sharedsecretappheader{\color{violet}{\text{S_{app,header}}}}
-
-
-\gdef\hmencheader{\color{violet}{h_{m,enc,header}}}
-\gdef\happencheader{\color{violet}{h_{app,enc,header}}}
-\gdef\hmenc{\color{violet}{h_{m,enc}}}
-\gdef\happenc{\color{violet}{h_{app,enc}}}
-\gdef\incomingenckey{\color{violet}{h_{incoming\_enc\_key}}}
-
-
-\gdef\plaintext{\color{red}{\text{plaintext}}}
-\gdef\ciphertext{\color{green}{\text{ciphertext}}}
-\gdef\ciphertextheader{\color{green}{\text{ciphertext\_header}}}
-\gdef\payload{\color{green}{\text{payload}}}
-
-
-\gdef\tagg{\color{green}{\text{tag}}}
-\gdef\Taghs{\color{green}{\text{Tag}_{hs}}}
-
-
-$$
+import LatexPreamble from "../keys-latex-preamble.md";
+<LatexPreamble />;
 
 ## Encrypt and tag an incoming message
 

diff --git a/...esses-and-keys/example-usage/nullifier.md → ...sses-and-keys/example-usage/nullifier.mdx b/...esses-and-keys/example-usage/nullifier.md → ...sses-and-keys/example-usage/nullifier.mdx
@@ -1,90 +1,7 @@
-$$
-\gdef\sk{\color{red}{sk}}
-
-\gdef\nskm{\color{red}{nsk_m}}
-\gdef\tskm{\color{red}{tsk_m}}
-\gdef\ivskm{\color{red}{ivsk_m}}
-\gdef\ovskm{\color{red}{ovsk_m}}
-
-\gdef\Npkm{\color{green}{Npk_m}}
-\gdef\Tpkm{\color{green}{Tpk_m}}
-\gdef\Ivpkm{\color{green}{Ivpk_m}}
-\gdef\Ovpkm{\color{green}{Ovpk_m}}
-
-
-\gdef\address{\color{green}{address}}
-\gdef\codehash{\color{green}{code\_hash}}
-\gdef\constructorhash{\color{green}{constructor\_hash}}
-\gdef\classid{\color{green}{class\id}}
-
-
-\gdef\nskapp{\color{red}{nsk_{app}}}
-\gdef\tskapp{\color{red}{tsk_{app}}}
-\gdef\ivskapp{\color{red}{ivsk_{app}}}
-\gdef\ovskapp{\color{red}{ovsk_{app}}}
-
-\gdef\Nkapp{\color{orange}{Nk_{app}}}
-
-\gdef\Npkapp{\color{green}{Npk_{app}}}
-
-
-\gdef\Ivpkapp{\color{green}{Ivpk_{app}}}
-
-
-\gdef\happL{\color{green}{h_{app}^L}}
-\gdef\happn{\color{green}{h_{app}^n}}
-\gdef\happiv{\color{green}{h_{app}^{iv}}}
-
-
-\gdef\d{\color{green}{d}}
-\gdef\Gd{\color{green}{G_d}}
+<!-- @dev: if you want to import the preamble, remember to make the importing file a `.mdx` file. -->
 
-\gdef\Ivpkappd{\color{violet}{Ivpk_{app,d}}}
-\gdef\shareableIvpkappd{\color{violet}{\widetilde{Ivpk_{app,d}}}}
-\gdef\Ivpkmd{\color{violet}{Ivpk_{m,d}}}
-\gdef\shareableIvpkmd{\color{violet}{\widetilde{Ivpk_{m,d}}}}
-
-
-\gdef\ivskappstealth{\color{red}{ivsk_{app,stealth}}}
-\gdef\Ivpkappdstealth{\color{violet}{Ivpk_{app,d,stealth}}}
-\gdef\Pkappdstealth{\color{violet}{Pk_{app,d,stealth}}}
-\gdef\ivskmstealth{\color{red}{ivsk_{m,stealth}}}
-\gdef\Ivpkmdstealth{\color{violet}{Ivpk_{m,d,stealth}}}
-\gdef\Pkmdstealth{\color{violet}{Pk_{m,d,stealth}}}
-
-\gdef\hstealth{\color{violet}{h_{stealth}}}
-
-
-\gdef\esk{\color{red}{esk}}
-\gdef\Epk{\color{green}{Epk}}
-\gdef\Epkd{\color{green}{Epk_d}}
-\gdef\eskheader{\color{red}{esk_{header}}}
-\gdef\Epkheader{\color{green}{Epk_{header}}}
-\gdef\Epkdheader{\color{green}{Epk_{d,header}}}
-
-\gdef\sharedsecret{\color{violet}{\text{S}}}
-\gdef\sharedsecretmheader{\color{violet}{\text{S_{m,header}}}}
-\gdef\sharedsecretappheader{\color{violet}{\text{S_{app,header}}}}
-
-
-\gdef\hmencheader{\color{violet}{h_{m,enc,header}}}
-\gdef\happencheader{\color{violet}{h_{app,enc,header}}}
-\gdef\hmenc{\color{violet}{h_{m,enc}}}
-\gdef\happenc{\color{violet}{h_{app,enc}}}
-\gdef\incomingenckey{\color{violet}{h_{incoming\_enc\_key}}}
-
-
-\gdef\plaintext{\color{red}{\text{plaintext}}}
-\gdef\ciphertext{\color{green}{\text{ciphertext}}}
-\gdef\ciphertextheader{\color{green}{\text{ciphertext\_header}}}
-\gdef\payload{\color{green}{\text{payload}}}
-
-
-\gdef\tagg{\color{green}{\text{tag}}}
-\gdef\Taghs{\color{green}{\text{Tag}_{hs}}}
-
-
-$$
+import LatexPreamble from "../keys-latex-preamble.md";
+<LatexPreamble />;
 
 ## Deriving a nullifier within an app contract
 
@@ -106,8 +23,8 @@ It's easiest to take a look at this first:
 
 Within the app, we can prove links between:
 
-- the user's [$\nskapp$](../keys.md#app-siloed-nullifier-secret-key) and their [$\Nkapp$](../keys.md#app-siloed-nullifier-key); and between
-- the user's [$\Npkm$](../keys.md#master-nullifier-public-key) and their [$\address$](../address.md).
+- the user's [$\nskapp$](../keys.mdx#app-siloed-nullifier-secret-key) and their [$\Nkapp$](../keys.mdx#app-siloed-nullifier-key); and between
+- the user's [$\Npkm$](../keys.mdx#master-nullifier-public-key) and their [$\address$](../address.md).
 
 The link that's missing is to prove that $\Npkm$ relates to $\nskapp$. To compute this missing link requires the $\nskm$, which MUST NOT be passed into an app circuit, and may only be passed into a kernel circuit. See the next ['Within the kernel circuit'](#within-the-kernel-circuit) section for details of this logic.
-Original file line number
+Diff line change
@@ Expand Up / @@ -73,7 +73,7 @@ address_crh( @@
     }
     ```
-    The `public_keys` array can vary depending on the format of keys used by the address, but it is suggested it includes the master keys defined in the [keys section](./keys.md). For example:
+    The `public_keys` array can vary depending on the format of keys used by the address, but it is suggested it includes the master keys defined in the [keys section](./keys.mdx). For example:
     ```rust
     let public_keys_hash: Field = poseidon2(
@@ Expand Down @@