ContextQMD
Back to Diem

Diem Framework Modules

language/diem-framework/modules/doc/overview.md

latest7.5 KB
Original Source

<a name="@Diem_Framework_Modules_0"></a>

Diem Framework Modules

This is the root document for the Diem framework module documentation. The Diem framework provides a set of Move modules which define the resources and functions available for the Diem blockchain. Each module is individually documented here, together with its implementation and formal specification.

Move modules are not directly called by clients, but instead are used to implement transaction scripts. For documentation of transaction scripts which constitute the client API, see ../../script_documentation/script_documentation.md.

The Move modules in the Diem Framework can be bucketed in to a couple categories:

<a name="@Treasury_and_Compliance_1"></a>

Treasury and Compliance

  • <code><a href="AccountFreezing.md#0x1_AccountFreezing">AccountFreezing</a></code>

  • <code><a href="AccountLimits.md#0x1_AccountLimits">AccountLimits</a></code>

  • <code><a href="DesignatedDealer.md#0x1_DesignatedDealer">DesignatedDealer</a></code>

  • <code><a href="DualAttestation.md#0x1_DualAttestation">DualAttestation</a></code>

  • <code><a href="XUS.md#0x1_XUS">XUS</a></code>

  • <code><a href="XDX.md#0x1_XDX">XDX</a></code>

  • <code><a href="Diem.md#0x1_Diem">Diem</a></code>

  • <code><a href="RegisteredCurrencies.md#0x1_RegisteredCurrencies">RegisteredCurrencies</a></code>

<a name="@Authentication_2"></a>

Authentication

  • <code><a href="Authenticator.md#0x1_Authenticator">Authenticator</a></code>
  • <code><a href="RecoveryAddress.md#0x1_RecoveryAddress">RecoveryAddress</a></code>
  • <code><a href="SharedEd25519PublicKey.md#0x1_SharedEd25519PublicKey">SharedEd25519PublicKey</a></code>
  • <code><a href="Signature.md#0x1_Signature">Signature</a></code>

<a name="@Accounts_and_Access_Control_3"></a>

Accounts and Access Control

  • <code><a href="DiemAccount.md#0x1_DiemAccount">DiemAccount</a></code>
  • <code><a href="Roles.md#0x1_Roles">Roles</a></code>
  • <code><a href="VASP.md#0x1_VASP">VASP</a></code>

<a name="@System_Management_4"></a>

System Management

  • <code><a href="ChainId.md#0x1_ChainId">ChainId</a></code>
  • <code><a href="DiemBlock.md#0x1_DiemBlock">DiemBlock</a></code>
  • <code><a href="DiemConfig.md#0x1_DiemConfig">DiemConfig</a></code>
  • <code><a href="DiemTimestamp.md#0x1_DiemTimestamp">DiemTimestamp</a></code>
  • <code><a href="DiemTransactionPublishingOption.md#0x1_DiemTransactionPublishingOption">DiemTransactionPublishingOption</a></code>
  • <code><a href="DiemVersion.md#0x1_DiemVersion">DiemVersion</a></code>
  • <code><a href="DiemVMConfig.md#0x1_DiemVMConfig">DiemVMConfig</a></code>
  • <code><a href="TransactionFee.md#0x1_TransactionFee">TransactionFee</a></code>
  • <code><a href="DiemSystem.md#0x1_DiemSystem">DiemSystem</a></code>
  • <code><a href="ValidatorConfig.md#0x1_ValidatorConfig">ValidatorConfig</a></code>
  • <code><a href="ValidatorOperatorConfig.md#0x1_ValidatorOperatorConfig">ValidatorOperatorConfig</a></code>
  • <code><a href="Genesis.md#0x1_Genesis">Genesis</a></code> (Note: not published on-chain)

<a name="@Module_Utility_Libraries_5"></a>

Module Utility Libraries

  • <code><a href="../../../../../../move-stdlib/docs/Errors.md#0x1_Errors">Errors</a></code>
  • <code><a href="CoreAddresses.md#0x1_CoreAddresses">CoreAddresses</a></code>
  • <code><a href="../../../../../../move-stdlib/docs/Event.md#0x1_Event">Event</a></code>
  • <code><a href="../../../../../../move-stdlib/docs/FixedPoint32.md#0x1_FixedPoint32">FixedPoint32</a></code>
  • <code><a href="../../../../../../move-stdlib/docs/Hash.md#0x1_Hash">Hash</a></code>
  • <code><a href="../../../../../../move-stdlib/docs/BCS.md#0x1_BCS">BCS</a></code>
  • <code><a href="../../../../../../move-stdlib/docs/Option.md#0x1_Option">Option</a></code>
  • <code><a href="SlidingNonce.md#0x1_SlidingNonce">SlidingNonce</a></code>
  • <code><a href="../../../../../../move-stdlib/docs/Vector.md#0x1_Vector">Vector</a></code>
  • <code><a href="../../../../../../move-stdlib/docs/Signer.md#0x1_Signer">Signer</a></code>

<a name="@Index_6"></a>

Index