stelar-sdk 12.3.0

package/lib/rpc/server.d.ts

@@ -0,0 +1,514 @@
+import URI from 'urijs';
+import { Account, Address, Contract, FeeBumpTransaction, Transaction, xdr } from '@stellar/stellar-base';
+import { Api } from './api';
+export declare const SUBMIT_TRANSACTION_TIMEOUT: number;
+/** Specifies the durability namespace of contract-related ledger entries. */
+export declare enum Durability {
+    Temporary = "temporary",
+    Persistent = "persistent"
+}
+export declare namespace Server {
+    /** Describes the complex filter combinations available for event queries. */
+    interface GetEventsRequest {
+        filters: Api.EventFilter[];
+        startLedger?: number;
+        cursor?: string;
+        limit?: number;
+    }
+    /** Describes additional resource leeways for transaction simulation. */
+    interface ResourceLeeway {
+        cpuInstructions: number;
+    }
+    interface Options {
+        allowHttp?: boolean;
+        timeout?: number;
+        headers?: Record<string, string>;
+    }
+}
+/**
+ * Handles the network connection to a Soroban RPC instance, exposing an
+ * interface for requests to that instance.
+ *
+ * @class
+ *
+ * @param {string} serverURL Soroban-RPC Server URL (ex.
+ *    `http://localhost:8000/soroban/rpc`).
+ * @param {object} [opts] Options object
+ * @param {boolean} [opts.allowHttp]  allows connecting to insecure http servers
+ *    (default: `false`). This must be set to false in production deployments!
+ *    You can also use {@link Config} class to set this globally.
+ * @param {Record<string, string>} [opts.headers] allows setting custom headers
+ *
+ * @see https://soroban.stellar.org/api/methods
+ */
+export declare class Server {
+    /** Soroban RPC Server URL (ex. `http://localhost:8000/soroban/rpc`). */
+    readonly serverURL: URI;
+    constructor(serverURL: string, opts?: Server.Options);
+    /**
+     * Fetch a minimal set of current info about a Stellar account.
+     *
+     * Needed to get the current sequence number for the account so you can build
+     * a successful transaction with {@link TransactionBuilder}.
+     *
+     * @param {string} address - The public address of the account to load.
+     *
+     * @returns {Promise<Account>}  a promise to the {@link Account} object with
+     *    a populated sequence number
+     *
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getLedgerEntries
+     * @example
+     * const accountId = "GBZC6Y2Y7Q3ZQ2Y4QZJ2XZ3Z5YXZ6Z7Z2Y4QZJ2XZ3Z5YXZ6Z7Z2Y4";
+     * server.getAccount(accountId).then((account) => {
+     *   console.log("sequence:", account.sequence);
+     * });
+     */
+    getAccount(address: string): Promise<Account>;
+    /**
+     * General node health check.
+     *
+     * @returns {Promise<Api.GetHealthResponse>}   a promise to the
+     *    {@link Api.GetHealthResponse} object with the status of the
+     *    server (e.g. "healthy").
+     *
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getHealth
+     * @example
+     * server.getHealth().then((health) => {
+     *   console.log("status:", health.status);
+     * });
+     */
+    getHealth(): Promise<Api.GetHealthResponse>;
+    /**
+     * Reads the current value of contract data ledger entries directly.
+     *
+     * Allows you to directly inspect the current state of a contract. This is a
+     * backup way to access your contract data which may not be available via
+     * events or {@link Server.simulateTransaction}.
+     * Warning: If the data entry in question is a 'temporary' entry, it's
+     *    entirely possible that it has expired out of existence.
+     *
+     * @param {string|Address|Contract} contract    the contract ID containing the
+     *    data to load as a strkey (`C...` form), a {@link Contract}, or an
+     *    {@link Address} instance
+     * @param {xdr.ScVal} key   the key of the contract data to load
+     * @param {Durability} [durability=Durability.Persistent]   the "durability
+     *    keyspace" that this ledger key belongs to, which is either 'temporary'
+     *    or 'persistent' (the default), see {@link Durability}.
+     *
+     * @returns {Promise<Api.LedgerEntryResult>}   the current data value
+     *
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getLedgerEntries
+     * @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);
+     * });
+     */
+    getContractData(contract: string | Address | Contract, key: xdr.ScVal, durability?: Durability): Promise<Api.LedgerEntryResult>;
+    /**
+     * Retrieves the WASM bytecode for a given contract.
+     *
+     * This method allows you to fetch the WASM bytecode associated with a contract
+     * deployed on the Soroban network. The WASM bytecode represents the executable
+     * code of the contract.
+     *
+     * @param {string} contractId    the contract ID containing the
+     *    WASM bytecode to retrieve
+     *
+     * @returns {Promise<Buffer>}   a Buffer containing the WASM bytecode
+     *
+     * @throws {Error} If the contract or its associated WASM bytecode cannot be
+     *    found on the network.
+     *
+     * @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);
+     * });
+     */
+    getContractWasmByContractId(contractId: string): Promise<Buffer>;
+    /**
+     * Retrieves the WASM bytecode for a given contract hash.
+     *
+     * This method allows you to fetch the WASM bytecode associated with a contract
+     * deployed on the Soroban network using the contract's WASM hash. The WASM bytecode
+     * represents the executable code of the contract.
+     *
+     * @param {Buffer} wasmHash    the WASM hash of the contract
+     *
+     * @returns {Promise<Buffer>}   a Buffer containing the WASM bytecode
+     *
+     * @throws {Error} If the contract or its associated WASM bytecode cannot be
+     *    found on the network.
+     *
+     * @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);
+     * });
+     */
+    getContractWasmByHash(wasmHash: Buffer | string, format?: undefined | "hex" | "base64"): Promise<Buffer>;
+    /**
+     * Reads the current value of arbitrary ledger entries directly.
+     *
+     * Allows you to directly inspect the current state of contracts, contract's
+     * code, accounts, or any other ledger entries.
+     *
+     * To fetch a contract's WASM byte-code, built the appropriate
+     * {@link xdr.LedgerKeyContractCode} ledger entry key (or see
+     * {@link Contract.getFootprint}).
+     *
+     * @param {xdr.ScVal[]} keys  one or more ledger entry keys to load
+     *
+     * @returns {Promise<Api.GetLedgerEntriesResponse>}  the current
+     *    on-chain values for the given ledger keys
+     *
+     * @see Server._getLedgerEntries
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getLedgerEntries
+     * @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);
+     * });
+     */
+    getLedgerEntries(...keys: xdr.LedgerKey[]): Promise<Api.GetLedgerEntriesResponse>;
+    _getLedgerEntries(...keys: xdr.LedgerKey[]): Promise<Api.RawGetLedgerEntriesResponse>;
+    /**
+     * Fetch the details of a submitted transaction.
+     *
+     * After submitting a transaction, clients should poll this to tell when the
+     * transaction has completed.
+     *
+     * @param {string} hash   hex-encoded hash of the transaction to check
+     *
+     * @returns {Promise<Api.GetTransactionResponse>}  the status,
+     *    result, and other details about the transaction
+     *
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getTransaction
+     * @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);
+     * });
+     */
+    getTransaction(hash: string): Promise<Api.GetTransactionResponse>;
+    _getTransaction(hash: string): Promise<Api.RawGetTransactionResponse>;
+    /**
+     * Fetch transactions starting from a given start ledger or a cursor. The end ledger is the latest ledger
+     * in that RPC instance.
+     *
+     * @param {Api.GetTransactionsRequest} request - The request parameters.
+     * @returns {Promise<Api.GetTransactionsResponse>} - A promise that resolves to the transactions response.
+     *
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getTransactions
+     * @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);
+     * });
+     */
+    getTransactions(request: Api.GetTransactionsRequest): Promise<Api.GetTransactionsResponse>;
+    private _getTransactions;
+    /**
+     * Fetch all events that match a given set of filters.
+     *
+     * The given filters (see {@link Api.EventFilter} for detailed fields)
+     * are combined only in a logical OR fashion, and all of the fields in each
+     * filter are optional.
+     *
+     * To page through events, use the `pagingToken` field on the relevant
+     * {@link Api.EventResponse} object to set the `cursor` parameter.
+     *
+     * @param {Server.GetEventsRequest} request   event filters
+     * @returns {Promise<Api.GetEventsResponse>}   a paginatable set of the
+     *    events matching the given event filters
+     *
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getEvents
+     * @example
+     * server.getEvents({
+     *    startLedger: 1000,
+     *    filters: [
+     *     {
+     *      type: "contract",
+     *      contractIds: [ "deadb33f..." ],
+     *      topics: [[ "AAAABQAAAAh0cmFuc2Zlcg==", "AAAAAQB6Mcc=", "*" ]]
+     *     }, {
+     *      type: "system",
+     *      contractIds: [ "...c4f3b4b3..." ],
+     *      topics: [[ "*" ], [ "*", "AAAAAQB6Mcc=" ]]
+     *     }, {
+     *      contractIds: [ "...c4f3b4b3..." ],
+     *      topics: [[ "AAAABQAAAAh0cmFuc2Zlcg==" ]]
+     *     }, {
+     *      type: "diagnostic",
+     *      topics: [[ "AAAAAQB6Mcc=" ]]
+     *     }
+     *    ],
+     *    limit: 10,
+     * });
+     */
+    getEvents(request: Server.GetEventsRequest): Promise<Api.GetEventsResponse>;
+    _getEvents(request: Server.GetEventsRequest): Promise<Api.RawGetEventsResponse>;
+    /**
+     * Fetch metadata about the network this Soroban RPC server is connected to.
+     *
+     * @returns {Promise<Api.GetNetworkResponse>}  metadata about the
+     *    current network this RPC server is connected to
+     *
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getNetwork
+     * @example
+     * server.getNetwork().then((network) => {
+     *   console.log("friendbotUrl:", network.friendbotUrl);
+     *   console.log("passphrase:", network.passphrase);
+     *   console.log("protocolVersion:", network.protocolVersion);
+     * });
+     */
+    getNetwork(): Promise<Api.GetNetworkResponse>;
+    /**
+     * Fetch the latest ledger meta info from network which this Soroban RPC
+     * server is connected to.
+     *
+     * @returns {Promise<Api.GetLatestLedgerResponse>}   metadata about the
+     *    latest ledger on the network that this RPC server is connected to
+     *
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getLatestLedger
+     * @example
+     * server.getLatestLedger().then((response) => {
+     *   console.log("hash:", response.id);
+     *   console.log("sequence:", response.sequence);
+     *   console.log("protocolVersion:", response.protocolVersion);
+     * });
+     */
+    getLatestLedger(): Promise<Api.GetLatestLedgerResponse>;
+    /**
+     * Submit a trial contract invocation to get back return values, expected
+     * ledger footprint, expected authorizations, and expected costs.
+     *
+     * @param {Transaction | FeeBumpTransaction} tx the transaction to
+     *    simulate, which should include exactly one operation (one of
+     *    {@link xdr.InvokeHostFunctionOp}, {@link xdr.ExtendFootprintTTLOp}, or
+     *    {@link xdr.RestoreFootprintOp}). Any provided footprint or auth
+     *    information will be ignored.
+     *
+     * @returns {Promise<Api.SimulateTransactionResponse>}   an object with the
+     *    cost, footprint, result/auth requirements (if applicable), and error of
+     *    the transaction
+     *
+     * @see https://developers.stellar.org/docs/glossary/transactions/
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/simulateTransaction
+     * @see Server.prepareTransaction
+     * @see assembleTransaction
+     *
+     * @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);
+     * });
+     */
+    simulateTransaction(tx: Transaction | FeeBumpTransaction, addlResources?: Server.ResourceLeeway): Promise<Api.SimulateTransactionResponse>;
+    _simulateTransaction(transaction: Transaction | FeeBumpTransaction, addlResources?: Server.ResourceLeeway): Promise<Api.RawSimulateTransactionResponse>;
+    /**
+     * Submit a trial contract invocation, first run a simulation of the contract
+     * invocation as defined on the incoming transaction, and apply the results to
+     * a new copy of the transaction which is then returned. Setting the ledger
+     * footprint and authorization, so the resulting transaction is ready for
+     * signing & sending.
+     *
+     * The returned transaction will also have an updated fee that is the sum of
+     * fee set on incoming transaction with the contract resource fees estimated
+     * from simulation. It is adviseable to check the fee on returned transaction
+     * and validate or take appropriate measures for interaction with user to
+     * confirm it is acceptable.
+     *
+     * You can call the {@link Server.simulateTransaction} method directly first
+     * if you want to inspect estimated fees for a given transaction in detail
+     * first, then re-assemble it manually or via {@link assembleTransaction}.
+     *
+     * @param {Transaction | FeeBumpTransaction} tx  the transaction to
+     *    prepare. It should include exactly one operation, which must be one of
+     *    {@link xdr.InvokeHostFunctionOp}, {@link xdr.ExtendFootprintTTLOp},
+     *    or {@link xdr.RestoreFootprintOp}.
+     *
+     *    Any provided footprint will be overwritten. However, if your operation
+     *    has existing auth entries, they will be preferred over ALL auth entries
+     *    from the simulation. In other words, if you include auth entries, you
+     *    don't care about the auth returned from the simulation. Other fields
+     *    (footprint, etc.) will be filled as normal.
+     *
+     * @returns {Promise<Transaction | FeeBumpTransaction>}   a copy of the
+     *    transaction with the expected authorizations (in the case of
+     *    invocation), resources, and ledger footprints added. The transaction fee
+     *    will also automatically be padded with the contract's minimum resource
+     *    fees discovered from the simulation.
+     *
+     * @see assembleTransaction
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/simulateTransaction
+     * @throws {jsonrpc.Error<any>|Error|Api.SimulateTransactionErrorResponse}
+     *    if simulation fails
+     * @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);
+     * });
+     */
+    prepareTransaction(tx: Transaction | FeeBumpTransaction): Promise<Transaction<import("@stellar/stellar-base").Memo<import("@stellar/stellar-base").MemoType>, import("@stellar/stellar-base").Operation[]>>;
+    /**
+     * Submit a real transaction to the Stellar network.
+     *
+     * Unlike Horizon, Soroban RPC does not wait for transaction completion. It
+     * simply validates the transaction and enqueues it. Clients should call
+     * {@link Server.getTransactionStatus} to learn about transaction
+     * success/failure.
+     *
+     * @param {Transaction | FeeBumpTransaction} transaction  to submit
+     * @returns {Promise<Api.SendTransactionResponse>}   the
+     *    transaction id, status, and any error if available
+     *
+     * @see https://developers.stellar.org/docs/glossary/transactions/
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/sendTransaction
+     * @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);
+     * });
+     */
+    sendTransaction(transaction: Transaction | FeeBumpTransaction): Promise<Api.SendTransactionResponse>;
+    _sendTransaction(transaction: Transaction | FeeBumpTransaction): Promise<Api.RawSendTransactionResponse>;
+    /**
+     * Fund a new account using the network's friendbot faucet, if any.
+     *
+     * @param {string | Account} address  the address or account instance that we
+     *    want to create and fund with friendbot
+     * @param {string} [friendbotUrl]     optionally, an explicit address for
+     *    friendbot (by default: this calls the Soroban RPC
+     *    {@link Server.getNetwork} method to try to discover this network's
+     *    Friendbot url).
+     *
+     * @returns {Promise<Account>}  an {@link Account} object for the created
+     *    account, or the existing account if it's already funded with the
+     *    populated sequence number (note that the account will not be "topped
+     *    off" if it already exists)
+     *
+     * @throws if Friendbot is not configured on this network or request failure
+     *
+     * @see
+     * https://developers.stellar.org/docs/fundamentals-and-concepts/testnet-and-pubnet#friendbot
+     * @see Friendbot.Response
+     * @example
+     * server
+     *    .requestAirdrop("GBZC6Y2Y7Q3ZQ2Y4QZJ2XZ3Z5YXZ6Z7Z2Y4QZJ2XZ3Z5YXZ6Z7Z2Y4")
+     *    .then((accountCreated) => {
+     *      console.log("accountCreated:", accountCreated);
+     *    }).catch((error) => {
+     *      console.error("error:", error);
+     *    });
+     */
+    requestAirdrop(address: string | Pick<Account, 'accountId'>, friendbotUrl?: string): Promise<Account>;
+    /**
+     * Provides an analysis of the recent fee stats for regular and smart
+     * contract operations.
+     *
+     * @returns {Promise<Api.GetFeeStatsResponse>}  the fee stats
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getFeeStats
+     */
+    getFeeStats(): Promise<Api.GetFeeStatsResponse>;
+    /**
+     * Provides information about the current version details of the Soroban RPC and captive-core
+     *
+     * @returns {Promise<Api.GetVersionInfoResponse>} the version info
+     * @see https://developers.stellar.org/docs/data/rpc/api-reference/methods/getVersionInfo
+     */
+    getVersionInfo(): Promise<Api.GetVersionInfoResponse>;
+}