Module `0x1::CoreAddresses`

Module providing well-known addresses and related logic.

Note: this module currently defines zero-argument functions like <code>Self::DIEM_ROOT_ADDRESS()</code> using capitalization in the name, following the convention for constants. Eventually, those functions are planned to become actual global constants, once the Move language supports this feature.

Constants
Function assert_diem_root
Function assert_treasury_compliance
Function assert_vm
Function assert_currency_info

<pre><code>use <a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors">0x1::Errors</a>; use <a href="../../../../../../move-stdlib/docs/Signer.md#0x1_Signer">0x1::Signer</a>; </code></pre>

Constants

The operation can only be performed by the account where currencies are registered

<pre><code>const <a href="CoreAddresses.md#0x1_CoreAddresses_ECURRENCY_INFO">ECURRENCY_INFO</a>: u64 = 3; </code></pre>

The operation can only be performed by the account at 0xA550C18 (Diem Root)

<pre><code>const <a href="CoreAddresses.md#0x1_CoreAddresses_EDIEM_ROOT">EDIEM_ROOT</a>: u64 = 0; </code></pre>

The operation can only be performed by the account at 0xB1E55ED (Treasury & Compliance)

<pre><code>const <a href="CoreAddresses.md#0x1_CoreAddresses_ETREASURY_COMPLIANCE">ETREASURY_COMPLIANCE</a>: u64 = 1; </code></pre>

The operation can only be performed by the VM

<pre><code>const <a href="CoreAddresses.md#0x1_CoreAddresses_EVM">EVM</a>: u64 = 2; </code></pre>

Function `assert_diem_root`

Assert that the account is the Diem root address.

<pre><code>public fun <a href="CoreAddresses.md#0x1_CoreAddresses_assert_diem_root">assert_diem_root</a>(account: &signer) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="CoreAddresses.md#0x1_CoreAddresses_assert_diem_root">assert_diem_root</a>(account: &signer) { assert(<a href="../../../../../../move-stdlib/docs/Signer.md#0x1_Signer_address_of">Signer::address_of</a>(account) == @DiemRoot, <a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors_requires_address">Errors::requires_address</a>(<a href="CoreAddresses.md#0x1_CoreAddresses_EDIEM_ROOT">EDIEM_ROOT</a>)) } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; include <a href="CoreAddresses.md#0x1_CoreAddresses_AbortsIfNotDiemRoot">AbortsIfNotDiemRoot</a>; </code></pre>

Specifies that a function aborts if the account does not have the Diem root address.

<pre><code>schema <a href="CoreAddresses.md#0x1_CoreAddresses_AbortsIfNotDiemRoot">AbortsIfNotDiemRoot</a> { account: signer; aborts_if <a href="../../../../../../move-stdlib/docs/Signer.md#0x1_Signer_spec_address_of">Signer::spec_address_of</a>(account) != @DiemRoot with <a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors_REQUIRES_ADDRESS">Errors::REQUIRES_ADDRESS</a>; } </code></pre> </details>

Function `assert_treasury_compliance`

Assert that the signer has the treasury compliance address.

<pre><code>public fun <a href="CoreAddresses.md#0x1_CoreAddresses_assert_treasury_compliance">assert_treasury_compliance</a>(account: &signer) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="CoreAddresses.md#0x1_CoreAddresses_assert_treasury_compliance">assert_treasury_compliance</a>(account: &signer) { assert( <a href="../../../../../../move-stdlib/docs/Signer.md#0x1_Signer_address_of">Signer::address_of</a>(account) == @TreasuryCompliance, <a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors_requires_address">Errors::requires_address</a>(<a href="CoreAddresses.md#0x1_CoreAddresses_ETREASURY_COMPLIANCE">ETREASURY_COMPLIANCE</a>) ) } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; include <a href="CoreAddresses.md#0x1_CoreAddresses_AbortsIfNotTreasuryCompliance">AbortsIfNotTreasuryCompliance</a>; </code></pre>

Specifies that a function aborts if the account does not have the treasury compliance address.

<pre><code>schema <a href="CoreAddresses.md#0x1_CoreAddresses_AbortsIfNotTreasuryCompliance">AbortsIfNotTreasuryCompliance</a> { account: signer; aborts_if <a href="../../../../../../move-stdlib/docs/Signer.md#0x1_Signer_spec_address_of">Signer::spec_address_of</a>(account) != @TreasuryCompliance with <a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors_REQUIRES_ADDRESS">Errors::REQUIRES_ADDRESS</a>; } </code></pre> </details>

Function `assert_vm`

Assert that the signer has the VM reserved address.

<pre><code>public fun <a href="CoreAddresses.md#0x1_CoreAddresses_assert_vm">assert_vm</a>(account: &signer) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="CoreAddresses.md#0x1_CoreAddresses_assert_vm">assert_vm</a>(account: &signer) { assert(<a href="../../../../../../move-stdlib/docs/Signer.md#0x1_Signer_address_of">Signer::address_of</a>(account) == @VMReserved, <a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors_requires_address">Errors::requires_address</a>(<a href="CoreAddresses.md#0x1_CoreAddresses_EVM">EVM</a>)) } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; include <a href="CoreAddresses.md#0x1_CoreAddresses_AbortsIfNotVM">AbortsIfNotVM</a>; </code></pre>

Specifies that a function aborts if the account does not have the VM reserved address.

<pre><code>schema <a href="CoreAddresses.md#0x1_CoreAddresses_AbortsIfNotVM">AbortsIfNotVM</a> { account: signer; aborts_if <a href="../../../../../../move-stdlib/docs/Signer.md#0x1_Signer_spec_address_of">Signer::spec_address_of</a>(account) != @VMReserved with <a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors_REQUIRES_ADDRESS">Errors::REQUIRES_ADDRESS</a>; } </code></pre> </details>

Function `assert_currency_info`

Assert that the signer has the currency info address.

<pre><code>public fun <a href="CoreAddresses.md#0x1_CoreAddresses_assert_currency_info">assert_currency_info</a>(account: &signer) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="CoreAddresses.md#0x1_CoreAddresses_assert_currency_info">assert_currency_info</a>(account: &signer) { assert(<a href="../../../../../../move-stdlib/docs/Signer.md#0x1_Signer_address_of">Signer::address_of</a>(account) == @CurrencyInfo, <a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors_requires_address">Errors::requires_address</a>(<a href="CoreAddresses.md#0x1_CoreAddresses_ECURRENCY_INFO">ECURRENCY_INFO</a>)) } </code></pre> </details> <details> <summary>Specification</summary> <pre><code>pragma opaque; include <a href="CoreAddresses.md#0x1_CoreAddresses_AbortsIfNotCurrencyInfo">AbortsIfNotCurrencyInfo</a>; </code></pre>

Specifies that a function aborts if the account has not the currency info address.

<pre><code>schema <a href="CoreAddresses.md#0x1_CoreAddresses_AbortsIfNotCurrencyInfo">AbortsIfNotCurrencyInfo</a> { account: signer; aborts_if <a href="../../../../../../move-stdlib/docs/Signer.md#0x1_Signer_spec_address_of">Signer::spec_address_of</a>(account) != @CurrencyInfo with <a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors_REQUIRES_ADDRESS">Errors::REQUIRES_ADDRESS</a>; } </code></pre> </details>

Module `0x1::CoreAddresses`

Module 0x1::CoreAddresses

Constants

Function assert_diem_root

Function assert_treasury_compliance

Function assert_vm

Function assert_currency_info

Module `0x1::CoreAddresses`

Function `assert_diem_root`

Function `assert_treasury_compliance`

Function `assert_vm`

Function `assert_currency_info`