@xchainjs/xchain-solana 0.0.1

package/README.md

@@ -0,0 +1,75 @@
+<div align="center">
+  <h1 align="center">Solana client</h1>
+
+  <p align="center">
+    <a href='https://www.npmjs.com/package/@xchainjs/xchain-solana' target='_blank'>
+      <img alt="NPM Version" src="https://img.shields.io/npm/v/%40xchainjs%2Fxchain-solana" />
+    </a>
+      <a href='https://www.npmjs.com/package/@xchainjs/xchain-solana' target='_blank'>
+      <img alt="NPM Downloads" src="https://img.shields.io/npm/d18m/%40xchainjs%2Fxchain-solana" />
+    </a>
+  </p>
+</div>
+
+<br />
+
+Client that allows to perform operations on the Solana blockchain abstracting developers from its particularities, thus allowing developers to focus on their projects. The Solana client is built on top of [@solana/web3.js](https://github.com/solana-labs/solana-web3.js) and the suite of packages developed by the [Metaplex](https://www.metaplex.com/) foundation.
+
+If you want to read more about Solana blockchain, go to its official [web site](https://solana.com/)
+
+
+## Installation
+
+```sh
+yarn add @xchainjs/xchain-solana
+```
+or 
+
+```sh
+npm install @xchainjs/xchain-solana
+```
+
+## Initialization
+
+Using the Solana client you can initialize the main class of the module in consultation mode if you do not provide any parameters, this means you could retrieve information from the blockchain and prepare transactions to sign, but you will not be able to sign transactions, or generate addresses.
+
+```ts
+import { Client } from '@xchainjs/xchain-solana'
+
+const client = new Client()
+
+// Make read operations with your client
+```
+
+Otherwise, if you want to sign transactions and get the addresses you own, you will need to initialize the main class of the protocol as follows
+
+```ts
+import { Client, defaultSolanaParams } from '@xchainjs/xchain-solana'
+
+const client = new Client({
+  phrase: 'your secret phrase',
+  ...defaultSolanaParams
+})
+
+// Make read or write operations with your client
+```
+
+##  Features
+
+Thanks to the Solana client you will be able to:
+- Get the Solana and tokens balances that an address owns
+- Generate addresses given a secret phrase
+- Transfer Solana and tokens to another address
+- Get details of a transaction
+- Get address transaction history
+
+
+
+## Examples
+
+You can find examples using the Solana package in the [solana](https://github.com/xchainjs/xchainjs-lib/tree/master/examples/solana) examples folder.
+
+
+## Documentation
+
+More information about how to use the Solana client can be found on [documentation](https://xchainjs.gitbook.io/xchainjs/clients/xchain-solana)

package/lib/client.d.ts

@@ -0,0 +1,107 @@
+import { AssetInfo, BaseXChainClient, Fees, PreparedTx, TxHash, TxHistoryParams } from '@xchainjs/xchain-client';
+import { Address, TokenAsset } from '@xchainjs/xchain-util';
+import { Balance, SOLClientParams, Tx, TxParams, TxsPage } from './types';
+export declare class Client extends BaseXChainClient {
+    private explorerProviders;
+    private connection;
+    private umi;
+    constructor(params?: SOLClientParams);
+    /**
+     * Get information about the native asset of the Solana.
+     *
+     * @returns {AssetInfo} Information about the native asset.
+     */
+    getAssetInfo(): AssetInfo;
+    /**
+     * Get the explorer URL.
+     *
+     * @returns {string} The explorer URL.
+     */
+    getExplorerUrl(): string;
+    /**
+     * Get the explorer url for the given address.
+     *
+     * @param {Address} address
+     * @returns {string} The explorer url for the given address.
+     */
+    getExplorerAddressUrl(address: Address): string;
+    /**
+     * Get the explorer url for the given transaction id.
+     *
+     * @param {string} txID
+     * @returns {string} The explorer url for the given transaction id.
+     */
+    getExplorerTxUrl(txID: TxHash): string;
+    /**
+     * Get the full derivation path based on the wallet index.
+     * @param {number} walletIndex The HD wallet index
+     * @returns {string} The full derivation path
+     */
+    getFullDerivationPath(walletIndex: number): string;
+    /**
+     * Get the current address asynchronously.
+     *
+     * @param {number} index The index of the address. Default 0
+     * @returns {Address} The Solana address related to the index provided.
+     * @throws {"Phrase must be provided"} Thrown if the phrase has not been set before.
+     */
+    getAddressAsync(index?: number): Promise<string>;
+    /**
+     * Get the current address synchronously.
+     * @deprecated
+     */
+    getAddress(): string;
+    /**
+     * Validate the given Solana address.
+     * @param {string} address Solana address to validate.
+     * @returns {boolean} `true` if the address is valid, `false` otherwise.
+     */
+    validateAddress(address: Address): boolean;
+    /**
+     * Retrieves the balance of a given address.
+     * @param {Address} address - The address to retrieve the balance for.
+     * @param {TokenAsset[]} assets - Assets to retrieve the balance for (optional).
+     * @returns {Promise<Balance[]>} An array containing the balance of the address.
+     */
+    getBalance(address: Address, assets?: TokenAsset[]): Promise<Balance[]>;
+    /**
+     * Get transaction fees.
+     *
+     * @param {TxParams} params - The transaction parameters.
+     * @returns {Fees} The average, fast, and fastest fees.
+     * @throws {"Params need to be passed"} Thrown if parameters are not provided.
+     */
+    getFees(params?: TxParams): Promise<Fees>;
+    /**
+     * Get the transaction details of a given transaction ID.
+     *
+     * @param {string} txId The transaction ID.
+     * @returns {Tx} The transaction details.
+     */
+    getTransactionData(txId: string): Promise<Tx>;
+    getTransactions(params?: TxHistoryParams): Promise<TxsPage>;
+    /**
+     * Transfers SOL or Solana token
+     *
+     * @param {TxParams} params The transfer options.
+     * @returns {TxHash} The transaction hash.
+     */
+    transfer({ walletIndex, recipient, asset, amount, memo, limit, priorityFee, }: TxParams): Promise<string>;
+    /**
+     * Broadcast a transaction to the network
+     * @param {string} txHex Raw transaction to broadcast
+     * @returns {TxHash} The hash of the transaction broadcasted
+     */
+    broadcastTx(txHex: string): Promise<TxHash>;
+    /**
+     * Prepares a transaction for transfer.
+     *
+     * @param {TxParams&Address} params - The transfer options.
+     * @returns {Promise<PreparedTx>} The raw unsigned transaction.
+     */
+    prepareTx({ sender, recipient, asset, amount, memo, limit, priorityFee, }: TxParams & {
+        sender: Address;
+    }): Promise<PreparedTx>;
+    private getPrivateKeyPair;
+    private parseTransaction;
+}

package/lib/const.d.ts

@@ -0,0 +1,15 @@
+import { Asset } from '@xchainjs/xchain-util';
+import { SOLClientParams } from './types';
+/**
+ * Solana chain symbol
+ */
+export declare const SOLChain: "SOL";
+/**
+ * Solana native asset decimals
+ */
+export declare const SOL_DECIMALS = 9;
+/**
+ * Solana native asset
+ */
+export declare const SOLAsset: Asset;
+export declare const defaultSolanaParams: SOLClientParams;

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export { Client } from './client';
+export * from './types';
+export * from './const';