move resolver functions to name service and update interfaces

Author: kiok46

lib/interfaces/auction.ts

@@ -86,29 +86,6 @@ export interface FetchAuctionUtxosResponse
 	userUTXO: Utxo;
 }
 
-/**
- * Parameters for retrieving all active auctions.
- */
-export interface GetAuctionsParams
-{
-	/**
-   * The category of the auctions.
-   */
-	category: string;
-	/**
-   * Contracts involved in the auctions.
-   */
-	contracts: Record<string, Contract>;
-	/**
-   * Network provider for BCH network operations.
-   */
-	networkProvider: NetworkProvider;
-	/**
-   * Electrum client for protocol events.
-   */
-	electrumClient: ElectrumClient<ElectrumProtocolEvents>;
-}
-
 /**
  * Response type for retrieving all active auctions.
  */

lib/interfaces/name.ts

@@ -1,4 +1,4 @@
-import type { AddressType, Contract, NetworkProvider, Utxo } from 'cashscript';
+import type { Contract, Utxo } from 'cashscript';
 
 /**
  * Enum representing the various statuses a name can have.
@@ -56,21 +56,8 @@ export interface FetchClaimNameUtxosParams
  */
 export interface GetNameParams
 {
-	/** The category of the name. */
-	category: string;
-	/** The TLD of the name. */
-	tld: string;
 	/** The name of the name. */
 	name: string;
-	/** Additional options for the name contract. */
-	options: {
-		/** The type of address used. */
-		addressType: AddressType;
-		/** The network provider for blockchain interactions. */
-		provider: NetworkProvider;
-	};
-	/** The contract instance for the registry. */
-	registryContract: Contract;
 }
 
 /**

lib/interfaces/records.ts

@@ -46,18 +46,8 @@ export interface CreateRecordsCoreParams
  */
 export interface FetchRecordsParams
 {
-	/** The category of the records. */
-	category: string;
-	/** The TLD of the name. */
-	tld: string;
 	/** The name associated with the records. */
 	name: string;
-	options: {
-		/** The type of address used. */
-		addressType: AddressType;
-		/** The network provider for blockchain interactions. */
-		provider: NetworkProvider;
-	};
 }
 
 /**

lib/interfaces/resolver.ts

@@ -1,13 +1,9 @@
-import type { NetworkProvider } from 'cashscript';
-
 /**
  * Interface for the request parameters of the lookupAddressCore function.
  */
 export interface LookupAddressCoreParams
 {
 	address: string;
-	category: string;
-	networkProvider: NetworkProvider;
 }
 
 /**
@@ -42,13 +38,8 @@ export interface LookupAddressParams
 export interface ResolveNameCoreParams
 {
 	name: string;
-	category: string;
-	tld: string;
-	options: any;
-	electrumClient: any;
 	useElectrum?: boolean;
 	useChaingraph?: boolean;
-	chaingraphUrl?: string;
 }
 
 /**
@@ -59,7 +50,6 @@ export interface ResolveNameByElectrumParams
 	baseHeight: number;
 	token: any;
 	ownerLockingBytecode: any;
-	electrumClient: any;
 }
 
 /**
@@ -68,6 +58,4 @@ export interface ResolveNameByElectrumParams
 export interface ResolveNameByChainGraphParams
 {
 	token: any;
-	chaingraphUrl: string;
-	electrumClient: any;
 }

lib/managers/bitcann.manager.ts

@@ -1,78 +1,136 @@
-import type {
-	AddressType,
-	NetworkProvider,
-} from 'cashscript';
 import {
 	Contract,
 	ElectrumNetworkProvider,
 	TransactionBuilder,
 } from 'cashscript';
+import type {
+	AddressType,
+	NetworkProvider,
+} from 'cashscript';
+import { chaingraphURL } from '../config.js';
 import { NameService } from '../services/name.service.js';
 import { RegistryService } from '../services/registry.service.js';
 import { AuctionTransactionBuilder } from '../transactions/auction.builder.js';
 import { BidTransactionBuilder } from '../transactions/bid.builder.js';
 import { ClaimNameTransactionBuilder } from '../transactions/claim.builder.js';
-import { RecordsTransactionBuilder } from '../transactions/records.builder.js';
 import { PenalisationTransactionBuilder } from '../transactions/penalisation.builder.js';
+import { RecordsTransactionBuilder } from '../transactions/records.builder.js';
+import { AccumulationTransactionBuilder } from '../transactions/accumulation.builder.js';
+import { UtxoManager } from './utxo.manager.js';
 import {
 	constructContracts,
 	lookupAddressCore,
+	resolveNameCore,
 } from '../util/index.js';
 import type {
 	AccumulateParams,
 	CreateAuctionParams,
 	CreateBidParams,
+	CreateClaimNameParams,
 	CreateRecordsParams,
-	NameInfo,
 	GetAuctionsResponse,
 	GetRecordsParams,
 	LookupAddressParams,
 	ManagerConfig,
+	NameInfo,
 	PastAuctionResponse,
 	PenaliseDuplicateAuctionParams,
 	PenaliseIllegalAuctionParams,
 	PenalizeInvalidNameParams,
 	ResolveNameParams,
-	CreateClaimNameParams,
 } from '../interfaces/index.js';
 import { LookupAddressCoreResponse } from '../interfaces/resolver.js';
-import { resolveNameCore } from '../util/index.js';
-import { chaingraphURL } from '../config.js';
 import type { ParsedRecordsInterface } from '../util/parser.js';
-import { UtxoManager } from './utxo.manager.js';
-import { AccumulationTransactionBuilder } from '../transactions/accumulation.builder.js';
 
 
 export class BitcannManager
 {
-	// Config to build the contracts in the BitCANN system.
-	public category: string;
-	public minStartingBid: number;
-	public minBidIncreasePercentage: number;
-	public inactivityExpiryTime: number;
-	public minWaitTime: number;
-	public tld: string;
-	public creatorIncentiveAddress: string;
-	public options: { provider: NetworkProvider; addressType: AddressType };
-
-	// Network provider to use for BCH network operations.
-	public networkProvider: NetworkProvider;
-	public chaingraphUrl: string;
-
-	// Contracts in the BitCANN system.
-	public contracts: Record<string, Contract>;
-
-	public utxoManager: UtxoManager;
-	public accumulationTransactionBuilder: AccumulationTransactionBuilder;
-	public claimNameTransactionBuilder: ClaimNameTransactionBuilder;
-	public auctionTransactionBuilder: AuctionTransactionBuilder;
-	public bidTransactionBuilder: BidTransactionBuilder;
-	public recordsTransactionBuilder: RecordsTransactionBuilder;
-	public penalisationTransactionBuilder: PenalisationTransactionBuilder;
-
-	public nameService: NameService;
-	public registryService: RegistryService;
+	/**
+	 * The category of the name.
+	 */
+	private category: string;
+	/**
+	 * The minimum starting bid for the name.
+	 */
+	private minStartingBid: number;
+	/**
+	 * The minimum bid increase percentage for the name.
+	 */
+	private minBidIncreasePercentage: number;
+	/**
+	 * The inactivity expiry time before the name can be considered expired.
+	 */
+	private inactivityExpiryTime: number;
+	/**
+	 * The minimum wait time for the name.
+	 */
+	private minWaitTime: number;
+	/**
+	 * The TLD of the name.
+	 */
+	private tld: string;
+	/**
+	 * The creator incentive address for the protocol.
+	 */
+	private creatorIncentiveAddress: string;
+	/**
+	 * The options for the name contract.
+	 */
+	private options: { provider: NetworkProvider; addressType: AddressType };
+	/**
+	 * The network provider to use for BCH network operations.
+	 */
+	private networkProvider: NetworkProvider;
+	/**
+	 * The Chaingraph URL to use for lookups.
+	 */
+	private chaingraphUrl: string;
+	/**
+	 * The contracts in the BitCANN system.
+	 */
+	private contracts: Record<string, Contract>;
+	/**
+	 * The UTXO manager for builders and 
+	 */
+	private utxoManager: UtxoManager;
+	/**
+	 * The builder for accumulation transactions.
+	 */
+	private accumulationTransactionBuilder: AccumulationTransactionBuilder;
+	/**
+	 * The builder for claim name transactions.
+	 */
+	private claimNameTransactionBuilder: ClaimNameTransactionBuilder;
+	/**
+	 * The builder for auction transactions.
+	 */
+	private auctionTransactionBuilder: AuctionTransactionBuilder;
+	/**
+	 * The builder for bid transactions.
+	 */
+	private bidTransactionBuilder: BidTransactionBuilder;
+	/**
+	 * The builder for records transactions.
+	 */
+	private recordsTransactionBuilder: RecordsTransactionBuilder;
+	/**
+	 * The builder for penalisation transactions.
+	 */
+	private penalisationTransactionBuilder: PenalisationTransactionBuilder;
+	/**
+	 * The service for registry operations.
+	 */
+	private registryService: RegistryService;
+	/**
+	 * The service for name operations.
+	 */
+	private nameService: NameService;
 
+	/**
+	 * Constructs a new BitcannManager.
+	 *
+	 * @param {ManagerConfig} config - The configuration for the manager.
+	 */
 	constructor(config: ManagerConfig)
 	{
 		this.category = config.category;
@@ -168,6 +226,7 @@ export class BitcannManager
 			this.category,
 			this.tld,
 			this.options,
+			this.chaingraphUrl,
 		);
 
 		this.registryService = new RegistryService(
@@ -193,14 +252,7 @@ export class BitcannManager
 	 */
 	public async getRecords({ name }: GetRecordsParams): Promise<ParsedRecordsInterface>
 	{
-		return this.nameService.fetchRecords({
-			name,
-			category: this.category,
-			tld: this.tld,
-			options: this.options,
-			// @ts-ignore
-			electrumClient: this.networkProvider.electrum,
-		});
+		return this.nameService.fetchRecords({ name });
 	}
 
 	/**
@@ -210,13 +262,7 @@ export class BitcannManager
 	 */
 	public async getAuctions(): Promise<GetAuctionsResponse[]>
 	{
-		return this.registryService.getAuctions({
-			category: this.category,
-			networkProvider: this.networkProvider,
-			contracts: this.contracts,
-			// @ts-ignore
-			electrumClient: this.networkProvider.electrum,
-		});
+		return this.registryService.getAuctions();
 	}
 
 	/**
@@ -227,12 +273,7 @@ export class BitcannManager
 	 */
 	public async getHistory(): Promise<PastAuctionResponse[]>
 	{
-		return this.registryService.getPastAuctions({
-			category: this.category,
-			Factory: this.contracts.Factory,
-			// @ts-ignore
-			electrumClient: this.networkProvider.electrum,
-		});
+		return this.registryService.getPastAuctions();
 	}
 
 	/**
@@ -243,13 +284,7 @@ export class BitcannManager
 	 */
 	public async getName(name: string): Promise<NameInfo>
 	{
-		return this.nameService.getName({
-			name,
-			category: this.category,
-			tld: this.tld,
-			options: this.options,
-			registryContract: this.contracts.Registry,
-		});
+		return this.nameService.getName({ name });
 	}
 
 	/**
@@ -273,6 +308,7 @@ export class BitcannManager
 			options: this.options,
 			// @ts-ignore
 			electrumClient: this.networkProvider.electrum,
+			chaingraphUrl: this.chaingraphUrl,
 			useElectrum,
 			useChaingraph,
 		});