sign - XRPL

Example code for the sign JSON RPC method. Complete guide to using sign JSON-RPC in the GetBlock Web3 documentation.

This method takes a transaction in JSON format and a secret value, and returns a signed binary representation of the transaction. This method is admin-only on public servers.

This method is not available on public RPC endpoints. Use local signing with xrpl.js or xrpl-py instead.

Parameters

Parameter	Type	Required	Description
tx_json	object	Yes	Transaction to sign
secret	string	No	Account secret
seed	string	No	Account seed
seed_hex	string	No	Seed in hex
passphrase	string	No	Passphrase
key_type	string	No	Key algorithm
offline	boolean	No	Offline mode
build_path	boolean	No	Build payment paths
fee_mult_max	number	No	Fee multiplier
fee_div_max	number	No	Fee divisor

Request Example

cURL

curl --location --request POST 'https://shared.eu-central-1.getblock.io/<ACCESS_TOKEN>/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "sign",
    "params": [{
        "tx_json": {
            "TransactionType": "Payment",
            "Account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
            "Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
            "Amount": "1000000"
        },
        "secret": "s..."
    }],
    "id": "getblock.io"
}'

JavaScript (Axios)

const axios = require('axios');

const url = 'https://shared.eu-central-1.getblock.io/<ACCESS_TOKEN>/';
const headers = {
    'Content-Type': 'application/json'
};

// Note: sign method typically not available on public RPCs
// Use local signing instead
const payload = {
    jsonrpc: '2.0',
    method: 'sign',
    params: [{
        tx_json: {
            TransactionType: 'Payment',
            Account: 'rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH',
            Destination: 'ra5nK24KXen9AHvsdFTKHSANinZseWnPcX',
            Amount: '1000000'
        },
        secret: 's...'
    }],
    id: 'getblock.io'
};

axios.post(url, payload, { headers })
    .then(response => console.log(response.data))
    .catch(error => console.error(error));

Python

import requests

url = "https://shared.eu-central-1.getblock.io/<ACCESS_TOKEN>/"
headers = {
    "Content-Type": "application/json"
}

# Note: sign method typically not available on public RPCs
payload = {
    "jsonrpc": "2.0",
    "method": "sign",
    "params": [{
        "tx_json": {
            "TransactionType": "Payment",
            "Account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
            "Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
            "Amount": "1000000"
        },
        "secret": "s..."
    }],
    "id": "getblock.io"
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

Rust

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    
    let payload = json!({
        "jsonrpc": "2.0",
        "method": "sign",
        "params": [{
            "tx_json": {
                "TransactionType": "Payment",
                "Account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
                "Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
                "Amount": "1000000"
            },
            "secret": "s..."
        }],
        "id": "getblock.io"
    });

    let response = client
        .post("https://shared.eu-central-1.getblock.io/<ACCESS_TOKEN>/")
        .header("Content-Type", "application/json")
        .json(&payload)
        .send()
        .await?;

    let result: serde_json::Value = response.json().await?;
    println!("{:#?}", result);
    
    Ok(())
}

Response Example

{
    "result": "null",
    "id": "getblock.io",
    "status_code": 405,
    "message": "Method not allowed"
}

Response Parameters

Field	Type	Description
tx_blob	string	Signed transaction hex
tx_json	object	Transaction JSON
hash	string	Transaction hash

Use Cases

• Transaction signing (admin only)

• Development environments

• Private nodes

Recommended: Local Signing

xrpl.js

const xrpl = require('xrpl');

async function signAndSubmit() {
    const client = new xrpl.Client('wss://xrplcluster.com');
    await client.connect();
    
    const wallet = xrpl.Wallet.fromSeed('s...');
    
    const payment = {
        TransactionType: 'Payment',
        Account: wallet.address,
        Destination: 'ra5nK24KXen9AHvsdFTKHSANinZseWnPcX',
        Amount: '1000000'
    };
    
    // Local signing
    const prepared = await client.autofill(payment);
    const signed = wallet.sign(prepared);
    
    console.log('Signed blob:', signed.tx_blob);
    
    // Submit
    const result = await client.submitAndWait(signed.tx_blob);
    console.log('Result:', result);
    
    await client.disconnect();
}

signAndSubmit();

xrpl-py

from xrpl.clients import JsonRpcClient
from xrpl.wallet import Wallet
from xrpl.models.transactions import Payment
from xrpl.transaction import sign, submit_and_wait

client = JsonRpcClient("https://xrp.getblock.io/mainnet/")
wallet = Wallet.from_seed("s...")

payment = Payment(
    account=wallet.address,
    destination="ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
    amount="1000000"
)

# Local signing
signed = sign(payment, wallet)
print("Signed:", signed)