Stellar PHP SDK API Documentation

FuturenetFriendBot
in package

Utility for funding test accounts on the Stellar Futurenet

FriendBot is a service that funds accounts on the Stellar Futurenet with test XLM. Futurenet is used for testing upcoming protocol features before they reach testnet.

Warning: This service should only be used with test networks. Never attempt to use FriendBot with mainnet accounts.

Example:

$accountId = "GABC...XYZ";
if (FuturenetFriendBot::fundTestAccount($accountId)) {
    echo "Futurenet account funded successfully";
}
Tags
see
FriendBot

For funding accounts on the regular test network

see
CustomFriendBot

For using a custom FriendBot endpoint

see
https://developers.stellar.org

Stellar developer docs Documentation on FriendBot

Table of Contents

Methods

fundTestAccount()  : bool
Funds a test account on the Stellar Futurenet

Methods

fundTestAccount()

Funds a test account on the Stellar Futurenet

public static fundTestAccount(string $accountId) : bool

Note: Errors are printed to stdout for debugging purposes

Parameters
$accountId : string

The Stellar account ID (56-character public key starting with 'G') to fund

Tags
static
Return values
bool

True if funding succeeded, false otherwise


        
On this page

Search results