@lifestonelabs/tokensales 1.0.4 → 1.0.6

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 ______________________________________________________________
+## [1.0.6] - 2026-02-09
+### Changed
+- `buyNFT` & `burn` made ticketMasterUtxo param optional. They now fetch the correct TokenSale UTXO from the contract if one is not provided.
+        Lets the frontend manage the contract UTXO fetching themselves if they want to limit the amount of electrum calls.
+______________________________________________________________
+## [1.0.5] - 2026-02-09
+### Changed
+- `buyNFT` fixed logic so that a MintingNFT owner for the categoryID can purchase tickets for 1000sats rather than paying full price.
+        Also adjusted miner fee up to 1700sats
+______________________________________________________________
 ## [1.0.4] - 2026-02-08
 ### Changed
 - `listAvailableTickets` removed blockheight check so this will always return the NFTs of the requested categoryID on the contract.

package/README.md

@@ -5,7 +5,7 @@ A TypeScript library for interacting with TokenSales contracts on Bitcoin Cash.
 ## Installation
 
 ```bash
-npm install tokensales
+npm install @lifestonelabs/tokensales
 ```
 
 ## Signing Transactions

package/dist/functions/burn.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"burn.d.ts","sourceRoot":"","sources":["../../src/functions/burn.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAC;AAItE;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAkLtF"}
+{"version":3,"file":"burn.d.ts","sourceRoot":"","sources":["../../src/functions/burn.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAC;AAKtE;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,8BAA8B,CAAC,CA+MtF"}

package/dist/functions/buyNFT.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"buyNFT.d.ts","sourceRoot":"","sources":["../../src/functions/buyNFT.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAC;AAIxE;;;;;GAKG;AACH,wBAAsB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAoT1F"}
+{"version":3,"file":"buyNFT.d.ts","sourceRoot":"","sources":["../../src/functions/buyNFT.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,8BAA8B,EAAE,MAAM,UAAU,CAAC;AAKxE;;;;;GAKG;AACH,wBAAsB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAwV1F"}

package/dist/functions/listActiveSales.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"listActiveSales.d.ts","sourceRoot":"","sources":["../../src/functions/listActiveSales.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAIhE;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAkD7F"}
+{"version":3,"file":"listActiveSales.d.ts","sourceRoot":"","sources":["../../src/functions/listActiveSales.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAIhE;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAkD7F"}

package/dist/functions/listAllSales.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"listAllSales.d.ts","sourceRoot":"","sources":["../../src/functions/listAllSales.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAI7D;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CA+BvF"}
+{"version":3,"file":"listAllSales.d.ts","sourceRoot":"","sources":["../../src/functions/listAllSales.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAI7D;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CA+BvF"}

package/dist/functions/listAvailableTickets.d.ts

@@ -2,9 +2,9 @@ import { Utxo } from 'cashscript';
 import { ListAvailableTicketsParams } from '../types';
 /**
  * List available tickets for purchase from a TokenSale
- * Returns ALL UTXOs matching the categoryID, excluding the TokenSale NFT (minting capability)
  * @param params - ListAvailableTicketsParams object containing all required parameters
- * @returns Promise resolving to array of ticket UTXOs (excluding the TokenSale NFT)
+ * @returns Promise resolving to array of ticket UTXOs that are available for purchase
+ * @throws Error if validation fails or TokenSale is not found/active
  */
 export declare function listAvailableTickets(params: ListAvailableTicketsParams): Promise<Utxo[]>;
 //# sourceMappingURL=listAvailableTickets.d.ts.map

package/dist/functions/listAvailableTickets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"listAvailableTickets.d.ts","sourceRoot":"","sources":["../../src/functions/listAvailableTickets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAC;AAItD;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CA4C9F"}
+{"version":3,"file":"listAvailableTickets.d.ts","sourceRoot":"","sources":["../../src/functions/listAvailableTickets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAC;AAItD;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAoD9F"}

package/dist/index.esm.js

@@ -212,6 +212,61 @@ function toLittleEndianHexString(number, byteCount) {
     return hex.match(/../g)?.reverse().join('') ?? '';
 }
 
+// TokenSales_old1 contract addresses
+//export const AddressTicketMaster = 'bitcoincash:pvh0yat7d2r9nf228fpns3mypydvstq9arftt9qlmma42xeq2eryszkdd99zq';  //address hash: 2ef2757e6a8659a54a3a43384764091ac82c05e8d2b5941fdefb551b20564648
+//export const AddressTicketMasterToken = 'bitcoincash:rvh0yat7d2r9nf228fpns3mypydvstq9arftt9qlmma42xeq2eryss93vuymt';
+// TokenSales contract addresses | simplified change fee calculation in purchaseNFT()
+const AddressTicketMaster = 'bitcoincash:pdmta0t3lmeufrhjlmyxkx3ye648lvr08cdwmy36eqtkj4wzpagg2m4afvzlt'; //address hash: 76bebd71fef3c48ef2fec86b1a24ceaa7fb06f3e1aed923ac8176955c20f5085
+const AddressTicketMasterToken = 'bitcoincash:rdmta0t3lmeufrhjlmyxkx3ye648lvr08cdwmy36eqtkj4wzpagg2fxpg4rxq';
+// Ticket Level Descriptions
+const TICKET_LEVEL_DESCRIPTIONS = {
+    '01': {
+        name: 'Regular',
+        description: 'Regular tickets provide standard access to the event. This is the base level ticket option.'
+    },
+    '02': {
+        name: 'VIP',
+        description: 'VIP tickets offer enhanced benefits including priority access, exclusive areas, and additional perks.'
+    },
+    '03': {
+        name: 'Premium',
+        description: 'Premium tickets provide the highest level of access with all VIP benefits plus additional exclusive features.'
+    }
+};
+
+/**
+ * TokenSales contract addresses
+ * These are the addresses for the TokenSales (TicketMaster) contract
+ */
+const DEFAULT_CONTRACT_ADDRESSES = {
+    contract: AddressTicketMaster,
+    token: AddressTicketMasterToken
+};
+/**
+ * Get contract address
+ * @returns Contract address
+ */
+function getContractAddress() {
+    return AddressTicketMaster;
+}
+/**
+ * Get token address
+ * @returns Token address
+ */
+function getTokenAddress() {
+    return AddressTicketMasterToken;
+}
+/**
+ * Get contract addresses
+ * @returns Object with contract and token addresses
+ */
+function getContractAddresses() {
+    return {
+        contract: AddressTicketMaster,
+        token: AddressTicketMasterToken
+    };
+}
+
 var contractName = "TokenSales";
 var constructorInputs = [
 ];
@@ -522,7 +577,7 @@ var contractArtifact = {
  * @throws Error if validation fails or transaction building fails
  */
 async function buyNFT(params) {
-    const { electrumProvider, usersAddress, ticketMasterUtxo, ticketUtxo, ticketType, isAdmin } = params;
+    const { electrumProvider, usersAddress, ticketMasterUtxo: providedTicketMasterUtxo, ticketUtxo, ticketType, isAdmin } = params;
     if (!electrumProvider) {
         throw new Error('Electrum provider not available');
     }
@@ -531,6 +586,28 @@ async function buyNFT(params) {
         provider: electrumProvider,
         addressType: 'p2sh32'
     });
+    // If ticketMasterUtxo is not provided or is not a valid Utxo, fetch it from the contract
+    let ticketMasterUtxo;
+    if (providedTicketMasterUtxo?.token?.category === ticketUtxo.token?.category
+        && providedTicketMasterUtxo?.token?.nft?.capability === 'minting') {
+        ticketMasterUtxo = providedTicketMasterUtxo;
+    }
+    else {
+        // Get the contract token address
+        const contractTokenAddress = getTokenAddress();
+        // Get all UTXOs from the contract token address
+        const contractUtxos = await electrumProvider.getUtxos(contractTokenAddress);
+        // Filter to find the TicketMaster UTXO with matching category ID
+        const matchingCategoryId = ticketUtxo.token?.category;
+        if (!matchingCategoryId) {
+            throw new Error('ticketUtxo must have a token category');
+        }
+        ticketMasterUtxo = contractUtxos.find(utxo => utxo.token?.category === matchingCategoryId &&
+            utxo.token?.nft?.capability === 'minting');
+        if (!ticketMasterUtxo) {
+            throw new Error(`No TicketMaster UTXO found for category ${matchingCategoryId}`);
+        }
+    }
     // Parse TicketMaster commitment to get price and admin address
     const commitment = ticketMasterUtxo.token?.nft?.commitment || '';
     if (commitment.length !== 78) {
@@ -668,16 +745,24 @@ async function buyNFT(params) {
                     commitment: ticketUtxo.token?.nft?.commitment + ticketType // ticketType appended to commitment
                 }
             },
-        })
-            // Ticket price is sent to admin address
-            .addOutput({
-            to: adminAddress,
-            amount: ticketPrice,
         });
+        // Ticket price is sent to admin address
+        if (isAdmin) {
+            transaction.addOutput({
+                to: adminAddress,
+                amount: 1000n,
+            });
+        }
+        else {
+            transaction.addOutput({
+                to: adminAddress,
+                amount: ticketPrice,
+            });
+        }
         if (isAdmin) {
             transaction.addOutput({
                 to: userTokenAddress,
-                amount: userUTXO.satoshis - 2000n,
+                amount: userUTXO.satoshis - 2700n,
                 token: {
                     amount: userUTXO.token?.amount,
                     category: userUTXO.token?.category,
@@ -690,7 +775,7 @@ async function buyNFT(params) {
         }
         else {
             // Calculate change amount (userUTXO - ticketPrice - miner fee)
-            const changeAmount = userUTXO.satoshis - ticketPrice - 2000n;
+            const changeAmount = userUTXO.satoshis - ticketPrice - 1700n;
             if (changeAmount > 1000n) { // Dust limit
                 transaction.addOutput({
                     to: normalizedUserAddress,
@@ -967,7 +1052,7 @@ async function modifyTokenSale(params) {
  * @throws Error if validation fails or transaction building fails
  */
 async function burn(params) {
-    const { electrumProvider, usersAddress, ticketMasterUtxo, userMintingNFT, tickets } = params;
+    const { electrumProvider, usersAddress, ticketMasterUtxo: providedTicketMasterUtxo, userMintingNFT, tickets } = params;
     if (!electrumProvider) {
         throw new Error('Electrum provider not available');
     }
@@ -976,6 +1061,28 @@ async function burn(params) {
         provider: electrumProvider,
         addressType: 'p2sh32'
     });
+    // If ticketMasterUtxo is not provided or is not a valid Utxo, fetch it from the contract
+    let ticketMasterUtxo;
+    if (providedTicketMasterUtxo?.token?.category === userMintingNFT.token?.category
+        && providedTicketMasterUtxo?.token?.nft?.capability === 'minting') {
+        ticketMasterUtxo = providedTicketMasterUtxo;
+    }
+    else {
+        // Get the contract token address
+        const contractTokenAddress = getTokenAddress();
+        // Get all UTXOs from the contract token address
+        const contractUtxos = await electrumProvider.getUtxos(contractTokenAddress);
+        // Filter to find the TicketMaster UTXO with matching category ID
+        const matchingCategoryId = userMintingNFT.token?.category;
+        if (!matchingCategoryId) {
+            throw new Error('userMintingNFT must have a token category');
+        }
+        ticketMasterUtxo = contractUtxos.find(utxo => utxo.token?.category === matchingCategoryId &&
+            utxo.token?.nft?.capability === 'minting');
+        if (!ticketMasterUtxo) {
+            throw new Error(`No TicketMaster UTXO found for category ${matchingCategoryId}`);
+        }
+    }
     // Get contract address from compiled contract
     const contractAddr = ticketMasterContract.address;
     // Creating lockingBytecode for contract address
@@ -1262,28 +1369,6 @@ async function addSatoshis(params) {
     return wcTransactionObj;
 }
 
-// TokenSales_old1 contract addresses
-//export const AddressTicketMaster = 'bitcoincash:pvh0yat7d2r9nf228fpns3mypydvstq9arftt9qlmma42xeq2eryszkdd99zq';  //address hash: 2ef2757e6a8659a54a3a43384764091ac82c05e8d2b5941fdefb551b20564648
-//export const AddressTicketMasterToken = 'bitcoincash:rvh0yat7d2r9nf228fpns3mypydvstq9arftt9qlmma42xeq2eryss93vuymt';
-// TokenSales contract addresses | simplified change fee calculation in purchaseNFT()
-const AddressTicketMaster = 'bitcoincash:pdmta0t3lmeufrhjlmyxkx3ye648lvr08cdwmy36eqtkj4wzpagg2m4afvzlt'; //address hash: 76bebd71fef3c48ef2fec86b1a24ceaa7fb06f3e1aed923ac8176955c20f5085
-const AddressTicketMasterToken = 'bitcoincash:rdmta0t3lmeufrhjlmyxkx3ye648lvr08cdwmy36eqtkj4wzpagg2fxpg4rxq';
-// Ticket Level Descriptions
-const TICKET_LEVEL_DESCRIPTIONS = {
-    '01': {
-        name: 'Regular',
-        description: 'Regular tickets provide standard access to the event. This is the base level ticket option.'
-    },
-    '02': {
-        name: 'VIP',
-        description: 'VIP tickets offer enhanced benefits including priority access, exclusive areas, and additional perks.'
-    },
-    '03': {
-        name: 'Premium',
-        description: 'Premium tickets provide the highest level of access with all VIP benefits plus additional exclusive features.'
-    }
-};
-
 /**
  * Create a new TicketMaster listing
  * @param params - CreateListingParams object containing all required parameters
@@ -1423,44 +1508,11 @@ async function createListing(params) {
     return wcTransactionObj;
 }
 
-/**
- * TokenSales contract addresses
- * These are the addresses for the TokenSales (TicketMaster) contract
- */
-const DEFAULT_CONTRACT_ADDRESSES = {
-    contract: AddressTicketMaster,
-    token: AddressTicketMasterToken
-};
-/**
- * Get contract address
- * @returns Contract address
- */
-function getContractAddress() {
-    return AddressTicketMaster;
-}
-/**
- * Get token address
- * @returns Token address
- */
-function getTokenAddress() {
-    return AddressTicketMasterToken;
-}
-/**
- * Get contract addresses
- * @returns Object with contract and token addresses
- */
-function getContractAddresses() {
-    return {
-        contract: AddressTicketMaster,
-        token: AddressTicketMasterToken
-    };
-}
-
 /**
  * List available tickets for purchase from a TokenSale
- * Returns ALL UTXOs matching the categoryID, excluding the TokenSale NFT (minting capability)
  * @param params - ListAvailableTicketsParams object containing all required parameters
- * @returns Promise resolving to array of ticket UTXOs (excluding the TokenSale NFT)
+ * @returns Promise resolving to array of ticket UTXOs that are available for purchase
+ * @throws Error if validation fails or TokenSale is not found/active
  */
 async function listAvailableTickets(params) {
     const { electrumProvider, categoryID } = params;
@@ -1484,8 +1536,14 @@ async function listAvailableTickets(params) {
     if (!tokenSaleUtxo) {
         throw new Error(`No active TokenSale found for category ${categoryID}`);
     }
-    // Return all UTXOs EXCEPT the TokenSale NFT (minting capability)
-    const availableTickets = categoryUtxos.filter((utxo) => !isTicketMaster(utxo));
+    // Parse the TokenSale commitment to get endSale block height
+    const commitment = tokenSaleUtxo.token?.nft?.commitment || '';
+    const tokenSaleData = parseTicketMasterCommitment(commitment);
+    if (!tokenSaleData) {
+        throw new Error('Failed to parse TokenSale commitment');
+    }
+    // Filter to only ticket UTXOs (capability === 'none')
+    const availableTickets = categoryUtxos.filter((utxo) => isTicket(utxo, categoryID));
     return availableTickets;
 }