NwajeiEdgar
    • Create new note
    • Create a note from template
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
    • Invite by email
      Invitee

      This note has no invitees

    • Publish Note

      Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note No publishing access yet

      Your note will be visible on your profile and discoverable by anyone.
      Your note is now live.
      This note is visible on your profile and discoverable online.
      Everyone on the web can find and read all notes of this public team.

      Your account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

      Your team account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

      Explore these features while you wait
      Complete general settings
      Bookmark and like published notes
      Write a few more notes
      Complete general settings
      Write a few more notes
      See published notes
      Unpublish note
      Please check the box to agree to the Community Guidelines.
      View profile
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Note Insights New
    • Make a copy
    • Transfer ownership
    • Delete this note
    • Save as template
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Note Insights Versions and GitHub Sync Sharing URL Create Help
Create Create new note Create a note from template
Menu
Options
Make a copy Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Write
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note No publishing access yet

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.

    Your account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

    Your team account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

    Explore these features while you wait
    Complete general settings
    Bookmark and like published notes
    Write a few more notes
    Complete general settings
    Write a few more notes
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       Owned this note    Owned this note      
    Published Linked with GitHub
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    ## Introduction **Geth**, which is the short form for Go Ethereum, is a **Go** implementation of the **Ethereum protocol** designed to allow developers run **nodes** on the Ethereum network, interact with the Ethereum Blockchain, validate transactions, and also execute smart contracts. Key features of Geth include: * Ethereum Node Implementation. * JSON-RPC API methods. * Smart Contract Execution (EVM Support). * Sync Modes. ## Core Functionality ### Ethereum Node Implementation. An Ethereum node is made up of two parts: * The **execution client** that handles transactions and smart contracts, * The **consensus client** that ensures the blockchain stays in agreement (consensus). Geth is an **execution client** that is coupled to a consensus client to keep track of the Ethereum blockchain. It is responsible for handling transactions, managing states and supporting the Ethereum Virtual Machine EVM. | Component | Role | |--------------------|----------------------------------------------------------------------------------------------| |**Geth (Execution Client)** | Executes Ethereum transactions, manages state, and provides RPC APIs for developers| |**Consensus Client** | Ensures the node follows the correct chain by handling consensus and syncing blocks | #### Sync Modes Syncing is the process that updates Geth to the latest Ethereum block and current global state. A Geth node is synced by various means depending on the **speed, storage requirements** and **trust assumptions**. To properly sync, Geth connects to a consensus client, especially now that Ethereum uses **proof-of-stake**. | Sync Mode | Description | Use Case | Pass Command | |------------------|-------------------------------------------------------------------------------------------------|----------------------------------------------|--------------------------------------------------------| | **Snap (Default)** |starts from recent block and syncs from there to the head of the chain,it keeps only the most recent 128 block states in memory. | Default mode, suitable for most users. | `--syncmode snap` | | **Full** |A full block-by-block sync generates the current state by executing every block starting from the **genesis** block. | High trust, validation-focused nodes. | `--syncmode full` | | **Archive** | Retains all historical data right back to **genesis**. | Querying **historical state data** instantly.| `--syncmode full --gcmode archive` | ### JSON-RPC API Developers interact with Geth by sending requests to specific **JSON-RPC API** methods. The RPC requests are sent to the node and the response is sent to the client using **transport protocols**. These RPC methods are grouped into various categories, depending on their functions. Meanwhile, all method names are made up of the **namespace**, an **underscore**, and the actual **method name** within the namespace. The `eth_call` method for example resides in the `eth` namespace. **Transport Protocols** Geth allows developers interact with the blockchain using three types of communication methods, called transport protocols. They are: **IPC**, **HTTP** and **Websockets**. | Transport | Direction | Good For | Default Port | Enable With | | ------------- | ---------- | ------------------------------ | ------------ | ------------ | | **IPC** | Local environment | Fast, secure (Unix systems) | N/A | Auto-enabled | | **HTTP** | One-way | Most common, tools & browsers | `8545` | `geth --http` | | **WebSocket** | Two-way | Event subscriptions, real-time | `8546` | `--ws` | ## Running & Configuring Geth ### Installation Geth can be installed via the following methods: * Package managers * Downloading a pre-built bundle. * Docker container. * Build from source code. #### Package managers **macOS (via Homebrew)** The easiest way for developers to install Geth is to use the **Geth Homebrew tap**. To check if Homebrew is already installed, run the command: ``` brew -v ``` If it returns a version, Homebrew is already installed. If it doesn't, [install Homebrew](https://brew.sh/). After installing Homebrew, run the following command to install Geth: ``` brew tap ethereum/ethereum brew install ethereum # Stable version brew install ethereum --devel # Latest dev version ``` To update Geth, run the following command: ``` brew update brew upgrade brew reinstall ethereum ``` **Ubuntu (via PPA)** Install Geth on Ubuntu-based distributions using built-in launchpad **PPAs** (Personal Package Archives). To add Ethereum PPA, run the following command: ``` sudo add-apt-repository -y ppa:ethereum/ethereum sudo apt-get update ``` To install Geth, run the following command: **For stable version** ``` sudo apt-get update sudo apt-get install ethereum ``` **For dev version** ``` sudo apt-get update sudo apt-get install ethereum-unstable ``` **Windows** The easiest way to install Geth on windows, is to visit the Geth [Downloads](https://geth.ethereum.org/downloads) page and download the Windows installer or ZIP file **Install Geth**: * The **install wizard** offers the user the option to install Geth, or Geth and the developer tools * Run the **installer** and follow the **prompts**. * The installer adds `geth` to your system's `PATH` automatically. * Alternatively, you can extract the ZIP file and run `geth.exe` from the command prompt. To update Geth, download and install the latest version using the steps above. Note: Use `geth --help` in the command prompt to view available commands. **FreeBSD via pkg** Geth can also be installed on FreeBSD via the package manager `pkg`. To download and install Geth, enter the command: ``` pkg install go-ethereum ``` This installs Geth software and the following developer tools: `clef`, `devp2p`, `abigen`, `bootnode`, `evm`, `rlpdump` and `puppeth`. To update an existing Geth installation to the latest version, enter the following command: ``` pkg upgrade ``` **FreeBSD via ports** Geth can also be installed using ports, by navigating to the `net-p2p/go-ethereum` ports directory and running `make install` as root: ``` cd /usr/ports/net-p2p/go-ethereum make install ``` This installs the Geth software and the following developer tools: `clef`, `devp2p`, `abigen`, `bootnode`, `evm`, `rlpdump` and `puppeth`. The binaries for these tools are saved in `/usr/local/bin/`. #### Downloading a pre-built bundle The easiest way to install Geth is by downloading a pre-compiled binary for your operating system. Follow these steps: * Go to the official Geth [downloads](https://geth.ethereum.org/downloads) page * Select your OS (Windows, macOS, Linux). ### Configuration & CLI Flags Geth is controlled using the **command line**. To start Geth, use the `geth` command. To stop Geth, press `ctrl-c`. Geth can be configured using command-line options called flags. **Common Flags** ``` --syncmode value – Syncing strategy (snap, full, fast, or light). Default: "snap". --http - Enable the HTTP-RPC server. --datadir value – Data directory for the databases and keystore. --verbosity value – Logging verbosity (0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=detail). ``` To get command-line help, run: ``` geth --help ``` For a comprehensive list of CLI options, refer to the Geth [Command-Line Options](https://geth.ethereum.org/docs/fundamentals/command-line-options). ## Security **Security Best Practices** Securing and maintaining your Geth node is important to ensure the integrity of your operations and the broader Ethereum network. Here are essential security best practices: * Download Geth using only the links on the [Downloads](https://geth.ethereum.org/downloads) page. * Avoid exposing Geth API endpoints to the internet. * Ensure to keep private keys and account passwords backed up and inaccessible to adversaries. * Make use of [Clef](https://geth.ethereum.org/docs/tools/clef/introduction), a standalone key manager to manage private keys. Clef requires manual approval for transactions, reducing the risk of unauthorized operations. ## Conclusion By adhering to best practices, such as implementing proper firewall rules, regularly updating software, and securely storing keys, users can maintain a healthy and secure Geth node while contributing seamlessly to Ethereum’s decentralized ecosystem. For more details, refer to the official Geth [documentation](https://geth.ethereum.org/docs).

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password
    or
    Sign in via Google Sign in via Facebook Sign in via X(Twitter) Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    By signing in, you agree to our terms of service.

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub
        • Please sign in to GitHub and install the HackMD app on your GitHub repo.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully