@simbachain/simbats/dist/simba.d.ts

TypeScript SDK for SIMBA Chain

import { AxiosResponse } from "axios";
import { RequestHandler } from "./request_handler";
import { SimbaContract } from "./simba_contract";
/**
 * main class for interacting with SIMBA platform
 */
export declare class Simba {
    baseApiUrl: string;
    requestHandler: RequestHandler;
    constructor(baseApiUrl?: string, requestHandler?: RequestHandler);
    /**
     * generate SimbaContract class instance
     * @param appName
     * @param contractName
     * @returns {SimbaContract}
     */
    getSimbaContract(appName: string, contractName: string): SimbaContract;
    /**
     * return user information
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    whoAmI(parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * fund wallet
     * @param blockchain
     * @param address
     * @param amount
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    fund(blockchain: string, address: string, amount: string | number, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get balance from wallet
     * @param blockchain
     * @param address
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    balance(blockchain: string, address: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * set wallet - admin perms required
     * @param userID
     * @param blockchain
     * @param pub
     * @param priv
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    adminSetWallet(userID: string | number, blockchain: string, pub: string, priv: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * set wallet - no admin perms required
     * @param blockchain
     * @param pub
     * @param priv
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    setWallet(blockchain: string, pub: string, priv: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get wallet
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getWallet(parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * create organisation
     * @param name
     * @param display
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    createOrg(name: string, display: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     *
     * @param orgName
     * @param appName
     * @param display
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any> | void>}
     */
    createApp(orgName: string, appName: string, display: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any> | void>;
    /**
     * get application
     * @param orgName
     * @param appName
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getApplication(orgName: string, appName: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get transactions for application
     * @param appName
     * @param queryParams
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getApplicationTransactions(appName: string, queryParams?: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get contract from application
     * @param appName
     * @param contractName
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getApplicationContract(appName: string, contractName: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get transactions for contract
     * @param appName
     * @param contractName
     * @param queryParams
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getContractTransactions(appName: string, contractName: string, queryParams?: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get contracts for application
     * @param appName
     * @param queryParams
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getContracts(appName: string, queryParams?: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * validate bundleHash
     * @param appName
     * @param contractName
     * @param bundleHash
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    validateBundleHash(appName: string, contractName: string, bundleHash: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get bundle from bundleHash and contractName and appName
     * @param appName
     * @param contractName
     * @param bundleHash
     * @param downloadLocation
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any> | unknown>}
     */
    getBundle(appName: string, contractName: string, bundleHash: string, downloadLocation: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any> | unknown>;
    /**
     * get file from fileName, bundleHash, contractName, and appName
     * @param appName
     * @param contractName
     * @param bundleHash
     * @param fileName
     * @param downloadLocation
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any> | unknown>}
     */
    getBundleFile(appName: string, contractName: string, bundleHash: string, fileName: string, downloadLocation: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any> | unknown>;
    /**
     * get manifest for bundle from bundleHash
     * @param appName
     * @param contractName
     * @param bundleHash
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getManifestForBundleFromBundleHash(appName: string, contractName: string, bundleHash: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get contract info from contractName and appName
     * @param appName
     * @param contractName
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getContractInfo(appName: string, contractName: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get events from appName, contractName, and eventName
     * @param appName
     * @param contractName
     * @param eventName
     * @param queryParams
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getEvents(appName: string, contractName: string, eventName: string, queryParams?: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get events - admin perms required
     * @param queryParams
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    adminGetEvents(queryParams?: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get receipt from appName, contractName, and receiptHash
     * @param appName
     * @param contractName
     * @param receiptHash
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getReceipt(appName: string, contractName: string, receiptHash: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get transaction from appName, contractName, and transactionHash
     * @param appName
     * @param contractName
     * @param transactionHash
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getTransaction(appName: string, contractName: string, transactionHash: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get transactions by method
     * @param appName
     * @param contractName
     * @param methodName
     * @param queryParams
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getTransactionsByMethod(appName: string, contractName: string, methodName: string, queryParams?: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get transactions by contract
     * @param appName
     * @param contractName
     * @param queryParams
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getTransactionsByContract(appName: string, contractName: string, queryParams?: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * submit contract method
     * @param appName
     * @param contractName
     * @param methodName
     * @param inputs
     * @param filePaths
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    submitContractMethod(appName: string, contractName: string, methodName: string, inputs?: Record<any, any>, filePaths?: Array<any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * submit contract method synchronously
     * @param appName
     * @param contractName
     * @param methodName
     * @param inputs
     * @param filePaths
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    submitContractMethodSync(appName: string, contractName: string, methodName: string, inputs?: Record<any, any>, filePaths?: Array<any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * returns previous invocations of contract method
     * @param appName
     * @param contractName
     * @param methodName
     * @param args
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    callContractMethod(appName: string, contractName: string, methodName: string, args?: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * submit signed transaction for contract method
     * @param appName
     * @param txnId
     * @param txn
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    submitSignedTransaction(appName: string, txnId: string, txn: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * save contract design to SIMBA platform
     * @param orgName
     * @param name
     * @param code
     * @param designID
     * @param targetContract
     * @param libraries
     * @param encode
     * @param model
     * @param binaryTargets
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    saveDesign(orgName: string, name: string, code: string, designID?: string, targetContract?: string, libraries?: Record<any, any>, encode?: boolean, model?: string, binaryTargets?: Array<string>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * wait for deployment to be COMPLETED state
     * @param orgName
     * @param uid
     * @param totalTime
     * @param maxTime
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    waitForDeployment(orgName: string, uid: string, totalTime?: number, maxTime?: number, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * deploy contract design
     * @param orgName
     * @param appName
     * @param apiName
     * @param designID
     * @param blockchain
     * @param storage
     * @param displayName
     * @param args
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    deployDesign(orgName: string, appName: string, apiName: string, designID: string, blockchain: string, storage?: string, displayName?: string, args?: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * deploy contract artifact
     * @param orgName
     * @param appName
     * @param apiName
     * @param artifactID
     * @param blockchain
     * @param storage
     * @param displayName
     * @param args
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    deployArtifact(orgName: string, appName: string, apiName: string, artifactID: string, blockchain: string, storage?: string, displayName?: string, args?: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * wait for contract design to be COMPLETED state
     * @param orgName
     * @param appName
     * @param designID
     * @param apiName
     * @param blockchain
     * @param storage
     * @param displayName
     * @param args
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    waitForDeployDesign(orgName: string, appName: string, designID: string, apiName: string, blockchain: string, storage?: string, displayName?: string, args?: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Array<any>>;
    /**
     * wait for contract artifact to be COMPLETED state
     * @param orgName
     * @param appName
     * @param artifactID
     * @param apiName
     * @param blockchain
     * @param storage
     * @param displayName
     * @param args
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    waitForDeployArtifact(orgName: string, appName: string, artifactID: string, apiName: string, blockchain: string, storage?: string, displayName?: string, args?: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Array<any>>;
    /**
     * wait for transaction to be COMPLETED state
     * @param orgName
     * @param uid
     * @param totalTime
     * @param maxTime
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    waitForOrgTransaction(orgName: string, uid: string, totalTime?: number, maxTime?: number, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get contract designs
     * @param orgName
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getDesigns(orgName: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get blockchains for organisation
     * @param orgName
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getBlockchains(orgName: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get storages for organisation
     * @param orgName
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getStorages(orgName: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get contract artifacts for organisation
     * @param orgName
     * @param queryParams
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getArtifacts(orgName: string, queryParams?: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * get contract artifact
     * @param orgName
     * @param artifactID
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    getArtifact(orgName: string, artifactID: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * create contract artifact for organisation
     * @param orgName
     * @param designID
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    createArtifact(orgName: string, designID: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * create subscription organisation
     * @param orgName
     * @param notificationEndpoint
     * @param contractAPI
     * @param txn
     * @param subscriptionType
     * @param authType
     * @param parseDataFromResponse
     * @returns {Promise<AxiosResponse<any> | Record<any, any>>}
     */
    subscribe(orgName: string, notificationEndpoint: string, contractAPI: string, txn: string, subscriptionType: string, authType?: string, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
    /**
     * set notification config for organisation
     * @param orgName
     * @param scheme
     * @param authType
     * @param authInfo
     * @param parseDataFromResponse
     * @returns
     */
    setNotificationConfig(orgName: string, scheme: string, authType?: string, authInfo?: Record<any, any>, parseDataFromResponse?: boolean): Promise<AxiosResponse<any> | Record<any, any>>;
}
//# sourceMappingURL=simba.d.ts.map