# serverURL

View Source lib/rpc/server.js, line 122

# static constant SUBMIT_TRANSACTION_TIMEOUT

Default Value:

• 60000

View Source lib/rpc/server.js, line 28

# async getAccount(address) → {Promise.<Account>}

Parameters:

See:

• getLedgerEntries docs

View Source lib/rpc/server.js, line 153

Example

const accountId = "GBZC6Y2Y7Q3ZQ2Y4QZJ2XZ3Z5YXZ6Z7Z2Y4QZJ2XZ3Z5YXZ6Z7Z2Y4";
server.getAccount(accountId).then((account) => {
  console.log("sequence:", account.sequence);
});

# async getContractData(contract, key, durabilityopt) → {Promise.<Api.LedgerEntryResult>}

Parameters:

See:

• getLedgerEntries docs

View Source lib/rpc/server.js, line 220

Example

const contractId = "CCJZ5DGASBWQXR5MPFCJXMBI333XE5U3FSJTNQU7RIKE3P5GN2K2WYD5";
const key = xdr.ScVal.scvSymbol("counter");
server.getContractData(contractId, key, Durability.Temporary).then(data => {
  console.log("value:", data.val);
  console.log("liveUntilLedgerSeq:", data.liveUntilLedgerSeq);
  console.log("lastModified:", data.lastModifiedLedgerSeq);
  console.log("latestLedger:", data.latestLedger);
});

# async getContractWasmByContractId(contractId) → {Promise.<Buffer>}

Parameters:

View Source lib/rpc/server.js, line 281

Example

const contractId = "CCJZ5DGASBWQXR5MPFCJXMBI333XE5U3FSJTNQU7RIKE3P5GN2K2WYD5";
server.getContractWasmByContractId(contractId).then(wasmBuffer => {
  console.log("WASM bytecode length:", wasmBuffer.length);
  // ... do something with the WASM bytecode ...
}).catch(err => {
  console.error("Error fetching WASM bytecode:", err);
});

# async getContractWasmByHash(wasmHash) → {Promise.<Buffer>}

Parameters:

View Source lib/rpc/server.js, line 316

Example

const wasmHash = Buffer.from("...");
server.getContractWasmByHash(wasmHash).then(wasmBuffer => {
  console.log("WASM bytecode length:", wasmBuffer.length);
  // ... do something with the WASM bytecode ...
}).catch(err => {
  console.error("Error fetching WASM bytecode:", err);
});

# async getEvents(request) → {Promise.<Api.GetEventsResponse>}

Parameters:

See:

• getEvents docs

View Source lib/rpc/server.js, line 543

Example

server.getEvents({
   startLedger: 1000,
   endLedger: 2000,
   filters: [
    {
     type: "contract",
     contractIds: [ "deadb33f..." ],
     topics: [[ "AAAABQAAAAh0cmFuc2Zlcg==", "AAAAAQB6Mcc=", "*" ]]
    }, {
     type: "system",
     contractIds: [ "...c4f3b4b3..." ],
     topics: [[ "*" ], [ "*", "AAAAAQB6Mcc=" ]]
    }, {
     contractIds: [ "...c4f3b4b3..." ],
     topics: [[ "AAAABQAAAAh0cmFuc2Zlcg==" ]]
    }, {
     type: "diagnostic",
     topics: [[ "AAAAAQB6Mcc=" ]]
    }
   ],
   limit: 10,
});

# async getFeeStats() → {Promise.<Api.GetFeeStatsResponse>}

See:

• https://developers.stellar.org/docs/data/rpc/api-reference/methods/getFeeStats

View Source lib/rpc/server.js, line 859

# async getHealth() → {Promise.<Api.GetHealthResponse>}

See:

• getLedgerEntries docs

View Source lib/rpc/server.js, line 184

Example

server.getHealth().then((health) => {
  console.log("status:", health.status);
});

# async getLatestLedger() → {Promise.<Api.GetLatestLedgerResponse>}

See:

• getLatestLedger docs

View Source lib/rpc/server.js, line 606

Example

server.getLatestLedger().then((response) => {
  console.log("hash:", response.id);
  console.log("sequence:", response.sequence);
  console.log("protocolVersion:", response.protocolVersion);
});

# async getLedgerEntries(…keys) → {Promise.<Api.GetLedgerEntriesResponse>}

Parameters:

See:

• getLedgerEntries docs
• RpcServer._getLedgerEntries

View Source lib/rpc/server.js, line 366

Example

const contractId = "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD2KM";
const key = xdr.LedgerKey.contractData(new xdr.LedgerKeyContractData({
  contractId: StrKey.decodeContract(contractId),
  key: xdr.ScVal.scvSymbol("counter"),
}));

server.getLedgerEntries([key]).then(response => {
  const ledgerData = response.entries[0];
  console.log("key:", ledgerData.key);
  console.log("value:", ledgerData.val);
  console.log("liveUntilLedgerSeq:", ledgerData.liveUntilLedgerSeq);
  console.log("lastModified:", ledgerData.lastModifiedLedgerSeq);
  console.log("latestLedger:", response.latestLedger);
});

# async getNetwork() → {Promise.<Api.GetNetworkResponse>}

See:

• getNetwork docs

View Source lib/rpc/server.js, line 585

Example

server.getNetwork().then((network) => {
  console.log("friendbotUrl:", network.friendbotUrl);
  console.log("passphrase:", network.passphrase);
  console.log("protocolVersion:", network.protocolVersion);
});

# async getSACBalance(contractId, sac, networkPassphraseopt) → {Promise.<Api.BalanceResponse>}

Parameters:

See:

• getLedgerEntries
• https://developers.stellar.org/docs/tokens/stellar-asset-contract

View Source lib/rpc/server.js, line 913

Example

// assume `contractId` is some contract with an XLM balance
// assume server is an instantiated `Server` instance.
const entry = (await server.getSACBalance(
  new Address(contractId),
  Asset.native(),
  Networks.PUBLIC
));

// assumes BigInt support:
console.log(
  entry.balanceEntry ?
  BigInt(entry.balanceEntry.amount) :
  "Contract has no XLM");

# async getTransaction(hash) → {Promise.<Api.GetTransactionResponse>}

Parameters:

See:

• getTransaction docs

View Source lib/rpc/server.js, line 439

Example

const transactionHash = "c4515e3bdc0897f21cc5dbec8c82cf0a936d4741cb74a8e158eb51b9fb00411a";
server.getTransaction(transactionHash).then((tx) => {
  console.log("status:", tx.status);
  console.log("envelopeXdr:", tx.envelopeXdr);
  console.log("resultMetaXdr:", tx.resultMetaXdr);
  console.log("resultXdr:", tx.resultXdr);
});

# async getTransactions(request) → {Promise.<Api.GetTransactionsResponse>}

Parameters:

See:

• https://developers.stellar.org/docs/data/rpc/api-reference/methods/getTransactions

View Source lib/rpc/server.js, line 483

Example

server.getTransactions({
  startLedger: 10000,
  limit: 10,
}).then((response) => {
  console.log("Transactions:", response.transactions);
  console.log("Latest Ledger:", response.latestLedger);
  console.log("Cursor:", response.cursor);
});

# async getVersionInfo() → {Promise.<Api.GetVersionInfoResponse>}

See:

• https://developers.stellar.org/docs/data/rpc/api-reference/methods/getVersionInfo

View Source lib/rpc/server.js, line 870

# async pollTransaction(hash) → {Promise.<Api.GetTransactionsResponse>}

Parameters:

View Source lib/rpc/server.js, line 402

Example

const h = "c4515e3bdc0897f21cc5dbec8c82cf0a936d4741cb74a8e158eb51b9fb00411a";
const txStatus = await server.pollTransaction(h, {
   attempts: 100, // I'm a maniac
   sleepStrategy: rpc.LinearSleepStrategy
}); // this will take 5,050 seconds to complete

# async prepareTransaction(tx) → {Promise.<(Transaction|FeeBumpTransaction)>}

Parameters:

See:

• module:rpc.assembleTransaction
• simulateTransaction docs

View Source lib/rpc/server.js, line 738

Example

const contractId = 'CA3D5KRYM6CB7OWQ6TWYRR3Z4T7GNZLKERYNZGGA5SOAOPIFY6YQGAXE';
const contract = new StellarSdk.Contract(contractId);

// Right now, this is just the default fee for this example.
const fee = StellarSdk.BASE_FEE;
const transaction = new StellarSdk.TransactionBuilder(account, { fee })
  // Uncomment the following line to build transactions for the live network. Be
  // sure to also change the horizon hostname.
  //.setNetworkPassphrase(StellarSdk.Networks.PUBLIC)
  .setNetworkPassphrase(StellarSdk.Networks.FUTURENET)
  .setTimeout(30) // valid for the next 30s
  // Add an operation to call increment() on the contract
  .addOperation(contract.call("increment"))
  .build();

const preparedTransaction = await server.prepareTransaction(transaction);

// Sign this transaction with the secret key
// NOTE: signing is transaction is network specific. Test network transactions
// won't work in the public network. To switch networks, use the Network object
// as explained above (look for StellarSdk.Network).
const sourceKeypair = StellarSdk.Keypair.fromSecret(sourceSecretKey);
preparedTransaction.sign(sourceKeypair);

server.sendTransaction(transaction).then(result => {
  console.log("hash:", result.hash);
  console.log("status:", result.status);
  console.log("errorResultXdr:", result.errorResultXdr);
});

# async requestAirdrop(address, friendbotUrlopt) → {Promise.<Account>}

Parameters:

See:

• Friendbot docs
• module:Friendbot.Api.Response

View Source lib/rpc/server.js, line 829

Example

server
   .requestAirdrop("GBZC6Y2Y7Q3ZQ2Y4QZJ2XZ3Z5YXZ6Z7Z2Y4QZJ2XZ3Z5YXZ6Z7Z2Y4")
   .then((accountCreated) => {
     console.log("accountCreated:", accountCreated);
   }).catch((error) => {
     console.error("error:", error);
   });

# async sendTransaction(transaction) → {Promise.<Api.SendTransactionResponse>}

Parameters:

See:

• transaction docs
• sendTransaction docs

View Source lib/rpc/server.js, line 791

Example

const contractId = 'CA3D5KRYM6CB7OWQ6TWYRR3Z4T7GNZLKERYNZGGA5SOAOPIFY6YQGAXE';
const contract = new StellarSdk.Contract(contractId);

// Right now, this is just the default fee for this example.
const fee = StellarSdk.BASE_FEE;
const transaction = new StellarSdk.TransactionBuilder(account, { fee })
  // Uncomment the following line to build transactions for the live network. Be
  // sure to also change the horizon hostname.
  //.setNetworkPassphrase(StellarSdk.Networks.PUBLIC)
  .setNetworkPassphrase(StellarSdk.Networks.FUTURENET)
  .setTimeout(30) // valid for the next 30s
  // Add an operation to call increment() on the contract
  .addOperation(contract.call("increment"))
  .build();

// Sign this transaction with the secret key
// NOTE: signing is transaction is network specific. Test network transactions
// won't work in the public network. To switch networks, use the Network object
// as explained above (look for StellarSdk.Network).
const sourceKeypair = StellarSdk.Keypair.fromSecret(sourceSecretKey);
transaction.sign(sourceKeypair);

server.sendTransaction(transaction).then((result) => {
  console.log("hash:", result.hash);
  console.log("status:", result.status);
  console.log("errorResultXdr:", result.errorResultXdr);
});

# async simulateTransaction(tx) → {Promise.<Api.SimulateTransactionResponse>}

Parameters:

See:

• transaction docs
• simulateTransaction docs
• module:rpc.Server#prepareTransaction
• module:rpc.assembleTransaction

View Source lib/rpc/server.js, line 652

Example

const contractId = 'CA3D5KRYM6CB7OWQ6TWYRR3Z4T7GNZLKERYNZGGA5SOAOPIFY6YQGAXE';
const contract = new StellarSdk.Contract(contractId);

// Right now, this is just the default fee for this example.
const fee = StellarSdk.BASE_FEE;
const transaction = new StellarSdk.TransactionBuilder(account, { fee })
  // Uncomment the following line to build transactions for the live network. Be
  // sure to also change the horizon hostname.
  //.setNetworkPassphrase(StellarSdk.Networks.PUBLIC)
  .setNetworkPassphrase(StellarSdk.Networks.FUTURENET)
  .setTimeout(30) // valid for the next 30s
  // Add an operation to call increment() on the contract
  .addOperation(contract.call("increment"))
  .build();

server.simulateTransaction(transaction).then((sim) => {
  console.log("cost:", sim.cost);
  console.log("result:", sim.result);
  console.log("error:", sim.error);
  console.log("latestLedger:", sim.latestLedger);
});

# GetEventsRequest

Properties:

View Source lib/rpc/server.js, line 43

# Options

Properties:

View Source lib/rpc/server.js, line 56

# ResourceLeeway

Properties:

View Source lib/rpc/server.js, line 51