@stellar/stellar-sdk/lib/esm/base/contract.d.ts

A library for working with the Stellar network, including communication with the Horizon and Soroban RPC servers.

import { Address } from "./address.js";
import { Operation } from "./operation.js";
import xdr from "./xdr.js";
/**
 * Create a new Contract object.
 *
 * `Contract` represents a single contract in the Stellar network, embodying the
 * interface of the contract. See
 * [Contracts](https://soroban.stellar.org/docs/learn/interacting-with-contracts)
 * for more information about how contracts work in Stellar.
 */
export declare class Contract {
    private _id;
    /**
     * @param contractId - ID of the contract (ex.
     *     `CA3D5KRYM6CB7OWQ6TWYRR3Z4T7GNZLKERYNZGGA5SOAOPIFY6YQGAXE`).
     */
    constructor(contractId: string);
    /**
     * Returns Stellar contract ID as a strkey, ex.
     * `CA3D5KRYM6CB7OWQ6TWYRR3Z4T7GNZLKERYNZGGA5SOAOPIFY6YQGAXE`.
     */
    contractId(): string;
    /** Returns the ID as a strkey (C...). */
    toString(): string;
    /** Returns the wrapped address of this contract. */
    address(): Address;
    /**
     * Returns an operation that will invoke this contract call.
     *
     * @param method - name of the method to call
     * @param params - arguments to pass to the method, as an array of xdr.ScVal
     *
     * @see Operation.invokeHostFunction
     * @see Operation.invokeContractFunction
     * @see Operation.createCustomContract
     * @see Operation.createStellarAssetContract
     * @see Operation.uploadContractWasm
     */
    call(method: string, ...params: xdr.ScVal[]): xdr.Operation<Operation.InvokeHostFunction>;
    /**
     * Returns the read-only footprint entries necessary for any invocations to
     * this contract, for convenience when manually adding it to your
     * transaction's overall footprint or doing bump/restore operations.
     */
    getFootprint(): xdr.LedgerKey;
}