Bitcoin Cash
The Bitcoincash class from the @moonup/moon-api package provides methods to interact with Bitcoin Cash accounts and transactions.
Initialization
To use the Bitcoincash 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 Bitcoincash class:
import { HttpClient, Bitcoincash } from '@moonup/moon-api';
const http = new HttpClient({
baseUrl: 'https://beta.usemoon.ai',
securityWorker: async (securityData) => {
return {
headers: {
Authorization: `Bearer ${securityData.token}`,
},
};
},
});
const bitcoincash = new Bitcoincash(http);Methods
The Bitcoincash class provides the following methods:
createBitcoinCashAccount(data: BitcoinCashInput, params?: RequestParams): Promise<CreateBitcoinCashAccountData>Creates a new Bitcoin Cash account.
datais an object of typeBitcoinCashInputthat 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
CreateBitcoinCashAccountData.
Example usage:
const data = { network: 'testnet', private_key: 'private_key', }; const result = await bitcoincash.createBitcoinCashAccount(data); console.log(result);getBitcoinCashAccount(accountName: string, params?: RequestParams): Promise<GetBitcoinCashAccountData>Retrieves information about a specific Bitcoin Cash 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
GetBitcoinCashAccountData.
Example usage:
const accountName = 'my_account'; const result = await bitcoincash.getBitcoinCashAccount(accountName); console.log(result);listBitcoinCashAccounts(params?: RequestParams): Promise<ListBitcoinCashAccountsData>Retrieves a list of all Bitcoin Cash accounts.
paramsis an optional object of typeRequestParamsthat can be used to customize the request.Returns a promise that resolves to an object of type
ListBitcoinCashAccountsData.
Example usage:
const result = await bitcoincash.listBitcoinCashAccounts(); console.log(result);signBitcoinCashTransaction(accountName: string, data: BitcoinCashTransactionInput, params?: RequestParams): Promise<SignBitcoinCashTransactionData>Signs a Bitcoin Cash transaction for a specific account.
accountNameis a string that represents the name of the account.datais an object of typeBitcoinCashTransactionInputthat 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
SignBitcoinCashTransactionData.
Example usage:
const accountName = 'my_account'; const data = { to: 'recipient_address', value: 0.1, }; const result = await bitcoincash.signBitcoinCashTransaction(accountName, data); console.log(result);
These methods can be used to perform various operations on Bitcoin Cash accounts and transactions, such as creating new accounts, retrieving account information, signing transactions, and more. The Bitcoincash class is a part of the @moonup/moon-api package, which provides a convenient way to interact with the Moon API.
Last updated