@layerzerolabs/lz-corekit-solana 3.0.14 → 3.0.16

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @layerzerolabs/lz-corekit-solana
 
+## 3.0.16
+
+### Patch Changes
+
+- 87a4bc9: islander mainnet
+- Updated dependencies [87a4bc9]
+  - @layerzerolabs/lz-core@3.0.16
+  - @layerzerolabs/lz-utilities@3.0.16
+
+## 3.0.15
+
+### Patch Changes
+
+- 67856bd: endpoints
+- Updated dependencies [67856bd]
+  - @layerzerolabs/lz-core@3.0.15
+
 ## 3.0.14
 
 ### Patch Changes

package/README.md

@@ -1 +1,112 @@
-# @layerzerolabs/lz-corekit
+# @layerzerolabs/lz-corekit-solana
+
+The Solana CoreKit is a comprehensive SDK designed to interact with the Solana blockchain. It provides a set of utilities and modules to facilitate the development and integration of applications with the Solana blockchain.
+
+## Features
+
+- **Retrieve Account Information**: Gets the balance of the specified address.
+- **Retrieve Block Information**: Gets the block height, timestamp and related transactions of the specified block.
+- **Transaction Management**: Get, build, sign, send and confirm transactions.
+
+## Installation
+
+To install the Solana CoreKit, you can use npm or yarn:
+
+```sh
+npm install @layerzerolabs/lz-corekit-solana
+```
+
+or
+
+```sh
+yarn add @layerzerolabs/lz-corekit-solana
+```
+
+## Usage
+
+### Initialization
+
+```typescript
+import { SolanaProvider } from "@layerzerolabs/lz-corekit-solana";
+
+// url is the Solana chain full node url
+const url = "http://127.0.0.1:8899";
+const provider = SolanaProvider.from(url);
+```
+
+### Retrieve Account Information
+
+#### Get Account Balance
+
+```typescript
+import { SolanaProvider } from "@layerzerolabs/lz-corekit-solana";
+
+// url is the Solana chain full node url
+const url = "http://127.0.0.1:8899";
+const provider = SolanaProvider.from(url);
+
+const address = "0x1";
+const balance = await provider.getBalance(address);
+```
+
+### Retrieve Block Information
+
+#### Get Latest Block Height
+
+```typescript
+import { SolanaProvider } from "@layerzerolabs/lz-corekit-solana";
+
+// url is the Solana chain full node url
+const url = "http://127.0.0.1:8899";
+const provider = SolanaProvider.from(url);
+
+const number = await provider.getBlockNumber();
+```
+
+#### Get Current Slot
+
+Slot Introduction: https://www.helius.dev/blog/solana-slots-blocks-and-epochs
+
+```typescript
+import { SolanaProvider } from "@layerzerolabs/lz-corekit-solana";
+
+// url is the Solana chain full node url
+const url = "http://127.0.0.1:8899";
+const provider = SolanaProvider.from(url);
+
+const number = await provider.getSlot();
+```
+
+### Transaction Management
+
+#### Get Transaction by hash
+
+```typescript
+import { SolanaProvider } from "@layerzerolabs/lz-corekit-solana";
+
+// url is the Solana chain full node url
+const url = "http://127.0.0.1:8899";
+const provider = SolanaProvider.from(url);
+
+const hash = "0x1";
+const tx = await provider.getTransaction(hash);
+```
+
+#### Sign, Send and Confirm Transaction
+
+```typescript
+import { SolanaProvider, SolanaSigner } from '@layerzerolabs/lz-corekit-solana'
+import { SignedTransaction, TransactionReceipt, TransactionRequest } from '@layerzerolabs/lz-core'
+
+// url is the Solana chain full node url
+const url = "http://127.0.0.1:8899"
+const provider = SolanaProvider.from(url)
+
+const privateKey = '0x1234'
+const signer = SolanaSigner.from(privateKey)
+signer.connect(provider)
+
+const tx: TransactionRequest = ...
+const stx: SignedTransaction = await signer.signTransaction(tx)
+const receipt: TransactionReceipt = await signer.sendAndConfirm(stx)
+```