feat: added lamportsToSol (#52)

solana-foundation · Feb 24, 2025 · 9e01463 · 9e01463
1 parent 5dd8366
commit 9e01463
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/.changeset/silver-pumas-tickle.md b/.changeset/silver-pumas-tickle.md
@@ -0,0 +1,5 @@
+---
+"gill": minor
+---
+
+added `lamportsToSol` function
diff --git a/packages/gill/src/core/utils.ts b/packages/gill/src/core/utils.ts
@@ -1,7 +1,7 @@
-import type { SolanaClusterMoniker } from "../types";
-import { GENESIS_HASH } from "./const";
 import type { KeyPairSigner } from "@solana/signers";
 import type { Address } from "@solana/addresses";
+import type { SolanaClusterMoniker } from "../types";
+import { GENESIS_HASH, LAMPORTS_PER_SOL } from "./const";
 
 /**
  * Determine the Solana moniker from its genesis hash
@@ -24,3 +24,12 @@ export function getMonikerFromGenesisHash(hash: string): SolanaClusterMoniker |
 export function checkedAddress(input: KeyPairSigner | Address): Address {
   return typeof input == "string" ? input : input.address;
 }
+
+/**
+ * Convert a lamport number to the human readable string of a SOL value
+ */
+export function lamportsToSol(lamports: bigint | number): string {
+  return new Intl.NumberFormat("en-US", { maximumFractionDigits: 9 }).format(
+    Number(lamports) / LAMPORTS_PER_SOL,
+  );
+}