Skip to content

Commit

Permalink
[asset-mapping] remove smt proof and add starcoin proof
Browse files Browse the repository at this point in the history
  • Loading branch information
@welbon
welbon committed Jan 6, 2025
1 parent 2e1c55b commit fc5c593
Show file tree
Hide file tree
Showing 8 changed files with 499 additions and 761 deletions.
7 changes: 3 additions & 4 deletions vm/framework/starcoin-framework/doc/overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,11 @@ This is the reference documentation of the Starcoin framework.
- [`0x1::reserved_accounts_signer`](reserved_accounts_signer.md#0x1_reserved_accounts_signer)
- [`0x1::resource_account`](resource_account.md#0x1_resource_account)
- [`0x1::ring`](ring.md#0x1_ring)
- [`0x1::smt_hash`](smt_hash.md#0x1_smt_hash)
- [`0x1::smt_proofs`](smt_proofs.md#0x1_smt_proofs)
- [`0x1::smt_tree_hasher`](smt_tree_hasher.md#0x1_smt_tree_hasher)
- [`0x1::smt_utils`](smt_utils.md#0x1_smt_utils)
- [`0x1::starcoin_account`](starcoin_account.md#0x1_starcoin_account)
- [`0x1::starcoin_coin`](starcoin_coin.md#0x1_starcoin_coin)
- [`0x1::starcoin_proof_bit`](starcoin_proof.md#0x1_starcoin_proof_bit)
- [`0x1::starcoin_proof_structured_hash`](starcoin_proof.md#0x1_starcoin_proof_structured_hash)
- [`0x1::starcoin_proof_verifier`](starcoin_proof.md#0x1_starcoin_proof_verifier)
- [`0x1::stc_block`](stc_block.md#0x1_stc_block)
- [`0x1::stc_genesis`](stc_genesis.md#0x1_stc_genesis)
- [`0x1::stc_language_version`](stc_language_version.md#0x1_stc_language_version)
Expand Down
374 changes: 374 additions & 0 deletions vm/framework/starcoin-framework/doc/starcoin_proof.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,374 @@

<a id="0x1_starcoin_proof_bit"></a>

# Module `0x1::starcoin_proof_bit`



- [Function `get_bit`](#0x1_starcoin_proof_bit_get_bit)


<pre><code></code></pre>



<a id="0x1_starcoin_proof_bit_get_bit"></a>

## Function `get_bit`



<pre><code><b>public</b> <b>fun</b> <a href="starcoin_proof.md#0x1_starcoin_proof_bit_get_bit">get_bit</a>(data: &<a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;, index: u64): bool
</code></pre>



<details>
<summary>Implementation</summary>


<pre><code><b>public</b> <b>fun</b> <a href="starcoin_proof.md#0x1_starcoin_proof_bit_get_bit">get_bit</a>(data: &<a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;, index: u64): bool {
<b>let</b> pos = index / 8;
<b>let</b> bit = (7 - index % 8);
(*<a href="../../move-stdlib/doc/vector.md#0x1_vector_borrow">vector::borrow</a>(data, pos) &gt;&gt; (bit <b>as</b> u8)) & 1u8 != 0
}
</code></pre>



</details>



<a id="0x1_starcoin_proof_structured_hash"></a>

# Module `0x1::starcoin_proof_structured_hash`



- [Constants](#@Constants_0)
- [Function `hash`](#0x1_starcoin_proof_structured_hash_hash)
- [Function `concat`](#0x1_starcoin_proof_structured_hash_concat)


<pre><code><b>use</b> <a href="../../move-stdlib/doc/bcs.md#0x1_bcs">0x1::bcs</a>;
<b>use</b> <a href="../../move-stdlib/doc/hash.md#0x1_hash">0x1::hash</a>;
<b>use</b> <a href="../../move-stdlib/doc/vector.md#0x1_vector">0x1::vector</a>;
</code></pre>



<a id="@Constants_0"></a>

## Constants


<a id="0x1_starcoin_proof_structured_hash_STARCOIN_HASH_PREFIX"></a>



<pre><code><b>const</b> <a href="starcoin_proof.md#0x1_starcoin_proof_structured_hash_STARCOIN_HASH_PREFIX">STARCOIN_HASH_PREFIX</a>: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt; = [83, 84, 65, 82, 67, 79, 73, 78, 58, 58];
</code></pre>



<a id="0x1_starcoin_proof_structured_hash_hash"></a>

## Function `hash`



<pre><code><b>public</b> <b>fun</b> <a href="../../move-stdlib/doc/hash.md#0x1_hash">hash</a>&lt;MoveValue: store&gt;(structure: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;, data: &MoveValue): <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;
</code></pre>



<details>
<summary>Implementation</summary>


<pre><code><b>public</b> <b>fun</b> <a href="../../move-stdlib/doc/hash.md#0x1_hash">hash</a>&lt;MoveValue: store&gt;(structure: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;, data: &MoveValue): <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt; {
<b>let</b> prefix_hash = <a href="../../move-stdlib/doc/hash.md#0x1_hash_sha3_256">hash::sha3_256</a>(<a href="starcoin_proof.md#0x1_starcoin_proof_structured_hash_concat">concat</a>(&<a href="starcoin_proof.md#0x1_starcoin_proof_structured_hash_STARCOIN_HASH_PREFIX">STARCOIN_HASH_PREFIX</a>, structure));
<b>let</b> bcs_bytes = <a href="../../move-stdlib/doc/bcs.md#0x1_bcs_to_bytes">bcs::to_bytes</a>(data);
<a href="../../move-stdlib/doc/hash.md#0x1_hash_sha3_256">hash::sha3_256</a>(<a href="starcoin_proof.md#0x1_starcoin_proof_structured_hash_concat">concat</a>(&prefix_hash, bcs_bytes))
}
</code></pre>



</details>

<a id="0x1_starcoin_proof_structured_hash_concat"></a>

## Function `concat`



<pre><code><b>fun</b> <a href="starcoin_proof.md#0x1_starcoin_proof_structured_hash_concat">concat</a>(v1: &<a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;, v2: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;): <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;
</code></pre>



<details>
<summary>Implementation</summary>


<pre><code><b>fun</b> <a href="starcoin_proof.md#0x1_starcoin_proof_structured_hash_concat">concat</a>(v1: &<a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;, v2: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;): <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt; {
<b>let</b> data = *v1;
<a href="../../move-stdlib/doc/vector.md#0x1_vector_append">vector::append</a>(&<b>mut</b> data, v2);
data
}
</code></pre>



</details>



<a id="0x1_starcoin_proof_verifier"></a>

# Module `0x1::starcoin_proof_verifier`



- [Resource `StarcoinMerkle`](#0x1_starcoin_proof_verifier_StarcoinMerkle)
- [Struct `Node`](#0x1_starcoin_proof_verifier_Node)
- [Constants](#@Constants_0)
- [Function `create`](#0x1_starcoin_proof_verifier_create)
- [Function `verify_on`](#0x1_starcoin_proof_verifier_verify_on)
- [Function `verify`](#0x1_starcoin_proof_verifier_verify)
- [Function `computer_root_hash`](#0x1_starcoin_proof_verifier_computer_root_hash)


<pre><code><b>use</b> <a href="../../move-stdlib/doc/hash.md#0x1_hash">0x1::hash</a>;
<b>use</b> <a href="starcoin_proof.md#0x1_starcoin_proof_bit">0x1::starcoin_proof_bit</a>;
<b>use</b> <a href="starcoin_proof.md#0x1_starcoin_proof_structured_hash">0x1::starcoin_proof_structured_hash</a>;
</code></pre>



<a id="0x1_starcoin_proof_verifier_StarcoinMerkle"></a>

## Resource `StarcoinMerkle`



<pre><code><b>struct</b> <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_StarcoinMerkle">StarcoinMerkle</a> <b>has</b> key
</code></pre>



<details>
<summary>Fields</summary>


<dl>
<dt>
<code>merkle_root: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;</code>
</dt>
<dd>

</dd>
</dl>


</details>

<a id="0x1_starcoin_proof_verifier_Node"></a>

## Struct `Node`



<pre><code><b>struct</b> <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_Node">Node</a> <b>has</b> drop, store
</code></pre>



<details>
<summary>Fields</summary>


<dl>
<dt>
<code>hash1: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;</code>
</dt>
<dd>

</dd>
<dt>
<code>hash2: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;</code>
</dt>
<dd>

</dd>
</dl>


</details>

<a id="@Constants_0"></a>

## Constants


<a id="0x1_starcoin_proof_verifier_HASH_LEN_IN_BIT"></a>



<pre><code><b>const</b> <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_HASH_LEN_IN_BIT">HASH_LEN_IN_BIT</a>: u64 = 256;
</code></pre>



<a id="0x1_starcoin_proof_verifier_SPARSE_MERKLE_INTERNAL_NODE"></a>



<pre><code><b>const</b> <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_SPARSE_MERKLE_INTERNAL_NODE">SPARSE_MERKLE_INTERNAL_NODE</a>: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt; = [83, 112, 97, 114, 115, 101, 77, 101, 114, 107, 108, 101, 73, 110, 116, 101, 114, 110, 97, 108, 78, 111, 100, 101];
</code></pre>



<a id="0x1_starcoin_proof_verifier_SPARSE_MERKLE_LEAF_NODE"></a>



<pre><code><b>const</b> <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_SPARSE_MERKLE_LEAF_NODE">SPARSE_MERKLE_LEAF_NODE</a>: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt; = [83, 112, 97, 114, 115, 101, 77, 101, 114, 107, 108, 101, 76, 101, 97, 102, 78, 111, 100, 101];
</code></pre>



<a id="0x1_starcoin_proof_verifier_create"></a>

## Function `create`



<pre><code><b>public</b> <b>fun</b> <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_create">create</a>(<a href="../../move-stdlib/doc/signer.md#0x1_signer">signer</a>: &<a href="../../move-stdlib/doc/signer.md#0x1_signer">signer</a>, merkle_root: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;)
</code></pre>



<details>
<summary>Implementation</summary>


<pre><code><b>public</b> <b>fun</b> <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_create">create</a>(<a href="../../move-stdlib/doc/signer.md#0x1_signer">signer</a>: &<a href="../../move-stdlib/doc/signer.md#0x1_signer">signer</a>, merkle_root: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;) {
<b>let</b> s = <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_StarcoinMerkle">StarcoinMerkle</a> {
merkle_root
};
<b>move_to</b>(<a href="../../move-stdlib/doc/signer.md#0x1_signer">signer</a>, s);
}
</code></pre>



</details>

<a id="0x1_starcoin_proof_verifier_verify_on"></a>

## Function `verify_on`



<pre><code><b>public</b> <b>fun</b> <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_verify_on">verify_on</a>(merkle_address: <b>address</b>, account_address: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;, account_state_root_hash: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;, proofs: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;<a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;&gt;): bool
</code></pre>



<details>
<summary>Implementation</summary>


<pre><code><b>public</b> <b>fun</b> <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_verify_on">verify_on</a>(
merkle_address: <b>address</b>,
account_address: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
account_state_root_hash: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
proofs: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;<a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;&gt;
): bool
<b>acquires</b> <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_StarcoinMerkle">StarcoinMerkle</a> {
<b>let</b> merkle = <b>borrow_global</b>&lt;<a href="starcoin_proof.md#0x1_starcoin_proof_verifier_StarcoinMerkle">StarcoinMerkle</a>&gt;(merkle_address);
<a href="starcoin_proof.md#0x1_starcoin_proof_verifier_verify">verify</a>(*&merkle.merkle_root, account_address, account_state_root_hash, proofs)
}
</code></pre>



</details>

<a id="0x1_starcoin_proof_verifier_verify"></a>

## Function `verify`



<pre><code><b>public</b> <b>fun</b> <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_verify">verify</a>(expected_root: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;, account_address: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;, account_state_root_hash: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;, proofs: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;<a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;&gt;): bool
</code></pre>



<details>
<summary>Implementation</summary>


<pre><code><b>public</b> <b>fun</b> <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_verify">verify</a>(
expected_root: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
account_address: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
account_state_root_hash: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
proofs: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;<a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;&gt;
): bool {
<a href="starcoin_proof.md#0x1_starcoin_proof_verifier_computer_root_hash">Self::computer_root_hash</a>(<a href="../../move-stdlib/doc/hash.md#0x1_hash_sha3_256">hash::sha3_256</a>(account_address), account_state_root_hash, proofs) == expected_root
}
</code></pre>



</details>

<a id="0x1_starcoin_proof_verifier_computer_root_hash"></a>

## Function `computer_root_hash`



<pre><code><b>public</b> <b>fun</b> <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_computer_root_hash">computer_root_hash</a>(element_key: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;, element_blob_hash: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;, proofs: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;<a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;&gt;): <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;
</code></pre>



<details>
<summary>Implementation</summary>


<pre><code><b>public</b> <b>fun</b> <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_computer_root_hash">computer_root_hash</a>(
element_key: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
element_blob_hash: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;,
proofs: <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;<a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt;&gt;
): <a href="../../move-stdlib/doc/vector.md#0x1_vector">vector</a>&lt;u8&gt; {
<b>let</b> leaf_node = <a href="starcoin_proof.md#0x1_starcoin_proof_verifier_Node">Node</a> { hash1: element_key, hash2: element_blob_hash };
<b>let</b> current_hash = <a href="starcoin_proof.md#0x1_starcoin_proof_structured_hash_hash">starcoin_proof_structured_hash::hash</a>(<a href="starcoin_proof.md#0x1_starcoin_proof_verifier_SPARSE_MERKLE_LEAF_NODE">SPARSE_MERKLE_LEAF_NODE</a>, &leaf_node);
<b>let</b> i = 0;
<b>let</b> proof_length = <a href="../../move-stdlib/doc/vector.md#0x1_vector_length">vector::length</a>(&proofs);
<b>while</b> (i &lt; proof_length) {
<b>let</b> sibling = *<a href="../../move-stdlib/doc/vector.md#0x1_vector_borrow">vector::borrow</a>(&proofs, i);
<b>let</b> bit = <a href="starcoin_proof.md#0x1_starcoin_proof_bit_get_bit">starcoin_proof_bit::get_bit</a>(&element_key, proof_length - i - 1);
<b>let</b> internal_node = <b>if</b> (bit) {
<a href="starcoin_proof.md#0x1_starcoin_proof_verifier_Node">Node</a> { hash1: sibling, hash2: current_hash }
} <b>else</b> {
<a href="starcoin_proof.md#0x1_starcoin_proof_verifier_Node">Node</a> { hash1: current_hash, hash2: sibling }
};
current_hash = <a href="starcoin_proof.md#0x1_starcoin_proof_structured_hash_hash">starcoin_proof_structured_hash::hash</a>(<a href="starcoin_proof.md#0x1_starcoin_proof_verifier_SPARSE_MERKLE_INTERNAL_NODE">SPARSE_MERKLE_INTERNAL_NODE</a>, &internal_node);
i = i + 1;
};
current_hash
}
</code></pre>



</details>


[move-book]: https://starcoin.dev/move/book/SUMMARY
Loading

0 comments on commit fc5c593

Please sign in to comment.