Dogecoin
The Dogecoin class from the @moonup/moon-api package provides methods to interact with Dogecoin accounts and transactions.
Initialization
To use the Dogecoin 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 Dogecoin class:
import { HttpClient, Dogecoin } from '@moonup/moon-api';
const http = new HttpClient({
baseUrl: 'https://beta.usemoon.ai',
securityWorker: async (securityData) => {
return {
headers: {
Authorization: `Bearer ${securityData.token}`,
},
};
},
});
const dogecoin = new Dogecoin(http);Methods
The Dogecoin class provides the following methods:
createDogeCoinAccount(data: DogeCoinInput, params?: RequestParams): Promise<CreateDogeCoinAccountData>Creates a new Dogecoin account.
datais an object of typeDogeCoinInputthat contains the necessary information to create the account.paramsis an optional object of typeRequestParamsthat can be used to customize the request.Returns a promise that resolves to an object of type
CreateDogeCoinAccountData.
Example usage:
const data = { network: 'testnet', private_key: 'private_key', }; const result = await dogecoin.createDogeCoinAccount(data); console.log(result);getDogeCoinAccount(accountName: string, params?: RequestParams): Promise<GetDogeCoinAccountData>Retrieves information about a specific Dogecoin account.
accountNameis a string that represents the name of the account.paramsis an optional object of typeRequestParamsthat can be used to customize the request.Returns a promise that resolves to an object of type
GetDogeCoinAccountData.
Example usage:
const accountName = 'my_account'; const result = await dogecoin.getDogeCoinAccount(accountName); console.log(result);listDogeCoinAccounts(params?: RequestParams): Promise<ListDogeCoinAccountsData>Retrieves a list of all Dogecoin accounts.
paramsis an optional object of typeRequestParamsthat can be used to customize the request.Returns a promise that resolves to an object of type
ListDogeCoinAccountsData.
Example usage:
const result = await dogecoin.listDogeCoinAccounts(); console.log(result);signDogeCoinTransaction(accountName: string, data: DogeCoinTransactionInput, params?: RequestParams): Promise<SignDogeCoinTransactionData>Signs a Dogecoin transaction for a specific account.
accountNameis a string that represents the name of the account.datais an object of typeDogeCoinTransactionInputthat contains the necessary information to sign the transaction.paramsis an optional object of typeRequestParamsthat can be used to customize the request.Returns a promise that resolves to an object of type
SignDogeCoinTransactionData.
Example usage:
const accountName = 'my_account'; const data = { to: 'recipient_address', value: 0.1, }; const result = await dogecoin.signDogeCoinTransaction(accountName, data); console.log(result);
These methods can be used to perform various operations on Dogecoin accounts and transactions, such as creating new accounts, retrieving account information, signing transactions, and more. The Dogecoin class is a part of the @moonup/moon-api package, which provides a convenient way to interact with the Moon API.
Last updated