xrpl-dev-portal/docs/tutorials/go/build-apps/get-started.md

html, parent, funnel, doc_type, category, seo, top_nav_name, top_nav_grouping, labels, showcase_icon

html	parent	funnel	doc_type	category	seo	top_nav_name	top_nav_grouping	labels	showcase_icon
get-started-using-golang-library.html	golang.html	Build	Tutorials	Get Started	description Build a GoLang application that interacts with the XRP Ledger.	GoLang	Get Started	Development	assets/img/logos/golang.svg

Get Started Using GoLang Library

This tutorial walks you through the basics of building an XRP Ledger-connected application using xrpl-go, a pure GoLang library built to interact with the XRP Ledger.

This tutorial is intended for beginners and should take no longer than 30 minutes to complete.

Learning Goals

In this tutorial, you'll learn:

• The basic building blocks of XRP Ledger-based applications.
• How to connect to the XRP Ledger using xrpl-go.
• How to get an account on the Testnet using xrpl-go.
• How to use the xrpl-go library to look up information about an account on the XRP Ledger.
• How to put these steps together to create a Java app.

Requirements

Requiring Go version 1.22.0 and later. Download latest Go version

Installation

The xrpl-go library is available on

Start a new project (or use an existing one) and install the xrpl-go library via Go modules:

# Initialize your module (if you haven't already)
go mod init your-module-name

# Fetch the latest version of xrpl-go
go get -u github.com/Peersyst/xrpl-go

Start Building

When you're working with the XRP Ledger, there are a few things you'll need to manage, whether you're adding XRP to your account, integrating with the decentralized exchange, or issuing tokens. This tutorial walks you through basic patterns common to getting started with all of these use cases and provides sample code for implementing them.

Here are the basic steps you'll need to cover for almost any XRP Ledger project:

1. Connect to the XRP Ledger.
2. Get an account.
3. Query the XRP Ledger.

1. Connect to the XRP Ledger

To make queries and submit transactions, you need to connect to the XRP Ledger. To do this with xrpl-go, you have two main options:

1. Via websocket: {% code-snippet file="/_code-samples/get-started/go/base/ws/main.go from="// Define the network client" before="// ... custom code goes here" language="go" /%}
2. Via RPC: {% code-snippet file="/_code-samples/get-started/go/base/rpc/main.go from="// Define the network client" before="// Ping the network (used to avoid Go unused variable error, but useful to check connectivity)" language="go" /%}

Connect to the production XRP Ledger

The sample code in the previous section shows you how to connect to the Testnet, which is a parallel network for testing where the money has no real value. When you're ready to integrate with the production XRP Ledger, you'll need to connect to the Mainnet. You can do that in two ways:

• By installing the core server (rippled) and running a node yourself. The core server connects to the Mainnet by default, but you can change the configuration to use Testnet or Devnet. There are good reasons to run your own core server. If you run your own server, you can connect to it like so:

  import 	"github.com/Peersyst/xrpl-go/xrpl/websocket"
  const MyServer := "http://localhost:5005/"
  client := websocket.NewClient(websocket.NewClientConfig().WithHost(MyServer))
  

  See the example core server config file for more information about default values.

• By using one of the available [public servers][]:

  import 	"github.com/Peersyst/xrpl-go/xrpl/websocket"
  const PublicServer = "wss://xrplcluster.com/"
  client := websocket.NewClient(websocket.NewClientConfig().WithHost(PublicServer))
  

2. Get account

In xrpl-go, account creation and key management live in the wallet package, and on Testnet you can use the built-in faucet provider on your WebSocket client to fund a brand-new account immediately.

Here we spin up a Testnet‐connected WebSocket client, generate a fresh ED25519 wallet, then fund it automatically via the public faucet.

client := websocket.NewClient(
	websocket.NewClientConfig().
		WithHost("wss://s.altnet.rippletest.net:51233").
		WithFaucetProvider(faucet.NewTestnetFaucetProvider()),
)

defer client.Disconnect()
if err := client.Connect(); err != nil {
	fmt.Println(err)
	return
}

w, err := wallet.New(crypto.ED25519())
if err != nil {
	fmt.Println(err)
	return
}
if err := client.FundWallet(&w); err != nil {
	fmt.Println(err)
	return
}

This constructor returns a Go Wallet value with the following fields:

type Wallet struct {
    PublicKey      string          // the hex-encoded public key
    PrivateKey     string          // the hex-encoded private key
    ClassicAddress types.Address   // the XRPL “r…” address
    Seed           string          // the base58 seed
}

If you already have a seed encoded in [base58][], you can make a Wallet instance from it like this:

  w, err := wallet.FromSeed("sn3nxiW7v8KXzPzAqzyHXbSSKNuN9", "")

3. Query the XRP Ledger

You can query the XRP Ledger to get information about a specific account, a specific transaction, the state of a current or a historical ledger, and the XRP Ledger's decentralized exchange. You need to make these queries, among other reasons, to look up account info to follow best practices for reliable transaction submission.

You can use either the Client's request() method to access the XRP Ledger's WebSocket API. For example:

{% code-snippet file="/_code-samples/get-tx/go/main.go" from="// Get the latest validated ledger" language="go" /%}

Or use the [websocket or rpc packages] getter methods:

{% code-snippet file="/_code-samples/get-started/go/get-acc-info/ws/main.go" from="// Get info from" before="// Get info about" language="go" /%}

Keep on Building

Now that you know how to use xrpl.js to connect to the XRP Ledger, get an account, and look up information about it, you can also:

• Send XRP.