API JSON-RPC

Dernière modification: @XofEE(opens in a new tab), 29 mars 2024

Afin qu'une application logicielle interagisse avec la blockchain Ethereum (en lisant les données de la blockchain ou en envoyant des transactions au réseau), elle doit se connecter à un nœud Ethereum.

À cet effet, chaque client Ethereum implémente une spécification JSON-RPC(opens in a new tab), ainsi il existe un ensemble uniforme de méthodes sur lesquelles les applications peuvent s'appuyer en fonction des spécificités du nœud ou de l'implémentation client.

JSON-RPC(opens in a new tab) est un protocole léger de procédure d'appel à distance (RPC). Il définit plusieurs structures de données et les règles entourant leur traitement. C'est un système de transport agnostique en ce sens que les concepts peuvent être utilisés dans le même processus, via les sockets et HTTP, ou dans de nombreux environnements de passage de messages. Il utilise JSON (RFC 4627) comme format de données.

Implémentations de client

Les clients Ethereum peuvent chacun utiliser différents langages de programmation lors de l'implémentation de la spécification JSON-RPC. Consultez la documentation individuelle client pour plus de détails concernant des langages de programmation spécifiques. Nous vous recommandons de consulter la documentation de chaque client pour connaître les dernières informations de support de l'API.

Bibliothèques pratiques

Bien que vous puissiez choisir d'interagir directement avec les clients Ethereum via l'API JSON-RPC, il y a souvent des options plus faciles pour les développeurs de dapp. De nombreuses librairies JavaScript et backend API existent pour fournir des wrappers sur l'API JSON-RPC. Avec ces bibliothèques, les développeurs peuvent écrire de manières intuitives des méthodes d'une seule ligne pour initialiser les requêtes JSON-RPC (sans avoir besoin d'en voir les détails) qui interagissent avec Ethereum.

API client de consensus

Cette page traite principalement de l'API JSON-RPC utilisée par les clients d'exécution Ethereum. Cependant, les clients de consensus ont également une API RPC qui permet aux utilisateurs de interroger des informations sur le nœud, demander des blocs de balises, l'état de la balise et d'autres informations liées au consensus directement depuis un nœud. Cette API est documentée sur la page Web de l'API de la chaîne phare(opens in a new tab).

Une API interne est également utilisée pour la communication entre les clients dans un noeud - c'est-à-dire permet au client de consensus et au client d'exécution d'échanger des données. Cela s'appelle une « API moteur » et les spécifications sont disponibles sur GitHub(opens in a new tab).

Spécifications de client d'exécution

Lisez la spécification complète de l'API JSON-RPC sur GitHub(opens in a new tab).

Conventions

Encodage hexadécimal

Deux types de données clés sont passés par JSON : des tableaux d'octets non formatés et des quantités. Les deux sont passés avec un encodage hexadécimal mais avec des formatages différents.

Quantités

Lors de l'encodage des quantités (entiers, chiffres) : encoder en hexadécimal, préfixer avec « 0x », la représentation la plus compacte (légère exception : zéro doit être représenté par « 0x0 »).

Voici quelques exemples :

0x41 (65 en décimal)
0x400 (1024 en décimal)
FAUX : 0x (devrait toujours avoir au moins un chiffre - zéro est « 0x0 »)
FAUX : 0x0400 (pas de zéros autorisés en premier)
FAUX : ff (doit être préfixé par 0x)

Données non formatées

Lors de l'encodage de données non formatées (tableaux d'octets, adresses de compte, hachages, tableaux de bytecode) : encoder en hex, préfixer avec « 0x », deux chiffres hexadécimaux par octet.

Voici quelques exemples :

0x41 (taille 1, « A »)
0x004200 (taille 3, « \0B\0 »)
0x (taille 0, "")
FAUX : 0xf0f0f (doit avoir un nombre pair de chiffres)
FAUX : 004200 (doit être préfixé par 0x)

Le paramètre de bloc par défaut

Les méthodes suivantes ont un paramètre de bloc par défaut supplémentaire :

eth_getBalance
eth_getCode
eth_getTransactionCount
eth_getStorageAt
eth_call

Lorsque des requêtes qui agissent sur l'état d'Ethereum sont exécutées, le dernier paramètre de bloc par défaut détermine la hauteur du bloc.

Les options suivantes sont possibles pour le paramètre defaultBlock :

chaîne HEX - un nombre de bloc entier
Chaîne « earliest » pour le bloc d'origine/le plus ancien
Chaine « latest » - pour le dernier bloc miné
Chaine « latest » - pour le dernier bloc de tête sûr
Chaîne « finalized » - pour le dernier bloc finalisé
Chaîne "pending" - pour l'état ou les transactions en attente

Exemples

Sur cette page, nous fournissons des exemples d'utilisation des points de terminaison individuels de l'API JSON_RPC à l'aide de l'outil de ligne de commande, curl(opens in a new tab). Ces exemples de points de terminaison individuels se trouvent ci-dessous dans la section Exemples Curl. Plus bas sur la page, nous fournissons également un exemple de bout en bout pour compiler et déployer un contrat intelligent à l'aide d'un nœud Geth, de l'API JSON_RPC et de curl.

Exemples de Curl

Des exemples d'utilisation de l'API JSON_RPC en effectuant des requêtes curl(opens in a new tab) vers un nœud Ethereum sont fournis ci-dessous. Chaque exemple comprend une description du point de terminaison spécifique, de ses paramètres, du type de retour et un exemple concret de son utilisation.

Les requêtes curl peuvent retourner un message d'erreur relatif au type de contenu. Ceci est dû au fait que l'option --data définit le type de contenu à application/x-www-form-urlencoded. Si votre nœud se plaint à ce sujet, définissez manuellement l'en-tête en plaçant -H "Content-Type: application/json" au début de l'appel. Les exemples ne comprennent pas non plus la combinaison URL/IP & port qui doit être le dernier argument donné à curl ( par exemple : 127.0.0.1:8545). Une requête curl complète incluant ces données supplémentaires prend la forme suivante :

1curl -H "Content-Type: application/json" -X POST --data '{"jsonrpc":"2.0","method":"web3_clientVersion","params":[],"id":67}' 127.0.0.1:8545

Gossip, État, Historique

Une poignée de méthodes JSON-RPC de base nécessitent des données du réseau Ethereum, et se classent aisément dans 3 catégories principales : Gossip, État, Historique. Utilisez les liens dans ces sections pour passer à chaque méthode, ou utilisez la table des matières pour explorer la liste complète des méthodes.

Méthodes Gossip

Ces méthodes permettent de suivre la tête de la chaîne. C'est ainsi que les transactions font leur chemin à travers le réseau, qu'elles se retrouvent dans des blocs et que les clients découvrent les nouveaux blocs.

eth_blockNumber
eth_sendRawTransaction

Méthodes d'état

Méthodes qui rapportent l'état actuel de toutes les données stockées. L' « état » est comme un grand morceau partagé de RAM, et comprend les soldes des comptes, les données des contrats et les estimations de gaz.

eth_getBalance
eth_getStorageAt
eth_getTransactionCount
eth_getCode
eth_call
eth_estimateGas

Méthodes d'historique

Récupère les enregistrements historiques de chaque bloc depuis la genèse. Il s'agit d'un grand fichier à usage unique, qui comprend l'ensemble des en-têtes de bloc, des corps de blocs, des blocs d'oncle et les reçus de transaction.

eth_getBlockTransactionCountByHash
eth_getBlockTransactionCountByNumber
eth_getUncleCountByBlockHash
eth_getUncleCountByBlockNumber
eth_getBlockByHash
eth_getBlockByNumber
eth_getTransactionByHash
eth_getTransactionByBlockHashAndIndex
eth_getTransactionByBlockNumberAndIndex
eth_getTransactionReceipt
eth_getUncleByBlockHashAndIndex
eth_getUncleByBlockNumberAndIndex

Méthodes API JSON-RPC

web3_clientVersion

Retourne la version courante du client.

Paramètres

Aucun

Valeur de retour

String - La version actuelle du client

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"web3_clientVersion","params":[],"id":67}'
3// Result
4{
5  "id":67,
6  "jsonrpc":"2.0",
7  "result": "Geth/v1.12.1-stable/linux-amd64/go1.19.1"
8}
 Copier

web3_sha3

Retourne le Keccak-256 (non pas le SHA3-256 standard) des données.

Paramètres

DATA - les données à convertir en hachage SHA3

1params: ["0x68656c6c6f20776f726c64"]
 Copier

Valeur de retour

DATA - Le résultat SHA3 pour la chaîne donnée.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"web3_sha3","params":["0x68656c6c6f20776f726c64"],"id":64}'
3// Result
4{
5  "id":64,
6  "jsonrpc": "2.0",
7  "result": "0x47173285a8d7341e5e972fc677286384f802f8ef42a5ec5f03bbfa254cb01fad"
8}
 Copier

net_version

Retourne l'identifiant du réseau actuel.

Paramètres

Aucune

Retours

String - L'id actuelle du réseau.

La liste complète des identifiants de réseau actuels est disponible à l'adresse suivante : chainlist.org(opens in a new tab). Quelques spécifications habituelles sont :

1: réseau principal Ethereum
5: Réseau de test Goerli
11155111: Réseau de test Sepolia

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"net_version","params":[],"id":67}'
3// Result
4{
5  "id":67,
6  "jsonrpc": "2.0",
7  "result": "3"
8}
 Copier

net_listening

Retourne true si le client écoute activement les connexions réseau.

Paramètres

Aucune

Retours

Boolean - true lors de l'écoute, sinon false.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"net_listening","params":[],"id":67}'
3// Result
4{
5  "id":67,
6  "jsonrpc":"2.0",
7  "result":true
8}
 Copier

net_peerCount

Retourne le nombre de pairs actuellement connectés au client.

Paramètres

Aucune

Retours

QUANTITY - nombre entier du nombre de pairs connectés.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"net_peerCount","params":[],"id":74}'
3// Result
4{
5  "id":74,
6  "jsonrpc": "2.0",
7  "result": "0x2" // 2
8}
 Copier

eth_protocolVersion

Retourne la version actuelle du protocole Ethereum. Notez que cette méthode n'est pas disponible dans Geth(opens in a new tab).

Paramètres

Aucune

Retours

String - La version actuelle du protocole Ethereum

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_protocolVersion","params":[],"id":67}'
3// Result
4{
5  "id":67,
6  "jsonrpc": "2.0",
7  "result": "54"
8}
 Copier

eth_syncing

Renvoie un objet contenant des données sur l'état de la synchronisation ou false.

Paramètres

Aucune

Retours

Les données précises renvoyées varient entre les différentes implémentations de clients. Tous les clients renvoient False lorsque le nœud n'est pas en synchronisation, et tous les clients renvoient les champs suivants.

Objet|Booléen, un objet avec des données sur l'état de la synchronisation ou FALSE, s'il n'y a pas de synchronisation :

startingBlock: QUANTITY - Le bloc où l'importation a commencé (ne sera remis à zéro que lorsque la synchronisation aura atteint sa tête)
currentBlock: QUANTITY - Le bloc actuel, identique à eth_blockNumber
highestBlock: QUANTITY - Le bloc estimé le plus élevé

Cependant, chaque client peut également fournir des données supplémentaires. Par exemple, Geth renvoie les informations suivantes :

1{
2  "jsonrpc": "2.0",
3  "id": 1,
4  "result": {
5    "currentBlock": "0x3cf522",
6    "healedBytecodeBytes": "0x0",
7    "healedBytecodes": "0x0",
8    "healedTrienodes": "0x0",
9    "healingBytecode": "0x0",
10    "healingTrienodes": "0x0",
11    "highestBlock": "0x3e0e41",
12    "startingBlock": "0x3cbed5",
13    "syncedAccountBytes": "0x0",
14    "syncedAccounts": "0x0",
15    "syncedBytecodeBytes": "0x0",
16    "syncedBytecodes": "0x0",
17    "syncedStorage": "0x0",
18    "syncedStorageBytes": "0x0"
19  }
20}
Afficher tout
 Copier

Alors que Besu renvoie :

1{
2  "jsonrpc": "2.0",
3  "id": 51,
4  "result": {
5    "startingBlock": "0x0",
6    "currentBlock": "0x1518",
7    "highestBlock": "0x9567a3",
8    "pulledStates": "0x203ca",
9    "knownStates": "0x200636"
10  }
11}
Afficher tout
 Copier

Reportez-vous à la documentation de votre client spécifique pour plus de détails.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": {
8    startingBlock: '0x384',
9    currentBlock: '0x386',
10    highestBlock: '0x454'
11  }
12}
13// Or when not syncing
14{
15  "id":1,
16  "jsonrpc": "2.0",
17  "result": false
18}
Afficher tout
 Copier

eth_coinbase

Renvoie l'adresse coinbase du client.

Paramètres

Aucune

Valeur de retour

DATA, 20 octets - l'adresse actuelle de coinbase.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_coinbase","params":[],"id":64}'
3// Result
4{
5  "id":64,
6  "jsonrpc": "2.0",
7  "result": "0x407d73d8a49eeb85d32cf465507dd71d507100c1"
8}
 Copier

eth_chainId

Retourne la chaîne ID utilisée pour la signature d'opérations protégées par la rediffusion.

Paramètres

Aucune

Valeur de retour

chainId, valeur hexadécimale comme une chaîne représentant le nombre entier de l'id de la chaîne courante.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_chainId","params":[],"id":67}'
3// Result
4{
5  "id":67,
6  "jsonrpc": "2.0",
7  "result": "0x1"
8}
 Copier

eth_mining

Retourne true si le client est en train de miner activement de nouveaux blocs. Cela ne peut renvoyer que vrai pour les réseaux en preuve de travail et peut ne pas être disponible dans certains clients depuis La Fusion.

Paramètres

Aucune

Valeur de retour

Boolean - renvoie true du client en train de miner, sinon false.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_mining","params":[],"id":71}'
3//
4{
5  "id":71,
6  "jsonrpc": "2.0",
7  "result": true
8}
 Copier

eth_hashrate

Retourne le nombre de hachages par seconde avec lesquels le nœud est miné. Cela ne peut renvoyer que vrai pour les réseaux en preuve de travail et peut ne pas être disponible dans certains clients depuis La Fusion.

Paramètres

Aucune

Valeur de retour

QUANTITY - nombre de hachages par seconde.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_hashrate","params":[],"id":71}'
3// Result
4{
5  "id":71,
6  "jsonrpc": "2.0",
7  "result": "0x38a"
8}
 Copier

eth_gasPrice

Retourne une estimation du prix actuel de gaz en wei. Par exemple, le client Besu examine les 100 derniers blocs et renvoie le prix médian du gaz en unité par défaut.

Paramètres

Aucune

Valeur de retour

QUANTITY - entier du prix actuel du gaz en wei.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_gasPrice","params":[],"id":73}'
3// Result
4{
5  "id":73,
6  "jsonrpc": "2.0",
7  "result": "0x1dfd14000" // 8049999872 Wei
8}
 Copier

eth_accounts

Renvoie une liste d'adresses appartenant au client.

Paramètres

Aucune

Valeur de retour

Array of DATA, 20 octets - adresses appartenant au client.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_accounts","params":[],"id":1}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": ["0x407d73d8a49eeb85d32cf465507dd71d507100c1"]
8}
 Copier

eth_blockNumber

Renvoie le numéro du bloc le plus récent.

Paramètres

Aucune

Valeur de retour

QUANTITY - nombre entier du numéro de bloc actuel sur lequel se trouve le client.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":83}'
3// Result
4{
5  "id":83,
6  "jsonrpc": "2.0",
7  "result": "0x4b7" // 1207
8}
 Copier

eth_getBalance

Renvoie le solde du compte de l'adresse donnée.

Paramètres

DATA, 20 octets - adresse pour vérifier le solde.
QUANTITY|TAG - numéro de bloc entier, ou la chaîne « latest », « earliest » ou « pending », voir le paramètre de bloc par défaut

1params: ["0x407d73d8a49eeb85d32cf465507dd71d507100c1", "latest"]
 Copier

Valeur de retour

QUANTITY - nombre entier du solde actuel en wei.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBalance","params":["0x407d73d8a49eeb85d32cf465507dd71d507100c1", "latest"],"id":1}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": "0x0234c8a3397aab58" // 158972490234375000
8}
 Copier

eth_getStorageAt

Renvoie la valeur d'une position de stockage à une adresse donnée.

Paramètres

DATA, 20 octets - adresse du stockage.
QUANTITY - nombre entier de la position dans le stockage.
QUANTITY|TAG - numéro de bloc entier, ou la chaîne « latest », « earliest » ou « pending », voir le paramètre de bloc par défaut

Valeur de retour

DATA - la valeur à cette position de stockage.

Exemple Le calcul de la position correcte dépend du stockage à récupérer. Considérons le contrat suivant déployé à 0x295a70b2de5e3953354a6a8344e616ed314d7251 par l'adresse 0x391694e7e0b0cce554cb130d723a9d27458f9298.

1contract Storage {
2    uint pos0;
3    mapping(address => uint) pos1;
4    function Storage() {
5        pos0 = 1234;
6        pos1[msg.sender] = 5678;
7    }
8}

La récupération de la valeur pos0 est simple :

1curl -X POST --data '{"jsonrpc":"2.0", "method": "eth_getStorageAt", "params": ["0x295a70b2de5e3953354a6a8344e616ed314d7251", "0x0", "latest"], "id": 1}' localhost:8545
2{"jsonrpc":"2.0","id":1,"result":"0x00000000000000000000000000000000000000000000000000000000000004d2"}
 Copier

La récupération d'un élément de la carte est plus difficile. La position d'un élément dans la carte est calculée avec :

1keccak(LeftPad32(key, 0), LeftPad32(map position, 0))
 Copier

Cela signifie que pour récupérer le stockage sur pos1["0x391694e7e0b0cce554cb130d723a9d27458f9298"] nous devons calculer la position avec :

1keccak(
2  decodeHex(
3    "000000000000000000000000391694e7e0b0cce554cb130d723a9d27458f9298" +
4      "0000000000000000000000000000000000000000000000000000000000000001"
5  )
6)
 Copier

La console geth qui est fournie avec la bibliothèque web3 peut être utilisée pour effectuer le calcul :

1> var key = "000000000000000000000000391694e7e0b0cce554cb130d723a9d27458f9298" + "0000000000000000000000000000000000000000000000000000000000000001"
2undefined
3> web3.sha3(key, {"encoding": "hex"})
4"0x6661e9d6d8b923d5bbaab1b96e1dd51ff6ea2a93520fdc9eb75d059238b8c5e9"
 Copier

Maintenant, il faut aller chercher le stockage :

1curl -X POST --data '{"jsonrpc":"2.0", "method": "eth_getStorageAt", "params": ["0x295a70b2de5e3953354a6a8344e616ed314d7251", "0x6661e9d6d8b923d5bbaab1b96e1dd51ff6ea2a93520fdc9eb75d059238b8c5e9", "latest"], "id": 1}' localhost:8545
2{"jsonrpc":"2.0","id":1,"result":"0x000000000000000000000000000000000000000000000000000000000000162e"}
 Copier

eth_getTransactionCount

Renvoie le nombre de transactions envoyées à partir d'une adresse.

Paramètres

DATA, 20 octets - adresse.
QUANTITY|TAG - numéro de bloc entier, ou la chaîne « latest », « earliest » ou « pending », voir le paramètre de bloc par défaut

1params: [
2  "0x407d73d8a49eeb85d32cf465507dd71d507100c1",
3  "latest", // state at the latest block
4]
 Copier

Valeur de retour

QUANTITY - nombre entier du nombre de transactions envoyées depuis cette adresse.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionCount","params":["0x407d73d8a49eeb85d32cf465507dd71d507100c1","latest"],"id":1}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": "0x1" // 1
8}
 Copier

eth_getBlockTransactionCountByHash

Renvoie le nombre de transactions dans un bloc à partir d'un bloc correspondant au hachage de bloc donné.

Paramètres

DATA, 32 octets - hachage d'un bloc

1params: ["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"]
 Copier

Valeur de retour

QUANTITY - nombre entier du nombre de transactions dans ce bloc.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByHash","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id":1}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": "0xb" // 11
8}
 Copier

eth_getBlockTransactionCountByNumber

Renvoie le nombre de transactions dans un bloc correspondant au numéro de bloc donné.

Paramètres

QUANTITY|TAG - numéro de bloc entier, ou la chaîne « earliest », « latest » ou « pending », voir le paramètre de bloc par défaut.

1params: [
2  "0xe8", // 232
3]
 Copier

Valeur de retour

QUANTITY - nombre entier du nombre de transactions dans ce bloc.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockTransactionCountByNumber","params":["0xe8"],"id":1}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": "0xa" // 10
8}
 Copier

eth_getUncleCountByBlockHash

Renvoie le nombre d'oncles dans un bloc à partir d'un bloc correspondant au hachage de bloc donné.

Paramètres

DATA, 32 octets - hachage d'un bloc

1params: ["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"]
 Copier

Valeur de retour

QUANTITY - nombre entier du nombre d'oncles dans ce bloc.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleCountByBlockHash","params":["0xb903239f8543d04b5dc1ba6579132b143087c68db1b2168786408fcbce568238"],"id":1}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": "0x1" // 1
8}
 Copier

eth_getUncleCountByBlockNumber

Renvoie le nombre d'oncles dans un bloc à partir d'un bloc correspondant au numéro de bloc donné.

Paramètres

QUANTITY|TAG - nombre entier d'un bloc, ou la chaîne « latest », « earliest » ou « pending », voir le paramètre de bloc par défaut

1params: [
2  "0xe8", // 232
3]
 Copier

Valeur de retour

QUANTITY - nombre entier du nombre d'oncles dans ce bloc.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleCountByBlockNumber","params":["0xe8"],"id":1}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": "0x1" // 1
8}
 Copier

eth_getCode

Renvoie le code à une adresse donnée.

Paramètres

DATA, 20 octets - adresse
QUANTITY|TAG - numéro de bloc entier, ou la chaîne « latest », « earliest » ou « pending », voir le paramètre de bloc par défaut

1params: [
2  "0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b",
3  "0x2", // 2
4]
 Copier

Valeur de retour

DATA - le code issu de l'adresse donnée.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getCode","params":["0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b", "0x2"],"id":1}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": "0x600160008035811a818181146012578301005b601b6001356025565b8060005260206000f25b600060078202905091905056"
8}
 Copier

eth_sign

La méthode du signe calcule une signature spécifique à Ethereum avec : sign(keccak256("\x19Message signé Ethereum :\n" + len(message) + message))).

En ajoutant un préfixe au message, la signature calculée peut être reconnue comme une signature spécifique à Ethereum. Cela empêche l'utilisation abusive où une DApp malveillante peut signer des données arbitraires (par exemple une transaction) et utiliser la signature pour usurper l'identité de la victime.

Remarque : l'adresse avec laquelle signer doit être déverrouillée.

Paramètres

DATA, 20 octets - adresse
DATA, N octets - message à signer

Valeur de retour

DATA : Signature

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_sign","params":["0x9b2055d370f73ec7d8a03e965129118dc8f5bf83", "0xdeadbeaf"],"id":1}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": "0xa3f20717a250c2b0b729b7e5becbff67fdaef7e0699da4de7ca5895b02a170a12d887fd3b17bfdce3481f10bea41f45ba9f709d39ce8325427b57afcfc994cee1b"
8}
 Copier

eth_signTransaction

Signale une transaction qui peut être soumise au réseau plus tard en utilisant eth_sendRawTransaction.

Paramètres

Object - L'objet de la transaction

type:
from: DATA, 20 octets - L'adresse à partir de laquelle la transaction est envoyée.
to: DATA, 20 octets - (optionnel lors de la création d'un nouveau contrat) L'adresse vers laquelle la transaction est orientée.
gaz : QUANTITY - (facultatif, par défaut : 90 000) Nombre entier du gaz fourni pour l'exécution de la transaction. Il retournera du gaz inutilisé.
gasPrice : QUANTITY - (facultatif, par défaut : To-Be-Determined) Nombre entier du prix du gaz utilisé pour chaque gaz payé, à Wei.
value: QUANTITY - (facultatif) Nombre entier de la valeur envoyée avec cette transaction, dans Wei.
data : DATA - Le code compilé d'un contrat OU le hachage de la signature de la méthode invoquée et des paramètres encodés.
nonce : QUANTITY - (facultatif) Entier d'un nonce. Cela permet d'écraser vos propres transactions en attente qui utilisent le même nonce.

Valeur de retour

DATA, L'objet de transaction encodé en RLP signé par le compte spécifié.

Exemple

1// Request
2curl -X POST --data '{"id": 1,"jsonrpc": "2.0","method": "eth_signTransaction","params": [{"data":"0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675","from": "0xb60e8dd61c5d32be8058bb8eb970870f07233155","gas": "0x76c0","gasPrice": "0x9184e72a000","to": "0xd46e8dd67c5d32be8058bb8eb970870f07244567","value": "0x9184e72a"}]}'
3// Result
4{
5    "id": 1,
6    "jsonrpc": "2.0",
7    "result": "0xa3f20717a250c2b0b729b7e5becbff67fdaef7e0699da4de7ca5895b02a170a12d887fd3b17bfdce3481f10bea41f45ba9f709d39ce8325427b57afcfc994cee1b"
8}
 Copier

eth_sendTransaction

Crée une nouvelle transaction d'appel ou une création de contrat, si le champ de données contient du code, et la signe en utilisant le compte spécifié dans from.

Paramètres

Object - L'objet de la transaction

from: DATA, 20 octets - L'adresse à partir de laquelle la transaction est envoyée.
to: DATA, 20 octets - (optionnel lors de la création d'un nouveau contrat) L'adresse vers laquelle la transaction est orientée.
gaz : QUANTITY - (facultatif, par défaut : 90 000) Nombre entier du gaz fourni pour l'exécution de la transaction. Il retournera du gaz inutilisé.
gasPrice : QUANTITY - (facultatif, par défaut : To-Be-Determined) Nombre entier du prix du gaz utilisé pour chaque gaz payé.
value : QUANTITY - (facultatif) Nombre entier de la valeur envoyée avec cette transaction.
data : DATA - Le code compilé d'un contrat OU le hachage de la signature de la méthode invoquée et des paramètres encodés.
nonce : QUANTITY - (facultatif) Entier d'un nonce. Cela permet d'écraser vos propres transactions en attente qui utilisent le même nonce.

1params: [
2  {
3    from: "0xb60e8dd61c5d32be8058bb8eb970870f07233155",
4    to: "0xd46e8dd67c5d32be8058bb8eb970870f07244567",
5    gas: "0x76c0", // 30400
6    gasPrice: "0x9184e72a000", // 10000000000000
7    value: "0x9184e72a", // 2441406250
8    data: "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675",
9  },
10]
Afficher tout
 Copier

Valeur de retour

DATA, 32 octets - le hachage de la transaction, ou le hachage zéro si la transaction n'est pas encore disponible.

Utilisez eth_getTransactionReceipt pour obtenir l'adresse du contrat, après que la transaction a été minée, lorsque vous avez créé un contrat.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_sendTransaction","params":[{see above}],"id":1}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331"
8}
 Copier

eth_sendRawTransaction

Crée une nouvelle transaction d'appel de message ou une création de contrat pour les transactions signées.

Paramètres

DATA, Les données de transaction signées.

1params: [
2  "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675",
3]
 Copier

Valeur de retour

DATA, 32 octets - le hachage de la transaction, ou le hachage zéro si la transaction n'est pas encore disponible.

Utilisez eth_getTransactionReceipt pour obtenir l'adresse du contrat, après que la transaction a été minée, lorsque vous avez créé un contrat.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_sendRawTransaction","params":[{see above}],"id":1}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331"
8}
 Copier

eth_call

Exécute un nouvel appel de message immédiatement sans créer de transaction sur la chaîne de blocs. Souvent utilisé pour exécuter des fonctions de contrat intelligent en lecture seule, par exemple le balanceOf pour un contrat ERC-20.

Paramètres

Object - L'objet d'appel de transaction

from : DATA, 20 octets - (optionnel) - L'adresse à partir de laquelle la transaction est envoyée.
to : DATA, 20 octets - L'adresse à laquelle la transaction est orientée.
gaz: QUANTITY - (facultatif) Nombre entier du gaz fourni pour l'exécution de la transaction. eth_call consomme zéro gaz, mais ce paramètre peut être nécessaire pour certaines exécutions.
gasPrice : QUANTITY - (facultatif) Nombre entier du prix du gaz utilisé pour chaque gaz payé
value : QUANTITY - (facultatif) Nombre entier de la valeur envoyée avec cette transaction
input : DATA - Hachage (facultatif) de la signature de la méthode et des paramètres encodés. Pour plus de détails, voir le contrat Ethereum ABI dans la documentation de Solidity(opens in a new tab).

QUANTITY|TAG - numéro de bloc entier, ou la chaîne « latest », « earliest » ou « pending », voir le paramètre de bloc par défaut

Valeur de retour

DATA - la valeur de retour du contrat exécuté.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_call","params":[{see above}],"id":1}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": "0x"
8}
 Copier

eth_estimateGas

Génère et retourne une estimation de la quantité de gaz nécessaire à la réalisation de la transaction. La transaction ne sera pas ajoutée à la blockchain. Notez que l'estimation peut être beaucoup plus grande que la quantité de gaz réellement utilisée par la transaction, pour diverses raisons, y compris la mécanique EVM et la performance des nœuds.

Paramètres

Voir les paramètres de eth_call , hormis le fait que toutes les propriétés sont facultatives. Si aucune limite de gaz n'est spécifiée, geth utilise la limite de gaz du bloc en attente comme une limite supérieure. En conséquence, l'estimation retournée pourrait ne pas suffire à exécuter l'appel/la transaction lorsque la quantité de gaz est supérieure à la limite de gaz bloc en attente.

Valeur de retour

QUANTITY - la quantité de gaz utilisée.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_estimateGas","params":[{see above}],"id":1}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": "0x5208" // 21000
8}
 Copier

eth_getBlockByHash

Retourne des informations à propos d'un bloc par hachage.

Paramètres

DATA, 32 octets - Hachage d'un bloc.
Boolean - Si true il retourne les objets de transaction complets, si false seulement les hachages des transactions.

1params: [
2  "0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae",
3  false,
4]
 Copier

Valeur de retour

Object - Un objet bloc, ou null quand aucun bloc n'a été trouvé :

number : QUANTITY - le numéro du bloc. null quand son bloc est en attente.
hash : DATA, 32 octets - hachage du bloc. null quand son bloc est en attente.
parentHash : DATA, 32 octets - hachage du bloc parent.
nonce : DATA, 8 octets - hachage de la preuve de travail générée. null quand son bloc est en attente.
sha3Uncles : DATA, 32 octets - SHA3 des oncles données dans le bloc.
logsBloom : DATA, 256 octets - le filtre bloom pour les logs du bloc. null quand son bloc est en attente.
transactionsRoot : DATA, 32 octets - la racine de la tentative de transaction du bloc.
stateRoot : DATA, 32 octets - la racine de l'état final du bloc.
receiptsRoot : DATA, 32 octets - la racine de la tentative de réception du bloc.
miner : DATA, 20 octets - l'adresse du bénéficiaire auquel les récompenses minières ont été données.
difficulty : QUANTITY - entier de la difficulté pour ce bloc.
totalDifficulty : QUANTITY - entier de la difficulté globale de la chaîne jusqu'à ce bloc.
extraData : DATA - le champ « données supplémentaires » de ce bloc.
size : QUANTITY - entier de la taille de ce bloc en octets.
gasLimit : QUANTITY - le gaz maximum autorisé dans ce bloc.
gasUsed: QUANTITY - le total utilisé par toutes les transactions de ce bloc.
timestamp: QUANTITY - l'horodatage unix pour le moment où le bloc a été assemblé.
transactions: Array - Tableau d'objets de transaction, ou hachage de transaction 32 octets dépendant du dernier paramètre donné.
uncles: Array - Tableau de hachages d'oncle.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockByHash","params":["0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae", false],"id":1}'
3// Result
4{
5{
6"jsonrpc": "2.0",
7"id": 1,
8"result": {
9    "difficulty": "0x4ea3f27bc",
10    "extraData": "0x476574682f4c5649562f76312e302e302f6c696e75782f676f312e342e32",
11    "gasLimit": "0x1388",
12    "gasUsed": "0x0",
13    "hash": "0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae",
14    "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
15    "miner": "0xbb7b8287f3f0a933474a79eae42cbca977791171",
16    "mixHash": "0x4fffe9ae21f1c9e15207b1f472d5bbdd68c9595d461666602f2be20daf5e7843",
17    "nonce": "0x689056015818adbe",
18    "number": "0x1b4",
19    "parentHash": "0xe99e022112df268087ea7eafaf4790497fd21dbeeb6bd7a1721df161a6657a54",
20    "receiptsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
21    "sha3Uncles": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
22    "size": "0x220",
23    "stateRoot": "0xddc8b0234c2e0cad087c8b389aa7ef01f7d79b2570bccb77ce48648aa61c904d",
24    "timestamp": "0x55ba467c",
25    "totalDifficulty": "0x78ed983323d",
26    "transactions": [
27    ],
28    "transactionsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
29    "uncles": [
30    ]
31}
32}
Afficher tout
 Copier

eth_getBlockByNumber

Renvoie des informations sur un bloc par numéro de bloc.

Paramètres

QUANTITY|TAG - numéro de bloc entier, ou la chaîne « earliest », « latest » ou « pending », voir le paramètre de bloc par défaut.
Boolean - Si true il retourne les objets de transaction complètes, si false seulement les hachages des transactions.

1params: [
2  "0x1b4", // 436
3  true,
4]
 Copier

Retourne Voir eth_getBlockByHash

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["0x1b4", true],"id":1}'
 Copier

Résultat voir eth_getBlockByHash

eth_getTransactionByHash

Retourne les informations sur une transaction demandée par le hachage de la transaction.

Paramètres

DATA, 32 octets - hachage d'une transaction

1params: ["0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b"]
 Copier

Valeur de retour

Object - Un objet de transaction, ou null quand aucune transaction n'a été trouvée :

blockHash: DATA, 32 octets - hachage du bloc dans lequel se trouvait cette transaction. null lors de son attente.
blockNumber: QUANTITY - numéro de bloc où se trouvait cette transaction. null lors de son attente.
from: DATA, 20 octets - adresse de l'expéditeur.
gas: QUANTITY - gaz fourni par l'expéditeur.
gasPrice: QUANTITY - prix du gaz fourni par l'expéditeur en Wei.
hash: DATA, 32 octets - hachage de la transaction.
input: DATA - les données envoyées avec la transaction.
nonce: QUANTITY - le nombre de transactions effectuées par l'expéditeur avant celle-ci.
to: DATA, 20 octets - adresse du destinataire. null lors d'une transaction de création de contrat.
transactionIndex: QUANTITY - nombre entier de la position de l'indice des transactions dans le bloc. null lors de son attente.
valeur: QUANTITY - valeur transférée dans Wei.
v: QUANTITY - Identifiant de récupération ECDSA
r: QUANTITY - Signature ECDSA r
s: QUANTITY - Signature ECDSA s

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionByHash","params":["0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b"],"id":1}'
3// Result
4{
5  "jsonrpc":"2.0",
6  "id":1,
7  "result":{
8    "blockHash":"0x1d59ff54b1eb26b013ce3cb5fc9dab3705b415a67127a003c3e61eb445bb8df2",
9    "blockNumber":"0x5daf3b", // 6139707
10    "from":"0xa7d9ddbe1f17865597fbd27ec712455208b6b76d",
11    "gas":"0xc350", // 50000
12    "gasPrice":"0x4a817c800", // 20000000000
13    "hash":"0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b",
14    "input":"0x68656c6c6f21",
15    "nonce":"0x15", // 21
16    "to":"0xf02c1c8e6114b1dbe8937a39260b5b0a374432bb",
17    "transactionIndex":"0x41", // 65
18    "value":"0xf3dbb76162000", // 4290000000000000
19    "v":"0x25", // 37
20    "r":"0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea",
21    "s":"0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c"
22  }
23}
Afficher tout
 Copier

eth_getTransactionByBlockHashAndIndex

Retourne des informations sur une transaction par hachage de bloc et la position de l'indice de transaction.

Paramètres

DATA, 32 octets - hachage d'un bloc.
QUANTITY - nombre entier de la position de l'indice de transaction.

1params: [
2  "0xe670ec64341771606e55d6b4ca35a1a6b75ee3d5145a99d05921026d1527331",
3  "0x0", // 0
4]
 Copier

Retourne Voir eth_getTransactionByHash

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionByBlockHashAndIndex","params":["0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b", "0x0"],"id":1}'
 Copier

Résultat voir eth_getTransactionByHash

eth_getTransactionByBlockNumberAndIndex

Retourne des informations sur une transaction par numéro de bloc et la position de l'indice de transaction.

Paramètres

QUANTITY|TAG - numéro de bloc, ou la chaîne « earliest » ,« latest », ou « pending », voir le paramètre de bloc par défaut.
QUANTITY - position de l'indice de transaction.

1params: [
2  "0x9c47cf", // 10241999
3  "0x24", // 36
4]
 Copier

Retourne Voir eth_getTransactionByHash

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionByBlockNumberAndIndex","params":["0x9c47cf", "0x24"],"id":1}'
 Copier

Résultat voir eth_getTransactionByHash

eth_getTransactionReceipt

Retourne la réception d'une transaction par hachage de la transaction.

Remarque que le reçu n'est pas disponible pour les transactions en attente.

Paramètres

DATA, 32 octets - hachage d'une transaction

1params: ["0x85d995eba9763907fdf35cd2034144dd9d53ce32cbec21349d4b12823c6860c5"]
 Copier

Renvoie Object - Un objet de réception de transaction, ou null quand aucun reçu n'a été trouvé :

transactionHash: DATA, 32 octets - hachage de la transaction.
transactionIndex: QUANTITY - nombre entier de la position de l'indice des transactions dans le bloc.
blockHash: DATA, 32 octets - hachage du bloc dans lequel se trouvait cette transaction.
blockNumber: QUANTITY - numéro de bloc où se trouvait cette transaction.
from: DATA, 20 octets - adresse de l'expéditeur.
to: DATA, 20 octets - adresse du destinataire. null lors d'une transaction de création de contrat.
cumulativeGasUsed : QUANTITY - Le montant total de gaz utilisé lorsque cette transaction a été exécutée dans le bloc.
effectiveGasPrice : QUANTITY - La somme des frais de base et du pourboire payés par unité de gaz.
gasUsed: QUANTITY - La quantité de gaz utilisée par cette transaction spécifique seule.
contractAddress: DATA, 20 octets - L'adresse du contrat a été créée, si la transaction était une création de contrat, sinon null.
logs: Tableau - Tableau d'objets de log, que cette transaction a générés.
logsBloom: DATA, 256 octets - Filtre Bloom pour les clients légers pour récupérer rapidement les logs associés.
type: QUANTITY - nombre entier du type de transaction, 0x00 pour les transactions héritées, 0x01 pour les types de listes d'accès, 0x02 pour les frais dynamiques.

Il renvoie aussi soit :

root : DATA 32 octets de stateroot post-transaction (avant Byzantium)
status: QUANTITY soit 1 (succès) ou 0 (échec)

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getTransactionReceipt","params":["0x85d995eba9763907fdf35cd2034144dd9d53ce32cbec21349d4b12823c6860c5"],"id":1}'
3// Result
4{
5  "jsonrpc": "2.0",
6  "id": 1,
7  "result": {
8    "blockHash":
9      "0xa957d47df264a31badc3ae823e10ac1d444b098d9b73d204c40426e57f47e8c3",
10    "blockNumber": "0xeff35f",
11    "contractAddress": null, // string of the address if it was created
12    "cumulativeGasUsed": "0xa12515",
13    "effectiveGasPrice": "0x5a9c688d4",
14    "from": "0x6221a9c005f6e47eb398fd867784cacfdcfff4e7",
15    "gasUsed": "0xb4c8",
16    "logs": [{
17      // logs as returned by getFilterLogs, etc.
18    }],
19    "logsBloom": "0x00...0", // 256 byte bloom filter
20    "status": "0x1",
21    "to": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
22    "transactionHash":
23      "0x85d995eba9763907fdf35cd2034144dd9d53ce32cbec21349d4b12823c6860c5",
24    "transactionIndex": "0x66",
25    "type": "0x2"
26  }
27}
Afficher tout
 Copier

eth_getUncleByBlockHashAndIndex

Retourne des informations à propos d'un oncle d'un bloc par hachage et position de l'indice.

Paramètres

DATA, 32 octets - Le hachage d'un bloc.
QUANTITY - La position de l'oncle dans l'indice.

1params: [
2  "0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b",
3  "0x0", // 0
4]
 Copier

Retourne Voir eth_getBlockByHash

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleByBlockHashAndIndex","params":["0xc6ef2fc5426d6ad6fd9e2a26abeab0aa2411b7ab17f30a99d3cb96aed1d1055b", "0x0"],"id":1}'
 Copier

Résultat voir eth_getBlockByHash

Remarque : Un oncle ne contient pas de transactions individuelles.

eth_getUncleByBlockNumberAndIndex

Renvoie des informations à propos d'un oncle d'un bloc par nombre et par position de l'indice.

Paramètres

QUANTITY|TAG - numéro de bloc, ou la chaîne « earliest » ,« latest », ou « pending », voir le paramètre de bloc par défaut.
QUANTITY - la position de l'oncle dans l'indice.

1params: [
2  "0x29c", // 668
3  "0x0", // 0
4]
 Copier

Retourne Voir eth_getBlockByHash

Remarque : Un oncle ne contient pas de transactions individuelles.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getUncleByBlockNumberAndIndex","params":["0x29c", "0x0"],"id":1}'
 Copier

Résultat voir eth_getBlockByHash

eth_newFilter

Crée un objet filtre, basé sur les options de filtre, pour avertir lorsque l'état change (logs). Pour vérifier si l'état a changé, appelez eth_getFilterChanges.

Une note sur la spécification des filtres de sujet : Les sujets sont dépendants de l'ordre. Une transaction avec un journal avec des sujets [A, B] sera mise en correspondance par les filtres de discussion suivants :

[] « n'importe quoi »
[A]: « A en première position (et n'importe quoi après) »
[null, B] « tout ce qui est en première position ET B en seconde position (et tout ce qui est après) »
[A, B] « A en première position ET B en deuxième position (et tout ce qui suivra) »
[[A, B], [A, B]] « (A OU B) en première position ET (A OU B) en deuxième position (et n'importe quoi après) »
Paramètres

Object - Les options de filtre :

fromBlock: QUANTITY|TAG - (optionnel, par défaut : "latest") nombre de blocs entiers, ou "latest" pour le dernier bloc miné ou "pending", "earliest" pour les transactions non encore minées.
toBlock: QUANTITY|TAG - (facultatif, par défaut : "latest") Numéro de bloc d'entier ou "latest" pour le dernier bloc miné ou "pending", "earliest" pour les transactions non encore minées.
address: DATA|Array, 20 octets - (facultatif) adresse contractuelle ou une liste d'adresses d'où les logs doivent provenir.
topics: Array of DATA, - (facultatif) tableau de 32 bytes DATA topics. Les sujets dépendent de l'ordre. Chaque sujet peut également être un tableau de DATA avec des options "ou".

1params: [
2  {
3    fromBlock: "0x1",
4    toBlock: "0x2",
5    address: "0x8888f1f195afa192cfee860698584c030f4c9db1",
6    topics: [
7      "0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b",
8      null,
9      [
10        "0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b",
11        "0x0000000000000000000000000aff3454fce5edbc8cca8697c15331677e6ebccc",
12      ],
13    ],
14  },
15]
Afficher tout
 Copier

Renvoie QUANTITY - Un id de filtre.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_newFilter","params":[{"topics":["0x12341234"]}],"id":73}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": "0x1" // 1
8}
 Copier

eth_newBlockFilter

Crée un filtre dans le nœud, pour avertir lorsqu'un nouveau bloc arrive. Pour vérifier si l'état a changé, appelez eth_getFilterChanges.

Paramètres : Aucun

Renvoie QUANTITY - Un id de filtre.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_newBlockFilter","params":[],"id":73}'
3// Result
4{
5  "id":1,
6  "jsonrpc":  "2.0",
7  "result": "0x1" // 1
8}
 Copier

eth_newPendingTransactionFilter

Crée un filtre dans le nœud, pour notifier quand de nouvelles transactions en attente arrivent. Pour vérifier si l'état a changé, appelez eth_getFilterChanges.

Paramètres : Aucun

Renvoie QUANTITY - Un id de filtre.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_newPendingTransactionFilter","params":[],"id":73}'
3// Result
4{
5  "id":1,
6  "jsonrpc":  "2.0",
7  "result": "0x1" // 1
8}
 Copier

eth_uninstallFilter

Désinstalle un filtre avec un identifiant donné. Doit toujours être appelé lorsque la montre n'est plus nécessaire. De plus, filtre le délai d'attente quand ils ne sont pas demandés avec eth_getFilterChanges pour une période de temps.

Paramètres

QUANTITY - L'identifiant du filtre.

1params: [
2  "0xb", // 11
3]
 Copier

Retourne Boolean - true si le filtre a été désinstallé avec succès, sinon false.

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_uninstallFilter","params":["0xb"],"id":73}'
3// Result
4{
5  "id":1,
6  "jsonrpc": "2.0",
7  "result": true
8}
 Copier

eth_getFilterChanges

Méthode de vote pour un filtre, qui retourne un tableau de logs qui s'est produit depuis le dernier sondage.

Paramètres

QUANTITY - L'identifiant du filtre.

1params: [
2  "0x16", // 22
3]
 Copier

Retourne Array - Tableau d'objets de log, ou un tableau vide si rien n'a changé depuis le dernier sondage.

Pour les filtres créés avec eth_newBlockFilter le retour constitue des hachages de blocs (DATA, 32 octets), par exemple ["0x3454645634534..."].
Pour les filtres créés avec eth_newPendingTransactionFilter le retour constitue des hachages de transaction (DATA, 32 octets), par exemple ["0x6345343454645..."].
Pour les filtres créés avec eth_newFilter, les logs sont des objets avec les paramètres suivants :
- removed : TAG - true lorsque le journal a été supprimé, en raison d'une réorganisation de chaîne. false si c'est un journal valide.
- logIndex: QUANTITY - nombre entier de la position de l'indice des logs dans le bloc. null lors de son log en attente.
- transactionIndex : QUANTITY - nombre entier à partir duquel le log de position de l'indice des transactions a été créé. null lors de son log en attente.
- transactionHash : DATA, 32 octets - hachage des transactions à partir desquelles ce log a été créé. null lors de son log en attente.
- blockHash : DATA, 32 octets - hachage du bloc dans lequel se trouvait ce log. null lors de son attente. null lors de son log en attente.
- blockNumber : QUANTITY - le numéro de bloc où se trouvait ce log. null lors de son attente. null lors de son log en attente.
- address: DATA, 20 octets - adresse à partir de laquelle ce journal est originaire.
- data: DATA - contient zéro ou plus de 32 octets d'arguments non indexés du log.
- topics: Array of DATA - Tableau de 0 à 4 32 octets DATA d'arguments de log indexés. (Dans Solidity: Le premier sujet est le hash de la signature de l'événement (par ex. Déposit(adresse,octets32,uint256)), sauf que vous avez déclaré l'événement avec le spécificateur anonyme.)
Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getFilterChanges","params":["0x16"],"id":73}'
3// Result
4{
5  "id":1,
6  "jsonrpc":"2.0",
7  "result": [{
8    "logIndex": "0x1", // 1
9    "blockNumber":"0x1b4", // 436
10    "blockHash": "0x8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcfdf829c5a142f1fccd7d",
11    "transactionHash":  "0xdf829c5a142f1fccd7d8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcf",
12    "transactionIndex": "0x0", // 0
13    "address": "0x16c5785ac562ff41e2dcfdf829c5a142f1fccd7d",
14    "data":"0x0000000000000000000000000000000000000000000000000000000000000000",
15    "topics": ["0x59ebeb90bc63057b6515673c3ecf9438e5058bca0f92585014eced636878c9a5"]
16    },{
17      ...
18    }]
19}
Afficher tout
 Copier

eth_getFilterLogs

Retourne un tableau de tous les logs correspondant au filtre avec l'identifiant donné.

Paramètres

QUANTITY - L'identifiant du filtre.

1params: [
2  "0x16", // 22
3]
 Copier

Retourne Voir eth_getFilterChanges

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getFilterLogs","params":["0x16"],"id":74}'
 Copier

Résultats voir eth_getFilterChanges

eth_getLogs

Retourne un tableau de tous les logs correspondant à un objet filtre donné.

Paramètres

Object - Les options de filtre :

fromBlock: QUANTITY|TAG - (optionnel, par défaut : "latest") nombre de blocs entiers, ou "latest" pour le dernier bloc miné ou "pending", "earliest" pour les transactions non encore minées.
toBlock: QUANTITY|TAG - (facultatif, par défaut : "latest") Numéro de bloc d'entier ou "latest" pour le dernier bloc miné ou "pending", "earliest" pour les transactions non encore minées.
address: DATA|Array, 20 octets - (facultatif) adresse contractuelle ou une liste d'adresses d'où les logs doivent provenir.
topics: Array of DATA, - (facultatif) tableau de 32 bytes DATA topics. Les sujets dépendent de l'ordre. Chaque sujet peut également être un tableau de DATA avec des options "ou".
blockhash: DATA, 32 octets - (facultatif, futur) À l'ajout de EIP-234, blockHash sera une nouvelle option de filtre qui restreint les logs retournés au bloc unique avec le hachage de 32 octets blockHash. Utiliser blockHash est équivalent à fromBlock = toBlock = le numéro de bloc avec le hachage blockHash. Si blockHash est présent dans les critères de filtre, alors ni fromBlock ni toBlock ne sont autorisés.

1params: [
2  {
3    topics: [
4      "0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b",
5    ],
6  },
7]
 Copier

Retourne Voir eth_getFilterChanges

Exemple

1// Request
2curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getLogs","params":[{"topics":["0x000000000000000000000000a94f5374fce5edbc8e2a8697c15331677e6ebf0b"]}],"id":74}'
 Copier

Résultats voir eth_getFilterChanges

Exemple d'utilisation

Déploiement d'un contrat en utilisant JSON_RPC

Cette section comprend une démonstration de la façon de déployer un contrat en utilisant uniquement l'interface RPC. Il existe des voies alternatives pour le déploiement de contrats où cette complexité est abstraite, par exemple, en utilisant des bibliothèques construites au dessus de l'interface RPC comme web3.js(opens in a new tab) et web3.py(opens in a new tab). Ces abstractions sont généralement plus faciles à comprendre et moins sujettes aux erreurs, mais il est toujours utile de comprendre ce qui se passe sous le capot.

Ce qui suit est un contrat intelligent simple appelé Multiply7 qui sera déployé à l'aide de l'interface JSON-RPC sur un nœud Ethereum. Ce tutoriel suppose que le lecteur exécute déjà un nœud Geth. Plus d'informations sur les nœuds et les clients sont disponibles ici. Veuillez vous référer à la documentation de client individuelle pour voir comment démarrer le JSON-RPC HTTP pour les clients non-Geth. La plupart des clients servent par défaut sur localhost:8545.

1contract Multiply7 {
2    event Print(uint);
3    function multiply(uint input) returns (uint) {
4        Print(input * 7);
5        return input * 7;
6    }
7}

La première chose à faire est de s'assurer que l'interface HTTP RPC est activée. Cela signifie que nous fournissons à Geth le drapeau --http au démarrage. Dans cet exemple, nous utilisons le nœud Geth dans une chaîne de développement privé. En utilisant cette approche, nous n'avons pas besoin d'éther sur le réseau réel.

geth --http --dev console 2>>geth.log

Cela démarrera l'interface HTTP RPC sur http://localhost:8545.

Nous pouvons vérifier que l'interface fonctionne en récupérant l'adresse et le solde de Coinbase en utilisant curl(opens in a new tab). Veuillez noter que les données contenues dans ces exemples seront différentes sur votre noeud local. Si vous voulez essayer ces commandes, remplacez les paramètres de la requête dans la deuxième requête avec le résultat retourné par la première.

curl --data '{"jsonrpc":"2.0","method":"eth_coinbase", "id":1}' -H "Content-Type: application/json" localhost:8545
{"id":1,"jsonrpc":"2.0","result":["0x9b1d35635cc34752ca54713bb99d38614f63c955"]}
curl --data '{"jsonrpc":"2.0","method":"eth_getBalance", "params": ["0x9b1d35635cc34752ca54713bb99d38614f63c955", "latest"], "id":2}' -H "Content-Type: application/json" localhost:8545
{"id":2,"jsonrpc":"2.0","result":"0x1639e49bba16280000"}

Comme les nombres sont encodés en hexa, la balance est retournée en wei sous la forme d'une chaîne hexadécimale. Si nous voulons avoir le solde en éther en tant que numéro, nous pouvons utiliser web3 de la console Geth .

1web3.fromWei("0x1639e49bba16280000", "ether")
2// "410"

Maintenant que notre chaîne de développement privé a un certain poids, nous pouvons déployer le contrat. La première étape est de compiler le contrat Multiply7 en byte code qui peut être envoyé à l'EVM. Pour installer solc, le compilateur Solidity, suivez la documentation Solidity(opens in a new tab). (Vous pouvez utiliser une ancienne version solc à des fins de correspondance à la version du compilateur utilisée pour notre exemple(opens in a new tab).)

L'étape suivante est de compiler le contrat Multiply7 en code d'octets qui peut être envoyé à l'EVM.

echo 'pragma solidity ^0.4.16; contract Multiply7 { event Print(uint); function multiply(uint input) public returns (uint) { Print(input * 7); return input * 7; } }' | solc --bin
======= <stdin>:Multiply7 =======
Binary:
6060604052341561000f57600080fd5b60eb8061001d6000396000f300606060405260043610603f576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063c6888fa1146044575b600080fd5b3415604e57600080fd5b606260048080359060200190919050506078565b6040518082815260200191505060405180910390f35b60007f24abdb5865df5079dcc5ac590ff6f01d5c16edbc5fab4e195d9febd1114503da600783026040518082815260200191505060405180910390a16007820290509190505600a165627a7a7230582040383f19d9f65246752244189b02f56e8d0980ed44e7a56c0b200458caad20bb0029

Maintenant que nous avons le code compilé, nous devons déterminer combien de gaz il coûte pour le déployer. L'interface RPC a une méthode eth_estimateGas qui nous donnera une estimation.

curl --data '{"jsonrpc":"2.0","method": "eth_estimateGas", "params": [{"from": "0x9b1d35635cc34752ca54713bb99d38614f63c955", "data": "0x6060604052341561000f57600080fd5b60eb8061001d6000396000f300606060405260043610603f576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063c6888fa1146044575b600080fd5b3415604e57600080fd5b606260048080359060200190919050506078565b6040518082815260200191505060405180910390f35b60007f24abdb5865df5079dcc5ac590ff6f01d5c16edbc5fab4e195d9febd1114503da600783026040518082815260200191505060405180910390a16007820290509190505600a165627a7a7230582040383f19d9f65246752244189b02f56e8d0980ed44e7a56c0b200458caad20bb0029"}], "id": 5}' -H "Content-Type: application/json" localhost:8545
{"jsonrpc":"2.0","id":5,"result":"0x1c31e"}

Et enfin déployez le contrat.

curl --data '{"jsonrpc":"2.0","method": "eth_sendTransaction", "params": [{"from": "0x9b1d35635cc34752ca54713bb99d38614f63c955", "gas": "0x1c31e", "data": "0x6060604052341561000f57600080fd5b60eb8061001d6000396000f300606060405260043610603f576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063c6888fa1146044575b600080fd5b3415604e57600080fd5b606260048080359060200190919050506078565b6040518082815260200191505060405180910390f35b60007f24abdb5865df5079dcc5ac590ff6f01d5c16edbc5fab4e195d9febd1114503da600783026040518082815260200191505060405180910390a16007820290509190505600a165627a7a7230582040383f19d9f65246752244189b02f56e8d0980ed44e7a56c0b200458caad20bb0029"}], "id": 6}' -H "Content-Type: application/json" localhost:8545
{"id":6,"jsonrpc":"2.0","result":"0xe1f3095770633ab2b18081658bad475439f6a08c902d0915903bafff06e6febf"}

La transaction est acceptée par le noeud et un hachage de la transaction est retourné. Ce hachage peut être utilisé pour suivre la transaction. La prochaine étape consiste à déterminer l'adresse où notre contrat est déployé. Chaque transaction exécutée créera un reçu. Ce reçu contient diverses informations sur la transaction telle que le bloc dans lequel la transaction a été incluse et la quantité de gaz utilisée par l'EVM. Si une transaction crée un contrat, elle contiendra également l'adresse du contrat. Nous pouvons récupérer le reçu avec la méthode eth_getTransactionReceipt RPC.

curl --data '{"jsonrpc":"2.0","method": "eth_getTransactionReceipt", "params": ["0xe1f3095770633ab2b18081658bad475439f6a08c902d0915903bafff06e6febf"], "id": 7}' -H "Content-Type: application/json" localhost:8545
{"jsonrpc":"2.0","id":7,"result":{"blockHash":"0x77b1a4f6872b9066312de3744f60020cbd8102af68b1f6512a05b7619d527a4f","blockNumber":"0x1","contractAddress":"0x4d03d617d700cf81935d7f797f4e2ae719648262","cumulativeGasUsed":"0x1c31e","from":"0x9b1d35635cc34752ca54713bb99d38614f63c955","gasUsed":"0x1c31e","logs":[],"logsBloom":"0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000","status":"0x1","to":null,"transactionHash":"0xe1f3095770633ab2b18081658bad475439f6a08c902d0915903bafff06e6febf","transactionIndex":"0x0"}}

Notre contrat a été créé sur 0x4d03d617d700cf81935d7f797f4e2ae719648262. Un résultat nul au lieu d'un reçu signifie que la transaction n'a pas encore été intégrée dans un bloc. Attendez un instant et vérifiez si votre mineur est en cours d'exécution et réessayez.

Interagir avec les contrats intelligents

Dans cet exemple, nous enverrons une transaction en utilisant eth_sendTransaction à la méthode multiply du contrat.

eth_sendTransaction nécessite plusieurs arguments, spécifiquement from, to et data. From est l'adresse publique de notre compte et to est l'adresse du contrat. L'argument data contient une charge utile qui définit quelle méthode doit être appelée et avec quels arguments. C'est ici que l'ABI (interface binaire de l'application)(opens in a new tab) entre en jeu. L'ABI est un fichier JSON qui définit comment définir et encoder les données pour l'EVM.

Les octets de la charge utile définissent quelle méthode dans le contrat est appelée. Il s'agit des 4 premiers octets du hachage de Keccak sur le nom de la fonction et ses types d'arguments, encodés en hexa. La fonction multiplier accepte un uint qui est un alias pour uint256. Cela nous laisse avec :

1web3.sha3("multiply(uint256)").substring(0, 10)
2// "0xc6888fa1"

L'étape suivante est d'encoder les arguments. Il n'y a qu'un seul uint256, par exemple, la valeur 6. L'ABI a une section qui spécifie comment encoder les types uint256.

int<M>: enc(X) est l'encodage gros-boutiste en complément à deux de X, ajouté sur le côté supérieur (gauche) avec Jeff pour X négatif et avec zéro > octets pour X positif de sorte que la longueur est un multiple de 32 octets.

Ceci encode en 0000000000000000000000000000000000000000000000000000000000000006.

La combinaison du sélecteur de fonction et de l'argument encodé sera 0xc6888fa10000000000000000000000000000000000000000000000000000000000000006.

Cela peut maintenant être envoyé au nœud :

curl --data '{"jsonrpc":"2.0","method": "eth_sendTransaction", "params": [{"from": "0xeb85a5557e5bdc18ee1934a89d8bb402398ee26a", "to": "0x6ff93b4b46b41c0c3c9baee01c255d3b4675963d", "data": "0xc6888fa10000000000000000000000000000000000000000000000000000000000000006"}], "id": 8}' -H "Content-Type: application/json" localhost:8545
{"id":8,"jsonrpc":"2.0","result":"0x759cf065cbc22e9d779748dc53763854e5376eea07409e590c990eafc0869d74"}

Puisqu'une transaction a été envoyée, un hachage de transaction a été retourné. La récupération du reçu :

1{
2   blockHash: "0xbf0a347307b8c63dd8c1d3d7cbdc0b463e6e7c9bf0a35be40393588242f01d55",
3   blockNumber: 268,
4   contractAddress: null,
5   cumulativeGasUsed: 22631,
6   gasUsed: 22631,
7   logs: [{
8      address: "0x6ff93b4b46b41c0c3c9baee01c255d3b4675963d",
9      blockHash: "0xbf0a347307b8c63dd8c1d3d7cbdc0b463e6e7c9bf0a35be40393588242f01d55",
10      blockNumber: 268,
11      data: "0x000000000000000000000000000000000000000000000000000000000000002a",
12      logIndex: 0,
13      topics: ["0x24abdb5865df5079dcc5ac590ff6f01d5c16edbc5fab4e195d9febd1114503da"],
14      transactionHash: "0x759cf065cbc22e9d779748dc53763854e5376eea07409e590c990eafc0869d74",
15      transactionIndex: 0
16  }],
17  transactionHash: "0x759cf065cbc22e9d779748dc53763854e5376eea07409e590c990eafc0869d74",
18  transactionIndex: 0
19}
Afficher tout

Le reçu contient un journal d'activités. Ce journal a été généré par l'EVM lors de l'exécution de la transaction et est inclus dans le reçu. La fonction multiply montre que l'événement Print a été levé avec le temps d'entrée 7. Puisque l'argument de l'événement Print était un uint256, nous pouvons le décoder selon les règles ABI qui nous laisseront avec la décimale prévue 42. Mis à part les données, il est intéressant de noter que les sujets peuvent être utilisés pour déterminer quel événement a créé le journal :

1web3.sha3("Print(uint256)")
2// "24abdb5865df5079dcc5ac590ff6f01d5c16edbc5fab4e195d9febd1114503da"

Il ne s'agissait que d'une brève introduction à certaines des tâches les plus courantes, démontrant l'utilisation directe du JSON-RPC.

back-to-top ↑

API JSON-RPC

Bibliothèques pratiques

API client de consensus

Spécifications de client d'exécution

Conventions

Encodage hexadécimal

Quantités

Données non formatées

Le paramètre de bloc par défaut

Exemples

Exemples de Curl

Gossip, État, Historique

Méthodes Gossip

Méthodes d'état

Méthodes d'historique

Méthodes API JSON-RPC

web3_clientVersion

web3_sha3

net_version

net_listening

net_peerCount

eth_protocolVersion

eth_syncing

eth_coinbase

eth_chainId

eth_mining

eth_hashrate

eth_gasPrice

eth_accounts

eth_blockNumber

eth_getBalance

eth_getStorageAt

eth_getTransactionCount

eth_getBlockTransactionCountByHash

eth_getBlockTransactionCountByNumber

eth_getUncleCountByBlockHash

eth_getUncleCountByBlockNumber

eth_getCode

eth_sign

eth_signTransaction

eth_sendTransaction

eth_sendRawTransaction

eth_call

eth_estimateGas

eth_getBlockByHash

eth_getBlockByNumber

eth_getTransactionByHash

eth_getTransactionByBlockHashAndIndex

eth_getTransactionByBlockNumberAndIndex

eth_getTransactionReceipt

eth_getUncleByBlockHashAndIndex

eth_getUncleByBlockNumberAndIndex

eth_newFilter

eth_newBlockFilter

eth_newPendingTransactionFilter

eth_uninstallFilter

eth_getFilterChanges

eth_getFilterLogs

eth_getLogs

Exemple d'utilisation

Déploiement d'un contrat en utilisant JSON_RPC

Interagir avec les contrats intelligents

Sujets connexes

Cet article vous a été utile ?