Cosmos
The Cosmos
class from the @moonup/moon-api
package provides methods to interact with Cosmos accounts and transactions.
Initialization
To use the Cosmos
class, you need to create an instance of it by passing an instance of the HttpClient
class to its constructor. The HttpClient
class is also part of the @moonup/moon-api
package and provides a convenient way to make HTTP requests.
Here's an example of how to create an instance of the Cosmos
class:
Methods
The Cosmos
class provides the following methods:
createCosmosAccount(data: CosmosInput, params?: RequestParams): Promise<CreateCosmosAccountData>
Creates a new Cosmos account.
data
is an object of typeCosmosInput
that contains the necessary information to create the account.params
is an optional object of typeRequestParams
that can be used to customize the request.Returns a promise that resolves to an object of type
CreateCosmosAccountData
.
Example usage:
getCosmosAccount(accountName: string, params?: RequestParams): Promise<GetCosmosAccountData>
Retrieves information about a specific Cosmos account.
accountName
is a string that represents the name of the account.params
is an optional object of typeRequestParams
that can be used to customize the request.Returns a promise that resolves to an object of type
GetCosmosAccountData
.
Example usage:
listCosmosAccounts(params?: RequestParams): Promise<ListCosmosAccountsData>
Retrieves a list of all Cosmos accounts.
params
is an optional object of typeRequestParams
that can be used to customize the request.Returns a promise that resolves to an object of type
ListCosmosAccountsData
.
Example usage:
signCosmosTransaction(accountName: string, data: CosmosTransactionInput, params?: RequestParams): Promise<SignCosmosTransactionData>
Signs a Cosmos transaction for a specific account.
accountName
is a string that represents the name of the account.data
is an object of typeCosmosTransactionInput
that contains the necessary information to sign the transaction.params
is an optional object of typeRequestParams
that can be used to customize the request.Returns a promise that resolves to an object of type
SignCosmosTransactionData
.
Example usage:
These methods can be used to perform various operations on Cosmos accounts and transactions, such as creating new accounts, retrieving account information, signing transactions, and more. The Cosmos
class is a part of the @moonup/moon-api
package, which provides a convenient way to interact with the Moon API.
Last updated