Skip to content

Latest commit

 

History

History
95 lines (73 loc) · 3.85 KB

readme.md

File metadata and controls

95 lines (73 loc) · 3.85 KB
Raw
title
Overview

The JavaScript Soroban Client facilitates integration with the Stellar Soroban-RPC API server and submission of Stellar transactions, either on Node.js or in the browser. It has two main uses: querying Soroban-RPC and building, signing, and submitting transactions to the Stellar network.

Building and installing js-soroban-client
Examples of using js-soroban-client

Querying Soroban-RPC

js-soroban-client gives you access to all the endpoints exposed by Soroban-RPC.

Building requests

Starting with a server object, you can call methods to query the server. (See the Soroban-RPC reference documentation for what methods are possible.)

var SorobanClient = require('soroban-client');
var server = new SorobanClient.Server('http://localhost:8000/soroban/rpc');

// get the sequence number for an account
server.getAccount(
  'GASOCNHNNLYFNMDJYQ3XFMI7BYHIOCFW3GJEOWRPEGK2TDPGTG2E5EDW'
).then(function(r){ console.log(r); });

Methods return a promise of the response from the Soroban-RPC server. If there is an error, the promise will throw an error.

Handling responses

XDR

The transaction endpoints will return some fields in raw XDR form. You can convert this XDR to JSON using the .fromXDR() method.

An example of using the getLedgerEntries method to read the current ledger entry for an account and print the XDR field as JSON:

// Construct the LedgerKey we want to look up
const key = SorobanClient.xdr.LedgerKey.account(
  new SorobanClient.xdr.LedgerKeyAccount({
    accountId: 'GASOCNHNNLYFNMDJYQ3XFMI7BYHIOCFW3GJEOWRPEGK2TDPGTG2E5EDW'
  })
);

// Fetch the current LedgerKeyData from the server.
server.getLedgerEntries([key]).then(function (response) {
  const ledgerEntry = response.entries[0];
  const parsed = SorobanClient.xdr.LedgerEntryData.fromXDR(ledgerEntry.xdr, 'base64');
  console.log( JSON.stringify(parsed) );
});

Transactions

Building transactions

See the Building Transactions guide for information about assembling a transaction.

Submitting transactions

Once you have built your transaction, you can send it to the Stellar network with Server.sendTransaction().

const SorobanClient = require('soroban-client')
const server = new SorobanClient.Server('http://localhost:8000/soroban/rpc');

(async function main() {
    const account = await server.getAccount(publicKey);

    // Fee hardcoded for this example.
    const fee = 100;

    const contract = new SorobanClient.Contract(contractId);

    let transaction = new SorobanClient.TransactionBuilder(account, { fee, networkPassphrase: SorobanClient.Networks.STANDALONE })
        .addOperation(
            // An operation to call increment on the contract
            contract.call("increment")
        )
        .setTimeout(30)
        .build();

    // Simulate the transaction to discover the storage footprint, and update the
    // transaction to include it. If you already know the storage footprint you
    // can use `addFootprint` to add it yourself, skipping this step.
    transaction = await server.prepareTransaction(transaction);

    // sign the transaction
    transaction.sign(SorobanClient.Keypair.fromSecret(secretString));

    try {
        const transactionResult = await server.sendTransaction(transaction);
        console.log(transactionResult);
    } catch (err) {
        console.error(err);
    }
})()