import Simbachain from '@simbachain/libsimba-js/src/simba/simba.js'

public class | source

Simbachain

Extends:

SimbaBase → Simbachain

libsimba API Interaction for Simbachain.com

Constructor Summary

Public Constructor
public	constructor(endpoint: string, wallet: Wallet) libsimba API Interaction for Simbachain.com

Member Summary

Public Members
public	metadata: *

Method Summary

Public Methods
public	async addFunds(): Promise<Object>
public	async callMethod(method: string, parameters: Object): Promise
public	async callMethodWithFile(method: string, parameters-: Object, files: Array<Blob\|File>): Promise<Object>
public	async getBalance(): Promise<Object>
public	async getBundleForTransaction(transactionIdOrHash: string): Promise<ReadableStream\|Blob>
public	async getBundleMetadataForTransaction(transactionIdOrHash: string): Promise<Object>
public	async getFileFromBundleByNameForTransaction(transactionIdOrHash: string, fileName: string, stream: boolean): Promise<ReadableStream\|Blob>
public	async getFileFromBundleForTransaction(transactionIdOrHash: string, fileIdx: number, stream: boolean): Promise<ReadableStream\|Blob>
public	async getMethodTransactions(method: string, parameters: Object): Promise<PagedResponse>
public	async getTransaction(transactionIdOrHash: string): Promise<Object>
public	getTransactionStatus(txnId: string): Promise<Object>
public	async getTransactions(parameters: Object): Promise<PagedResponse>

Protected Methods
protected	async sendTransactionRequest(url: URL): Promise<PagedResponse>

Private Methods
private	checkTransactionDone(txn: Object): boolean
private	checkTransactionStatus(txnId: string): Object
private	checkTransactionStatusFromObject(txn: Object): Object
private	async initialize()
private	async sendMethodRequest(url: string, formdata: object): Promise<Response>
private	async submitTxn(txnId: string, signed: string): Promise<Response>

Inherited Summary

From class SimbaBase
public	apiKey: *
public	endpoint: string
public	managementKey: *
public	metadata: {}
public	wallet: *
public abstract	addFunds(): Promise<Object>
public abstract	callMethod(method: string, parameters: Object): Promise
public abstract	callMethodWithFile(method: string, parameters: Object, files: Array<Blob\|File>): Promise<Object>
public abstract	checkTransactionStatus(txnId: string): Object
public abstract	getBalance(): Promise<Object>
public abstract	getBundleForTransaction(transactionIdOrHash: string, stream: boolean): Promise<ReadableStream\|Blob>
public abstract	getBundleMetadataForTransaction(transactionIdOrHash: string): Promise<Object>
public abstract	getFileFromBundleByNameForTransaction(transactionIdOrHash: string, fileName: string, stream: boolean): Promise<ReadableStream\|Blob>
public abstract	getFileFromBundleForTransaction(transactionIdOrHash: string, fileIdx: number, stream: boolean): Promise<ReadableStream\|Blob>
public abstract	getMethodTransactions(method: string, parameters: Object)
public abstract	getTransaction(transactionIdOrHash: string): Promise<Object>
public abstract	getTransactionStatus(txnId: string): Promise<Object>
public abstract	getTransactions(parameters: Object): Promise<PagedResponse>
public abstract	initialize()
public abstract	async sendTransactionRequest(url: URL): Promise<PagedResponse>
public	setApiKey(apiKey: string) Set the API Key to authenticate calls
public	setManagementKey(managementKey: string) Set the API Key to authenticate management calls
public	setWallet(wallet: Wallet) Set the wallet
public	waitForSuccessOrError(txnId: string, pollInterval: number): * Returns an object with 'future' and 'cancel' keys.
private	apiAuthHeaders(): {APIKEY: *, "Content-Type": string}
private abstract	checkTransactionDone(txn: Object): boolean
private abstract	checkTransactionStatusFromObject(txn: Object): Object
private	managementAuthHeaders(): {APIKEY: *, "Content-Type": string}
private	validateAnyGetCall(): boolean
private	validateCall(methodName: string, parameters: Object, files: Array): boolean
private	validateGetCall(methodName: string, parameters: Object): boolean

Public Constructors

public constructor(endpoint: string, wallet: Wallet) source

libsimba API Interaction for Simbachain.com

Override:

SimbaBase#constructor

Params:

Name	Type	Attribute	Description
endpoint	string		The endpoint of the API
wallet	Wallet	optional	an optional Wallet instance

Public Members

public metadata: * source

Override:

SimbaBase#metadata

Public Methods

public async addFunds(): Promise<Object> source

Override:

SimbaBase#addFunds

Return:

Promise<Object>

details of the txn

public async callMethod(method: string, parameters: Object): Promise source

Override:

SimbaBase#callMethod

Params:

Name	Type	Attribute	Description
method	string		the method to call
parameters	Object		the parameters for the method

Return:

Promise

a promise resolving with the transaction details

public async callMethodWithFile(method: string, parameters-: Object, files: Array<Blob|File>): Promise<Object> source

Override:

SimbaBase#callMethodWithFile

Params:

Name	Type	Attribute	Description
method	string		the method to call
parameters-	Object		the parameters for the method
files	Array<Blob\|File>		the files

Return:

Promise<Object>

a promise resolving with the transaction details

public async getBalance(): Promise<Object> source

Override:

SimbaBase#getBalance

Return:

Promise<Object>

the balance

public async getBundleForTransaction(transactionIdOrHash: string): Promise<ReadableStream|Blob> source

Override:

SimbaBase#getBundleForTransaction

Params:

Name	Type	Attribute	Description
transactionIdOrHash	string		Either a transaction ID or a transaction hash

Return:

Promise<ReadableStream|Blob>

The bundle

public async getBundleMetadataForTransaction(transactionIdOrHash: string): Promise<Object> source

Override:

SimbaBase#getBundleMetadataForTransaction

Params:

Name	Type	Attribute	Description
transactionIdOrHash	string		Either a transaction ID or a transaction hash

Return:

Promise<Object>

The bundle metadata

public async getFileFromBundleByNameForTransaction(transactionIdOrHash: string, fileName: string, stream: boolean): Promise<ReadableStream|Blob> source

Override:

SimbaBase#getFileFromBundleByNameForTransaction

Params:

Name	Type	Attribute	Description
transactionIdOrHash	string		Either a transaction ID or a transaction hash
fileName	string		The name of the file in the bundle metadata
stream	boolean		If true, returns a ReadableStream, otherwise returns a Blob

Return:

Promise<ReadableStream|Blob>

The file

public async getFileFromBundleForTransaction(transactionIdOrHash: string, fileIdx: number, stream: boolean): Promise<ReadableStream|Blob> source

Override:

SimbaBase#getFileFromBundleForTransaction

Params:

Name	Type	Attribute	Description
transactionIdOrHash	string		Either a transaction ID or a transaction hash
fileIdx	number		The index of the file in the bundle metadata
stream	boolean		If true, returns a ReadableStream, otherwise returns a Blob

Return:

Promise<ReadableStream|Blob>

The file

public async getMethodTransactions(method: string, parameters: Object): Promise<PagedResponse> source

Override:

SimbaBase#getMethodTransactions

Params:

Name	Type	Attribute	Description
method	string		The method
parameters	Object		The query parameters

Return:

Promise<PagedResponse>

A response wrapped in a PagedResponse helper

public async getTransaction(transactionIdOrHash: string): Promise<Object> source

Override:

SimbaBase#getTransaction

Params:

Name	Type	Attribute	Description
transactionIdOrHash	string		Either a transaction ID or a transaction hash

Return:

Promise<Object>

The transaction

public getTransactionStatus(txnId: string): Promise<Object> source

Override:

SimbaBase#getTransactionStatus

Params:

Name	Type	Attribute	Description
txnId	string		the transaction ID

Return:

Promise<Object>

a promise resolving with the transaction details

public async getTransactions(parameters: Object): Promise<PagedResponse> source

Override:

SimbaBase#getTransactions

Params:

Name	Type	Attribute	Description
parameters	Object		The query parameters

Return:

Promise<PagedResponse>

A response wrapped in a PagedResponse helper

Protected Methods

protected async sendTransactionRequest(url: URL): Promise<PagedResponse> source

Override:

SimbaBase#sendTransactionRequest

Params:

Name	Type	Attribute	Description
url	URL		The URL

Return:

Promise<PagedResponse>

A response wrapped in a PagedResponse helper

Private Methods

private checkTransactionDone(txn: Object): boolean source

Override:

SimbaBase#checkTransactionDone

Params:

Name	Type	Attribute	Description
txn	Object		the transaction object

Return:

boolean

is the transaction complete

private checkTransactionStatus(txnId: string): Object source

Override:

SimbaBase#checkTransactionStatus

Params:

Name	Type	Attribute	Description
txnId	string		a transaction ID

Return:

Object

an object with status details

private checkTransactionStatusFromObject(txn: Object): Object source

Override:

SimbaBase#checkTransactionStatusFromObject

Params:

Name	Type	Attribute	Description
txn	Object		a transaction object

Return:

Object

an object with status details

private async initialize() source

Override:

SimbaBase#initialize

private async sendMethodRequest(url: string, formdata: object): Promise<Response> source

Params:

Name	Type	Attribute	Description
url	string		the url
formdata	object		Formdata for the POST

Return:

Promise<Response>

The response with transaction data

private async submitTxn(txnId: string, signed: string): Promise<Response> source

Params:

Name	Type	Attribute	Description
txnId	string		the txnId
signed	string		The signed txn

Return:

Promise<Response>

The response with transaction data