Créer une Machine Virtuelle (VM)

Créer une Machine Virtuelle (VM) sur le réseau d'Avalanche

Note

Le code ci-dessous est légèrement obsolète. Certaines méthodes, interfaces et implémentations sont légèrement différentes de celles de ce tutoriel. Nous allons laisser cela en place car le code actuel est très similaire et ce tutoriel est toujours utile pour démontrer le fonctionnement du modèle de VM d'Avalanche.

Introduction

L'une des principales fonctionnalités du réseau Avalanche est la création de nouvelles blockchains personnalisées, définies par des machines virtuelles (VMs).

Dans ce didacticiel, nous allons créer une machine virtuelle très simple. La blockchain définie par la machine virtuelle est un serveur d'horodatage. Chaque bloc de la blockchain contient l’horodatage de sa création ainsi qu’un élément de données de 32 octets (payload). L’horodatage de chaque bloc est postérieur à l’horodatage de son parent.

Un tel serveur est utile car il peut être utilisé pour prouver qu'une donnée existait au moment de la création du bloc. Par exemple, supposons que vous ayez un manuscrit de livre et que vous souhaitiez pouvoir prouver à l'avenir que le manuscrit existe aujourd'hui. Vous ajoutez un bloc à la blockchain où la charge utile du bloc est un hachage de votre manuscrit. À l'avenir, vous pouvez prouver que le manuscrit existait aujourd'hui en montrant que le bloc, qui a un horodatage d'aujourd'hui, a comme payload le hachage de votre manuscrit. (Cela découle du fait qu'il est impossible de trouver la pré-image d'un hachage.)

Avant d’arriver à l'implémentation de la machine virtuelle, nous allons examiner l’interface qu’une machine virtuelle doit implémenter pour être compatible avec le moteur de consensus de ma plateforme Avalanche.

Nous allons montrer et expliquer tout le code qui constitue cette machine virtuelle dans des extraits. Les commentaires en ligne expliquent ce qui se passe dans le code. Au bas de certains extraits, nous expliquons plus en détail certaines parties du code. Si vous souhaitez voir le code à un seul endroit, plutôt que dans des extraits de code, vous pouvez le voir dans notre Github repositiory.

L'interface de snowman.VM

Pour parvenir à un consensus sur les blockchains linéaires (par opposition aux blockchains DAG), Avalanche utilise le moteur de consensus Snowman alimenté par Avalanche. La blockchain que nous définissons est linéaire, elle utilisera donc Snowman. Pour être compatible avec Snowman, la machine virtuelle qui définit la blockchain doit implémenter l'interface snowman.VM, que nous incluons ci-dessous à partir de sa déclaration dansgithub.com/ava-labs/avalanchego/snow/engine/snowman/vm.go.

L'interface est grande, mais ne vous inquiétez pas. Nous allons expliquer chaque méthode et voir un exemple d'implémentation, et il n'est pas nécessaire que vous compreniez chaque nuance.

// ChainVM defines the methods a Virtual Machine must implement to use the Snowman consensus engine.
//
// A Snowman VM defines the state contained in a linear blockchain,
// the state transition functions that modify the blockchain's state,
// the API exposed by the blockchain, as well as other aspects of the blockchain.
type ChainVM interface {
    // Initialize an instance of the blockchain defined by this VM.
    // [ctx]: Run-time context and metadata about the blockchain.
    //     [ctx.networkID]: The ID of the network this blockchain exists on.
    //     [ctx.chainID]: The unique ID of this blockchain.
    //     [ctx.Log]: Used to log messages
    //     [ctx.NodeID]: The ID of this node.
    // [db]: The database the blockchain persists data to.
    // [genesisBytes]: The byte representation of the genesis state of this blockchain.
    //                 If this VM were an account-based payments system, for example
    //                 `genesisBytes` would probably be a genesis
    //                 transaction that gives coins to some accounts, and this
    //                 transaction would be in the genesis block.
    // [toEngine]: The channel used to send messages to the consensus engine.
    // [fxs]: Feature extensions that attach to this VM.
    // In this release, we do not document feature extensions. You can ignore them.
    Initialize(
        ctx *snow.Context,
        db database.Database,
        genesisBytes []byte,
        toEngine chan<- Message,
        fxs []*Fx,
    ) error

    // Shutdown this blockchain.
    Shutdown()

    // Creates the HTTP handlers for this blockchain's API
    // and specifies the endpoint where they handle traffic.
    //
    // Each handler handles traffic to a specific endpoint.
    // Each endpoint begins with:
    // [Node's address]:[Node's HTTP port]/ext/bc/[blockchain ID]
    // A handler may handle traffic at an *extension* of the above endpoint.
    //
    // The method returns a mapping from an extension to the HTTP handler at that extension.
    //
    // For example, if this VM implements an account-based payments system,
    // CreateHandlers might return this map:
    // "accounts" --> [handler for API calls that pertain to accounts]
    // "transactions" --> [handler for API calls that pertain to transactions]
    //
    // The accounts handler would have endpoint [Node's address]:[Node's HTTP port]/ext/bc/[blockchain ID]/accounts
    // The trasnsactions handler would have endpoint [Node's address]:[Node's HTTP port]/ext/bc/[blockchain ID]/trasnsactions
    //
    // If a handler is mapped to by the empty string, it has no extension.
    // It handles traffic at [Node's address]:[Node's HTTP port]/ext/bc/[blockchain ID]
    CreateHandlers() map[string]*HTTPHandler

    // Attempt to create a new block from pending data in the blockchain's mempool.
    //
    // If there is no new block to be created, returns an error.
    BuildBlock() (snowman.Block, error)

    // Attempt to create a block from its byte representation.
    ParseBlock([]byte) (snowman.Block, error)

    // Attempt to fetch a block by its ID.
    //
    // If the block does not exist, returns an error.
    GetBlock(ids.ID) (snowman.Block, error)

    // Set the preferred block to the one with the specified ID.
    // New blocks will be built atop the preferred block.
    //
    // This should always be a block that has no children known to consensus.
    SetPreference(ids.ID)

    // LastAccepted returns the ID of the last accepted block.
    //
    // If no blocks have been accepted yet, should return the genesis block's ID.
    LastAccepted() ids.ID
}

L'interface de snowman.Block

Vous avez peut-être remarqué le type snowman.Block référencé dans l'interface snowman.VM. Il décrit les méthodes qu'un bloc doit implémenter pour être un bloc dans une chaîne linéaire (Snowman).

Examinons cette interface et ses méthodes, que nous copions depuis github.com/ava-labs/avalanchego/snow/consensus/snowman/block.go.

Bibliothèques

Nous avons créé certains types que votre implémentation de machine virtuelle peut intégrer (l'intégration est comme la version d'héritage de Go) afin de gérer le code standard.

Dans notre exemple, nous utilisons les deux types de bibliothèques ci-dessous et nous vous encourageons à les utiliser également.

core.SnowmanVM

Ce type, une structure, contient des méthodes et des champs communs à toutes les implémentations de l'interface snowman.ChainVM.

Méthodes

Ce type implémente les méthodes suivantes, qui font partie de l'interface snowman.ChainVM :

  • SetPreference

  • Shutdown

  • LastAccepted

Si votre implémentation de machine virtuelle intègre un core.SnowmanVM, vous n'avez besoin d'implémenter aucune de ces méthodes car elles sont déjà implémentées par core.SnowmanVM. Vous pouvez, si vous le souhaitez, remplacer ces méthodes héritées.

Champs

Ce type contient plusieurs champs que vous souhaiterez inclure dans votre implémentation de machine virtuelle. Parmi eux on retrouve :

  • DB: la base de données de la blockchain.

  • Ctx: le contexte d'exécution de la blockchain.

  • preferred: ID du bloc préféré, sur lequel les nouveaux blocs seront construits.

  • lastAccepted: ID du bloc le plus récemment accepté.

  • toEngine: le canal par lequel les messages sont envoyés au moteur de consensus alimentant la blockchain.

  • State: utilisé pour conserver des données telles que des blocs. Peut être utilisé pour mettre / obtenir des octets.

core.Block

Ce type, une structure, contient des méthodes et des champs communs à toutes les implémentations de l'interface snowman.Block.

Méthodes

Ce type implémente les méthodes suivantes, qui font partie de l'interface snowman.Block:

  • ID

  • Parent

  • Accept

  • Reject

  • Status

Your Virtual Machine implementation will probably override Accept and Reject so that these methods cause application-specific state changes.

Fields

core.Block has a field VM, which is a reference to a core.SnowmanVM. This means that a core.Block has access to all of the fields and methods of that type.

Implémentation du serveur d'horodatage

Nous connaissons maintenant l'interface que notre machine virtuelle doit implémenter et les bibliothèques que nous pouvons utiliser pour construire une machine virtuelle.

Écrivons notre machine virtuelle, qui implémentesnowman.VM, et dont les blocs implémentent snowman.Block.

Block

Voyons d'abord notre implémentation de Block.

La déclaration de type est :

La balise serialize:"true" indique que lorsqu'un bloc est sérialisé (lorsqu'il est conservé dans la base de données ou envoyé à d'autres nœuds, par exemple), le champ avec la balise est inclus dans la représentation sérialisée.

Vérifiez

C'est tout pour le code d'implémentation de Block ! Toutes les autres méthodes desnowman.Block, que notre Block doit implémenté sont héritées de *core.Block.

Machine Virtuelle

Voyons maintenant l'implémentation de VM, qui implémente l'interface snowman.VM.

La déclaration est :

Initialiser

proposeBlock

Cette méthode ajoute un élément de données au mempool et informe la couche de consensus de la blockchain qu'un nouveau bloc est prêt à être construit et voté. Nous verrons plus tard où le call se fait.

ParseBlock

NewBlock

BuildBlock

Cette méthode est appelée par la couche de consensus après que la couche d'application lui a dit qu'un nouveau bloc est prêt à être construit (c'est-à-dire lorsque vm.NotifyConsensus () est appelé)

CreateHandlers

Service

AvalancheGo utilise la bibliothèque RPC de Gorilla. pour implémenter des API.

En utilisant Gorilla, il existe une structure pour chaque service d'API. Dans le cas de cette blockchain, il n'y a qu'un seul service d'API.

La déclaration de la structure de service est :

Pour chaque méthode API, il y a: * Une structure qui définit les arguments de la méthode * Une structure qui définit les valeurs de retour de la méthode * Une méthode qui implémente la méthode API, et est paramétrée sur les 2 structures ci-dessus

ProposeBlock

Cette méthode API permet aux clients d'ajouter un bloc à la blockchain .

GetBlock

Cette méthode API permet aux clients d'obtenir un bloc par son ID.

API

L'API résultante a les méthodes suivantes:

timestamp.getBlock

Obtenez un bloc par son identifiant. Si aucun ID n'est fourni, vous obtenez le dernier bloc.

Signature

  • id est l'ID du bloc en cours de récupération. Si omis des arguments, on obtient le dernier bloc

  • data est la représentation en base 58 (avec somme de contrôle) de la charge utile de 32 byte payload

  • timestamp est l'horodatage Unix lorsque ce bloc a été créé

  • parentID est le parent du bloc

Exemple d'appel :

Exemple de résponse :

timestamp.proposeBlock

Proposez la création d'un nouveau bloc.

Signature

  • data est la représentation en base 58 (avec somme de contrôle) de la charge utile de 32 byte payload du bloc.

Exemple d'appel :

Exemple de réponse :

Récapitulatif

C'est tout ! C'est l'implémentation complète d'une machine virtuelle qui définit un serveur d'horodatage basé sur la blockchain.

Dans ce tutoriel, nous avons appris :

  • L'interface snowman.ChainVM, que toutes les machines virtuelles qui définissent une chaîne linéaire doivent implémenter

  • L'interface snowman.Block, que tous les blocs faisant partie d'une chaîne linéaire doivent implémenter

  • Les types de bibliothèques core.SnowmanVM et core.Block, qui accélèrent la définition des machines virtuelles

Mis à jour

Ce contenu vous a-t-il été utile ?