Le White Paper de HEX

Ceci est une traduction française non-officielle du White Paper de Hex, la cryptomonnaie créée par Richard Heart. Si vous avez des remarques n’hésitez pas à m’en faire part, je recherche actuellement des réviseurs. Vous pouvez me contacter par Télégram pour toute rectification à t.me/AntoineHexFrance. Merci! Pour plus de renseignements sur HEX rendez-vous sur https://hex.com

Introduction

HEX est un projet ayant pour ambition de remplacer un produit financier commun appelé le Certificat de Dépôt à Terme. C’est un jeton ERC-20 complètement automatisé sous la forme d’un contrat intelligent et basé sur la blockchain Ethereum. Informations et FAQ disponibles sur https://HEX.com (en anglais).

 

Le but de ce document est de présenter les fonctionnalités et les points forts du projet et de les vérifier ou les expliquer dans les termes contenus dans le contrat intelligent. Le fondateur du projet, Richard Heart, a fourni des versions expérimentales du code à la communauté via la chaîne Telegram http://t.me/HEXcrypto. J’ai participé à la discussion sur ce canal, révisé le code et même découvert un ou deux bugs (qui ont été corrigés lors des versions ultérieures). Je ne souhaite pas fournir de conseil ni de commentaire éditorial concernant les spécificités de cette cryptomonnaie. Ce document vise simplement à expliquer de manière objective les fonctions exécutées par le contrat.

Lien expiré

Pour une discussion plus approfondie sur les placements et les revenus que vous pouvez en tirer veuillez vous référer à ce document https://bit.ly/hex-staking-guide.

Lien expiré

Si vous trouvez ce document utile et voulez 10% de HEX en plus sur votre réclamation BTC et sur la participation via les portail de transformation: http://bit.ly/hex-info-ref.

Lien expiré

Si vous voulez maximiser votre participation via l’AA, utilisez mon contrat de Cost Averaging ici: https://bit.ly/hex-cost-averaging

Pré-lancement

Les développeurs de HEX créeront un snapshot de l’état de la blockchain BTC à une hauteur de bloc future donnée. C’est-à-dire que quelles que soient les adresses BTC que vous contrôlerez à ce moment-là, celles-ci seront enregistrées et référencées par le contrat. *Cette partie n’est pas codée dans le contrat intelligent mais prendra comme référence le lancement du contrat intelligent*

Avant le lancement, 3 éléments seront disponibles au grand public pour vérifier les réclamations.

1. Le snapshot de l’ensemble des UTXO avant modification (voir GoxMeNot)
2. Le snapshot de l’ensemble des UTXO après modification
3. Le code servant à générer l’arbre de Merkle et le hash supérieur

Grâce à ces éléments, toute partie intéressée devrait être en mesure de confirmer ses réclamations

1. Le snapshot a été pris correctement
2. Il a été édité correctement
3. Le hash supérieur dans le contrat est exact

Un outil de réclamation sera mis à disposition sur le site web de HEX afin d’aider les utilisateurs à signer l’adresse ETH cible avec leurs clés BTC privées. Des instructions seront fournies lorsque l’outil sera disponible. *Cette partie n’est pas déclarée dans le contrat mais la déclaration signée, la clé BTC publique et l’adresse Ethereum seront fournies au contrat qui effectuera la vérification.*

Note de la rédaction: la phase de réclamation BTC est maintenant terminée (depuis le 19 novembre 2020).

Note de la rédaction: la phase de réclamation BTC est maintenant terminée (depuis le 19 novembre 2020).

Les lobbies de transformation

Un autre moyen d’acquisition des jetons HEX est d’entrer dans un lobby de transformation (appelé Adoption Amplifier, abrégé AA, dans ce document). Tous les jours, 1/350ème des BTC non-réclamés sous forme de HEX est converti en ETH. Les ETH accumulés le jour précédent sont convertis en HEX. S’il y avait par exemple 350 000 bitcoins non-réclamés à la fin du jour 200, un millier de ces bitcoins aurait été convertis en HEX, c’est à dire 10 000 000 HEX (10 000*1000). Si 500 ETH étaient accumulés jusqu’au jour 200, à tout moment à partir du 201ème jour, un utilisateur aurait eu la possibilité de réclamer un montant de HEX égal à 10 000 000*le montant d’ETH contribué/sur le total d’ETH contribués au pool. Si vous aviez envoyé 1 ETH ce jour-là, vous auriez collecté 20 000 HEX.

Entrer dans un lobby de transformation implique d’envoyer des ETH à la fonction du contrat joinXfLobby. Tous les ETH envoyés en un jour sont enregistrés et vous pouvez appeler la fonction leaveXfLobby à tout moment par la suite pour réclamer votre part de HEX transformés. Il est possible de créer plusieurs entrées par jour et la fonction leaveXfLobby prend à la fois le numéro du jour et le nombre d’entrées afin de calculer les parts.

Le programme de parrainage est terminé depuis le 19 novembre 2020

Placer ses HEX

Placer ses HEX implique d’appeler une fonction du contrat intelligent permettant de bloquer vos jetons HEX pendant une certaine durée sur la blockchain. L’unité de temps utilisée à l’heure actuelle est le jour. Je peux par exemple placer 10 000 HEX pendant 10 jours. Pendant ce lapse de temps, je ne pourrai pas accéder à ces HEX mais après ces 10 jours je mettrai fin à mon placement et recevrai mes 10 000 HEX + les intérêts. Ceci est la fonctionnalité de Dépôt à Terme.

Les intérêts sont tirés d’un pool et sont basés sur ma part face au total des parts placées. J’utilise ici le mot “parts” intentionnellement car les bonus de placement sont calculés en fonction de votre part de HEX face à la totalité des HEX placés. Ce qui veut dire que si je place 10 HEX  et que je suis éligible à un bonus de 40%, mes 10 HEX deviendront 14 parts. Mes gains se basent sur ma part face à la totalité des parts placées, et non pas face au volume de total de HEX en circulation. Ceci est important car cela signifie que pour avoir les meilleurs retours il est important d’accumuler des bonus. C’est même peut-être plus important que de débuter votre portefeuille avec le plus de HEX possible. Il est bien plus facile d’avoir un bonus de 40% que d’acheter 40% de bitcoins en plus, voir les fonctions LongerPaysBetter/BiggerPaysBetter ci-dessous.

Prix des parts

Afin de garantir que les placements plus importants et plus longs rapportent toujours mieux, un mécanisme de fixation de prix a été conçu dans le contrat. À chaque fois qu’un placement est clôturé, les gains du placement sont calculés sous la forme de parts que tous les futurs investisseurs auront à payer pour convertir leurs HEX en parts à leur tour. Il est important de signaler que l’unité de base de HEX est le Heart. Les Hearts sont à HEX ce que les satoshis sont pour le bitcoin. Il y a 100 000 000 de Hearts dans chaque HEX.

Le prix des parts au lancement sera d’une part par Heart. La manière dont évolue le prix des parts est liée au retour sur investissement d’un placement. Par exemple, si au jour 5 quelqu’un clôture son placement et a 20% de gains, cela se traduit par un prix par part d’environ 1.2 Hearts. Si cet utilisateur souhaite faire un nouveau placement, ses Hearts seront divisés par 1,2 pour déterminer son nombre de parts. Puisque qu’Ethereum ne supporte que les calculs intégraux, ceci est réalisé à l’aide d’un scalaire qui est défini ci-dessous.

La formule exacte est:

(Bonus BPB + CappedHearts) * retour sur placement * SCALAIRE DES TAUX DES PARTS / ((Bonus LPB * nombre de parts) / (Bonus LPB + jours placés en extra) * bonus BPB);

Définition des termes:

• “BPB” a une valeur maximale de x 10 pour le bonus BiggerPaysBetter.
• “retour sur placement” est le montant total versé à la clôture d’un placement.
• SCALAIRE DES TAUX DES PARTS est un scalaire qui maintient la précision des résultats (au moment de l’écriture de cet article, il descend à 5 chiffres sous la décimale).
• les “parts”‘ représentent le nombre de parts dans ce placement.
• “LPB” est à 1820 au maxium; LPB = LongerPaysBetter – Bonus pour les placements de longue durée
• “extraStakedDays” équivaut à la moitié de 3640 (et jours placés – 1)
• Les “CappedHearts” sont votre retour sur placement minimum avec le maximum de bonus BiggerPaysBetter.

Ce calcul ajuste donc vos gains avec le bonus BiggerPaysBetter que vous gagnerez pour avoir placé vos HEX réclamés les premiers jours.

Cette fonction mathématique fait que vous ne pourrez jamais vraiment refaire de placement qu’avec au maximum les parts que vous venez de dégager.

Cette fonction garantit ainsi que les placements plus importants et plus longs rapportent toujours plus car personne ne peut manipuler la chaîne et entrer avec plus de parts dans le système qu’il n’en existe. Cela veut aussi dire qu’il est toujours plus bénéfique de placer ses HEX dès maintenant car le prix des jetons ne peut qu’augmenter.

Calcul des placements à terme et des intérêts

Le contrat accumule un pool de paiement tous les jours. Le pool des gains est rempli de l’inflation journalière de 0,009955% de l’offre totale des jetons, ce qui fait donc une inflation de 3,69% par tranches de 52 semaines (1 an), cette inflation étant générée quotidiennement. D’autre paramètres expliqués ci-après entrent en compte dans la formation du pool des gains. Lorsque votre placement se termine à la fin de votre période d’engagement, le contrat récapitule tous les jours de votre placement et regroupe vos gains totaux selon la formule suivante: Parts/Parts totales*gains du jour. Le contrat génère ensuite les jetons HEX et vous les crédite.

Les pièges du désistement

Placement clôturé en urgence ou écourté

Le contrat inclut une fonctionnalité permettant à l’utilisateur de clôturer son placement avant la fin de sa période d’engagement. Les utilisateurs paient en ce cas une pénalité. Le contrat calcule les gains pour la moitié de la période d’engagement (arrondie au jour supérieur), par exemple 182 jours pour une période de 52 semaines et soustrait cette somme des fonds retournés à l’utilisateur. Cette fonction appliquera une pénalité d’au moins 90 jours. Si je fais par exemple un placement pour 52 semaines (environ 1 an) et que je clôture mon placement en urgence après 266 jours (38 semaines), le contrat calculera mes gains pour les jours 1 à 182 et les comptera comme une pénalité. La somme qui me sera versée sera donc de mon Principal + gains des jours 183 à 266.

Si l’utilisateur clôture son placement avant la moitié de la période d’engagement ou si son placement est inférieur à 179 jours et en raison de la pénalité de 90 jours applicable à tous les placements, la pénalité de désengagement peut entamer son Principal. Le contrat prend simplement la moitié du nombre jours ou 90, selon laquelle des deux pénalités est la plus forte, évalue la valeur des jours non-honorés et les soustrait des fonds retournés.

Imaginons que j’effectue un placement de 364 jours et que je me désengage au jour 140, plusieurs étapes prennent place pour déterminer mon nombre de jetons à la sortie du contrat.

Le contrat calcule mes gains pour 140 jours et évalue une pénalité.

• Parce-ce que je n’ai pas honoré la moitié de mon engagement, il estime la différence en appliquant un ratio de moitié des jours honorés/jours honorés*gains.
• Dans ce cas ce sera 182 jours (la moitié des 364 jours d’engagement) divisé par les 140 jours honorés. La pénalité est donc de 182/140 * gains (la moitié des jours divisé par les jours honorés).
• Mon retour en HEX est donc égal à Principal + gains – pénalité.
  • La pénalité peut être définie comme une version négative des intérêts, mon retour net en HEX sera alors de Principal + (140/140 * gains) – (182/140 * gains)
  • Ce qui est simplifié en Principal – (42/140 * gains).
• Ce qui signifie que mon retour sera inférieur à mon investissement initial. Relisez ce passage encore une fois. Votre principal peut être entamé si vous vous désengagez avant la moitié de votre période d’engagement ou que votre durée de placement est inférieure à 179 jours en raison de la pénalité forfaitaire de 90 jours..

Déplacement tardif

Le système pénalise aussi les utilisateurs s’ils négligent leurs placements en les laissant sur la chaîne après leur date de fin d’engagement. Il y a une période grâce de 14 jours après la date de fin d’un placement après quoi la somme de HEX sera amputée de 0,143% par jour de retard (1% par semaine de retard). Si j’ai par exemple effectué un placement pour 52 semaines, j’ai des jours 365 à 379 pour clôturer mon placement et recevoir mes HEX, mes intérêts et les HEX bonus qui me sont dus. Après ce lapse de temps, mes gains totaux seront pénalisés à hauteur de 0,143% par jour. Ceci inclut le Principal, ce qui veut dire que si je suis en retard de 700 jours (juste en dessous de 2 ans), je ne recevrai aucun HEX peu importe la durée du placement ou le Principal.

Exemples de placements

Ceci est un exemple simplifié destiné à expliquer le flux du contrat. Cet exemple ignore le bonus LargerPaysBetter car nous voulons utiliser des unités assez petites afin de faire sens, ce qui veut dire des pourcentages de bonus ridicules. Plus d’informations disponible sur https://bit.ly/hex-staking-gainz. Lien expiré

• Imaginons que (A), (B), et (C) réclament chacun des HEX le même jour et que chacun reçoive 10 000 HEX.
• A place 10 000 HEX pendant 182 jours (6 mois), B place 10 000 HEX pendant 364 jours (Environ 1 an) et C place 10 000 HEX pendant 1 820 jours (environ 5 ans).
• Pour simplifier, supposons qu’il n’y ait que ces 3 participants et qu’ils reçoivent un taux par part de 1:1.
• Le contrat convertit les HEX en parts en utilisant le scalaire LongerPaysBetter (jour/1820) résultant en
  • (A) 10 000 * (1 + 182/1 820) = 11 000 parts
  • (B) 10 000 * (1 + 364/1 820) = 12 000 parts
  • (C) 10 000 * (1 + 1820/1 820) = 20 000 parts
  • Le total des parts se monte à 43 000.
• Tous les jours, un pool de gains est accumulé à partir du calcul suivant: Inflation * (1 + bonus de Masse Critique + bonus de Viralité). Supposons, pour simplifier, qu’il n’y ait aucune autre réclamation de manière à ce que la Masse Critique et la Viralité restent constantes.
• Pour cet exemple, imaginons que l’inflation soit de 714,285 HEX par jour, 15% de bonus de Masse Critique et 25% de bonus de Viralité, renvoyant ainsi un pool de gains quotidiens de 714,285 * (1 + 0,15 + 0,25) = 1 000 HEX par jour.
  • Disons qu’au 1er jour, le pool se monte à 1 000 HEX répartis entre les 43 000 parts.
  • Le 2ème jour, le pool est de 1 000 HEX répartis entre les 43 000 parts.
  • Et ainsi de suite. Jusqu’au jour 182.
• Au jour 182, (A) clôture son placement sans pénalité.
  • Le contrat récapitule tous les jours entre les jours 1 et 182.
  • Il agrège les gains de (A) en utilisant les parts de (A) / total des parts.
    • 1 000 HEX * 11 000 parts de (A) / 43 000 parts au total = 255,81 HEX
  • Le calcul recommence pour chacun des 182 jours renvoyant à un retour de 46 557,42 HEX.
  • Ces jetons sont générés et versés à son adresse en plus des 10 000 HEX initiaux
  • L’adresse de (A) contient donc désormais 56 557,42 HEX.

Ce processus se répétera pour (B) et (C) une fois leurs placements arrivés à maturité, c’est à dire à 364 et 1820 jours respectivement.

Bonus de réclamation

Ces bonus et modulateurs sont répertoriés dans l’ordre dans lequel ils sont appliqués.

Bonus et modulateurs

Tous les bonus et modulateurs décrits ici sont mis en avant sur le site web et sont codés à l’intérieur même du contrat. Je les ai tous révisés et ait validé les formules mathématiques et l’ordre des opérateurs à l’aide de la documentation Solidity (si vous ne comprenez pas ce que ça signifie, ça veut dire que j’ai vérifié que le contrat fasse bien ce qu’il est supposé faire).

Note de la rédaction: la phase de réclamation BTC est maintenant terminée (depuis le 19 novembre 2020). Ces bonus ne sont donc plus applicables.

Bonus de placement

Modificateurs du pool des paiements

Note de la rédaction: la phase de réclamation BTC est maintenant terminée (depuis le 19 novembre 2020). Le bonus “Nous Sommes Tous Satoshi” n’est donc plus applicable.

Masse critique et viralité

Je répertorie ici ces bonus ensemble car ils fonctionnent de manière similaire et sont concaténés dans le contrat. La masse critique est un bonus qui s’applique au pool des paiements de sortie et est égal au calcul suivant: jetons réclamés / total des jetons potentiels. S’il y a donc au total 17 500 000 jetons réclamables et que 13 125 000 jetons sont réclamés ce bonus sera alors de 75%. La viralité est similaire mais pour les adresses bitcoins. Il s’agit du calcul suivant: nombre d’adresses BTC éligibles / total des adresses éligibles. Les bonus sont cumulatifs, c’est-à-dire qu’ils sont calculés chacun séparément et ajouté aux gains selon la formule (gains*(1 + jetons réclamés/total des jetons + adresses réclamées / total des adresses réclamées)).

Désengagement en avance ou en retard

Ces dernières fonctions ne sont pas des bonus mais au contraire des pénalités générées par les autres participants. Comme décrit dans la section des pièges du désistement, certaines actions des utilisateurs donnent lieu à des pénalités. La moitié des jetons HEX payée en pénalités est ajoutée au pool des gains pour le prochain cycle. Les jetons HEX provenant de pénalités sont accumulés dans un “pool de pénalités”, ce pool étant vidé chaque jour dans le pool des gains du jour en attendant le cycle du lendemain. De manière à ce que le pool des gains de chaque jour s’accroisse par les pénalités versées le jour d’avant. Supposons par exemple qu’un total de 10 000 HEX soient perdus en pénalités le 10ème jour de placement, le pool des gains du 11ème jour contiendra donc de 5 000 HEX en plus des jetons générés ce jour là. Ensuite, toujours au cours du 11ème jour, 15 000 HEX sont perdus en pénalités. Le pool des gains du 12ème jour contiendra donc 7 500 HEX en plus de l’inflation générée ce jour-là. Et ainsi de suite.

Modifier votre placement

Ces bonus sont un moyen de multiplier vos HEX jusqu’à ce qu’il deviennent des parts. Le bonus LongerPaysBetter est plafonné à x2 en l’espace de 10 ans ou de 3641 jours et le bonus BiggerPaysBetter est plafonné à 10% pour les placement de 150 000 000 HEX ou plus. C’est-à-dire qu’avec un placement de 10 ans, vos parts sont égales à trois fois vos jetons. Avec un placement de 75 000 000 HEX vous recevez un bonus de 5% en plus de tous les bonus précédents. Le total après bonus est le nombre utilisé pour calculer vos parts.

Un placement plus long rapporte toujours plus (LongerPaysBetter)

Plus vous placez vos jetons longtemps, plus vous en gagnez. La formule est la suivante: (jours placés – 1) / 1820. Ça a l’air compliqué comme ça mais cela revient à 20% par année de placement (le contrat utilise des années à 364 jours). Le ‘moins 1’ compte comme la durée de placement minimum qui est de 1 jour.

Un placement plus grand rapporte toujours plus (BiggerPaysBetter)

Plus votre placement est important plus vous y gagnez. La formule de ce bonus est la suivante: jetons HEX/150*10^7. Ce bonus est plafonné à 10% pour les placements supérieurs 150 000 000 HEX. Remarque: le pourcentage est plafonné, le nombre de HEX en bonus ne l’est pas.

Exemples de placements

• 1 000 000 HEX = 0,0667% bonus, ou 667 HEX en bonus
• 10 000 000 HEX = 0,667% bonus, ou 66 667 HEX en bonus
• 100 000 000 HEX = 6,67% bonus, ou 6 666 667 HEX en bonus
• 200 000 000 HEX = 10,0% bonus, ou 20 000 000 HEX en bonus

L’Adresse d’Origine

Le contrat spécifie une adresse ETH comme étant l’Adresse d’Origine. Cette adresse accumule les HEX versés par le contrat de plusieurs manières.

• La moitié des jetons HEX perdus en pénalités par les stakers est versée à l’Adresse d’Origine (l’autre moitié étant versée au pool de paiement des intérêts).
• Une copie de tous les bonus versés aux stakers est aussi octroyée à l’Adresse d’Origine.
  • Bonus de vitesse de réclamation
  • Bonus de parrainage
  • Incréments “We Are All Satoshi” (bonus “Nous Sommes Tous Satoshi”)
  • Bonus de masse critique et de viralité

Fonctions du contrat

Cette section est plus technique et traite des différentes fonctions incluses dans le contrat intelligent HEX et qui peuvent être appelées par tout participant pourvu qu’il s’acquitte des frais de GAS. Certaines de ces fonctions sont marquées comme “externes” et d’autres comme “publiques”. D’après la documentation de Solidity, il n’y a aucune distinction du point de vue des utilisateurs outre le fait que les fonctions externes sont parfois plus économes en GAS. Je suppose que ces libellés sont plus fait pour que les développeurs puissent repérer quelles fonctions sont susceptibles d’être appelées de manière régulière par les clients externes.

Fonctions externes

Ces fonctions “externes” sont les interactions courantes ordinaires que vous avez avec le contrat.

Fonctions informatives

Ces fonctions sont liées aux informations que l’on peut tirer du contrat.

globalInfo

Cette fonction retourne l’état global du contrat sous la forme d’un tableau de valeurs

• lockedHeartsTotal (total des Hearts placés)
• nextStakeSharesTotal (total des parts des prochains placements)
• shareRate (taux des parts)
• stakePenaltyPool (pool des pénalités de placement)
• daysStored (nombre de jours placés)
• stakeSharesTotal (total des parts placées)
• latestStakeId (id du dernier placement)
• unclaimedSatoshisTotal (total des satoshis non-réclamés)
• claimedSatoshisTotal (total des satoshis réclamés)
• claimedBtcAddrCount (nombre d’adresses BTC ayant réclamé leurs jetons)
• currentContractDay (jour actuel du contrat)
• totalSupply (volume total en circulation)

allocatedSupply (réserve allouée)

Retourne le volume total de HEX en circulation ainsi que le volume agrégé de HEX placés. Ceci est une fonction qui diffère de la fonction ERC-20 “totalSupply” car le contrat détruit les HEX placés, ce qui veut dire qu’ils ne seront pas pris en compte par la fonction “totalSupply”.

totalSupply (réserve totale)

Retourne le volume total de HEX générés, synonyme du volume en circulation de jetons HEX.

dailyDataUpdate (mise à jour quotidienne)

Cette fonction prend comme variable un numéro de jour (depuis le lancement de HEX), 0 étant interprété comme le “jour actuel”. Cette fonction est idempotente et calcule les gains du jour actuel avant ceux du jour demandé. Si j’appelle par exemple cette fonction 1 an après le lancement avec un paramètre de “343” elle calculera toutes les données du placement pour les jours 1 à 342 ou pour tous les jours qui n’ont pas encore été calculés.

dailyDataRange (fluctuations quotidiennes)

Cette fonction prend comme variables le numéro du jour et le nombre de jours. C’est une fonction de recherche de données qui retourne la liste des paiements de sortie pour la période requise. Les données sont encapsulées dans des valeurs uint256 (snapshot des satoshis non-réclamés<<160, total des parts << 80, total des gains).

currentDay (jour actuel)

Retourne le numéro du jour actuel depuis le lancement du contrat.

Fonctionnalités de transformation

Fonctions servant à participer dans un lobby de transformation et fonctions liées.

xfLobbyEnter (entrer dans un lobby de transformation)

Verse les ETH fournis dans le lobby de transformation du jour actuel. Si l’adresse d’un référent est fournie, elle est capturée afin de créditer votre référent avec un bonus de parrainage lorsque vous sortirez du lobby (et collecterez vos HEX). Plusieurs entrées peuvent être enregistrées en une seule journée, elles seront alors inscrites dans une file d’attente qui sera ordonnée selon la durée des placements, les placements plus courts passant en avant.

xfLobbyExit (sortir du lobby de transformation)

Prend un jour cible et le nombre d’entrées à récapituler. Supposons que vous entriez dans le lobby le 3ème jour 4 fois d’affilée. Après le 3ème jour, vous pourrez appeler cette fonction avec le paramètre 3 pour le numéro du jour et un paramètre de 0 à 4 pour le nombre d’entrées à récapituler. 0 signifiant “la totalité des entrées”. Le contrat récapitulera alors le nombre donné d’entrées de la plus ancienne à la plus récente, agrégeant le nombre de HEX générés et générera par la même occasion le bonus de parrainage de votre référent.

Dans l’exemple précédent, supposons que les première et deuxième entrées aient des référents différents appelés A et B. Si j’appelle la fonction leaveXfLobby(3, 2), le contrat calculera mes HEX transformés de la première entrée, générera le bonus de parrainage crédité à A, calculera les HEX transformés pour la seconde entrée, générera le bonus de parrainage crédité à B et générera enfin mon volume total de HEX.

xfLobbyflush

Verse les ETH transformés à une adresse temporaire prédéfinie.

xfLobbyRange

Retourne le volume du lobby pour une période donnée en jours spécifiée par les paramètres de date de début et de fin.

xfLobbyEntry

Retourne le volume d’ETH et le référent pour une entrée donnée d’un jour donné. Le paramètre “entryId” retourne un paquet contenant la valeur du jour et un index des entrées dans la file d’attente.

xfLobbyPendingDays

Retourne une liste des jours qui ont des entrées en attente disponibles à la collecte.

Fonctions de placement

Les fonctions de placement ou liées au mécanisme de placement.

stakeStart (début de placement)

Démarre un placement. Prend comme variables le montant du placement et la durée du placement. Le contrat calcule les parts d’après la durée du placement et ajoute une entrée de placement pour l’utilisateur. L’identifiant de ce placement est tout simplement égal au nombre de placements dans le contrat plus 1. Supposons que j’aie 3 placements actifs et que d’autres utilisateurs aient un volume total combiné de 20 placements actifs. La fonction globale “next stake id” est de 24 et démarre un nouveau placement. Pour faire référence au nouveau placement plus tard, son id sera 24. Démarrer un nouveau placement détruit les HEX placés et les enregistre dans la fonction globale “allocated supply”.

stakeEnd (fin du placement)

Clôture un placement. La logique du calcul des gains varie quelque peu selon que le placement ait été clôturé en avance, en retard ou à temps. Le détail est expliqué plus haut. Les variables de cette fonctions sont l’id du placement (cet id a été attribué lors du processus de placement) et l’index du placement entre tous les placements actifs d’un utilisateur. Cette fonction génère des nouveaux jetons HEX pour honorer le retour du placement et les ajoute au total du volume (en circulation).

stakeGoodAccounting (comptabilité du placement)

Cette fonction clôture les placements arrivés à maturité de manière sûre. Si le placement n’est pas arrivé à maturité, cette fonction retourne une erreur. Elle ne paie pas le participant. Elle peut être appelée par quiconque de la part de tout participant ayant accès à vos clés privées. Elle prend comme variables une adresse de placement et un id de placement pour cette adresse.

stakeCount

Cette fonction retourne le nombre de placements actifs que possède cet utilisateur.

Note de la rédaction: la phase de réclamation BTC est maintenant terminée (depuis le 19 novembre 2020).

Fonctions publiques

Ces fonctions sont les fonctions publiques que le contrat est capable d’appeler mais qui peuvent ne pas avoir de sens pour vous. Cette déclaration deviendra plus claire grâce aux lignes ci-dessous.

claimMessageMatchesSignature (le message de réclamation correspond à la signature)

Synthétise un message de réclamation provenant d’une clé et la compare à l’adresse extraite du message recréé et de l’adresse convertie à partir d’une clé publique.

pubKeyToEthAddress

Sert à convertir une clé publique en une adresse ETH.

pubKeyToBtcAddress

Sert à convertir une clé publique en une adresse BTC.

Évènements du contrat

Les évènements ont été restructurés dans le contrat afin d’utiliser une solution de compression de bits propriétaire, ces valeurs ne sont donc pas correctes. Les valeurs que les fonctions capturent sont toutes documentées ci-dessous avec des approximation de taille.

La compression de bits signifie que l’auteur du contrat et du protocole n’utilise que des valeurs uint256 et a encodé la structure qui emplit les 256 bits en segments prévisibles. Il en est ainsi car le langage Solidity n’autorise que les tailles uint (valeurs intègres positives ) en incréments de 8 bits alors que beaucoup de valeurs dans HEX nécessitent des nombres proches d’un multiple de 8. Ce qui veut dire que l’efficacité des prix des transactions en GAS peut encore améliorée en utilisant des tailles précises et en encodant les valeurs en uint256.

XfLobbyEnter

Émis lors de votre entrée dans un des lobbies quotidiens.

Champs

uint40 timestamp,

address indexed memberAddr,

uint256 indexed entryId,

uint96 rawAmount,

address indexed referrerAddr

XfLobbyExit

Émis lors de la sortie d’un lobby de transformation. Pour les appels xfLobbyExit à plusieurs entrées, plusieurs événements sont émis.

Champs

uint40 timestamp,

address indexed memberAddr,

uint256 indexed entryId,

uint72 xfAmount,

address indexed referrerAddr

DailyDataUpdate (mise à jour quotidienne des données)

Émis à la fin d’une mise à jour quotidienne. Un seul événement est émis par lot de données journalières calculées.

Champs

uint40 timestamp,

uint16 daysStoredAdded,

uint16 daysStoredTotal,

bool isAutoUpdate,

address indexed updaterAddr

Fonctions de réclamation

Émis après une réclamation BTC.

Champs

uint40 timestamp,

address indexed claimToAddr,

bytes20 indexed btcAddr,

uint8 claimFlags,

uint56 rawSatoshis,

uint56 adjSatoshis,

uint72 claimedHearts,

address indexed referrerAddr,

address senderAddr

ClaimAssist

Émis lors de l’achèvement d’une réclamation BTC lorsque le réclamant n’est pas celui qui a fait appel au contrat. Cet événement est émis en plus des événements de réclamation cités ci-dessus.

Champs

uint40 timestamp,

address claimToAddr,

bytes20 btcAddr,

uint8 claimFlags,

uint56 rawSatoshis,

uint56 adjSatoshis,

uint72 claimedHearts,

address referrerAddr,

address indexed senderAddr

StakeStart (début de placement)

Émis au début d’un placement.

Champs

uint40 timestamp,

address indexed stakerAddr,

uint40 indexed stakeId,

uint72 stakedHearts,

uint72 stakeShares,

uint16 stakedDays,

bool isAutoStake

StakeGoodAccounting

Emis lors de l’appel à la fonction stakeGoodAccounting si celle-ci réussit.

Champs

uint40 timestamp,

address indexed stakerAddr,

uint40 indexed stakeId,

uint72 payout,

uint72 penalty,

address indexed senderAddr

StakeEnd

Émis lors de la clôture d’un placement.

Champs

uint40 timestamp,

address indexed stakerAddr,

uint40 indexed stakeId,

uint72 payout,

uint72 penalty,

uint16 servedDays

ShareRateChange

Émis si le taux des parts change en fonction de la fonction endStake et remplace la valeur par le nouveau taux des parts.

Champs

uint40 timestamp,

uint40 shareRate,

uint40 indexed stakeId