Comments and minor improvements for utils.ts

README.md

@@ -78,4 +78,31 @@ async function invoiceHasBeenPaid() {
 
 Contributions are very welcome.
 
-If you want to contribute, please open an Issue or a PR.
+If you want to contribute, please open an Issue or a PR. 
+If you open a PR, please do so from the `development` branch as the base branch. 
+
+### Version
+
+```
+* `main`
+|\
+|\ \
+| | * `hotfix`
+| |
+| * `staging`
+| |\ 
+| |\ \
+| | | * `bugfix`
+| | |
+| | * `development` 
+| | |\ 
+| | | * `feature1`
+| | | |
+| | |/
+| | *
+| | |\ 
+| | | * `feature2`
+| | |/
+| |/
+|/ (create new version)
+```

src/utils.ts

@@ -239,12 +239,42 @@ export function checkResponse(data: { error?: string; detail?: string }): void {
  }
 }
 
-/**
- * Joins URL parts into a single URL string.
- * @param parts The parts of the URL to join
- * @returns The joined URL
- */
-export function joinUrls(...parts: string[]): string {
+export function joinUrls(...parts: Array<string>): string {
  return parts.map((part) => part.replace(/(^\/+|\/+$)/g, '')).join('/');
 }
 
+export function decodeInvoice(bolt11Invoice: string): InvoiceData {
+ const invoiceData: InvoiceData = {} as InvoiceData;
+ const decodeResult = decode(bolt11Invoice);
+ invoiceData.paymentRequest = decodeResult.paymentRequest;
+ for (let i = 0; i < decodeResult.sections.length; i++) {
+ const decodedSection = decodeResult.sections[i];
+ if (decodedSection.name === 'amount') {
+ invoiceData.amountInSats = Number(decodedSection.value) / 1000;
+ invoiceData.amountInMSats = Number(decodedSection.value);
+ }
+ if (decodedSection.name === 'timestamp') {
+ invoiceData.timestamp = decodedSection.value;
+ }
+ if (decodedSection.name === 'description') {
+ invoiceData.memo = decodedSection.value;
+ }
+ if (decodedSection.name === 'expiry') {
+ invoiceData.expiry = decodedSection.value;
+ }
+ if (decodedSection.name === 'payment_hash') {
+ invoiceData.paymentHash = decodedSection.value.toString('hex');
+ }
+ }
+ return invoiceData;
+}
+
+export {
+ bigIntStringify,
+ bytesToNumber,
+ getDecodedToken,
+ getEncodedToken,
+ hexToNumber,
+ splitAmount,
+ getDefaultAmountPreference
+};