qvtx-developer-kit 1.0.0 → 1.2.0

package/types/index.d.ts

@@ -0,0 +1,386 @@
+/**
+ * QVTX Developer Kit - TypeScript Definitions
+ * @author QuantVestrix Tech Team (07-Tech)
+ */
+
+import { Contract, providers, Signer, BigNumber } from 'ethers';
+import Web3 from 'web3';
+
+// Network Types
+export type NetworkName = 'ethereum' | 'bsc' | 'polygon' | 'arbitrum' | 'avalanche' | 'optimism' | 'solana';
+export type Environment = 'mainnet' | 'testnet' | 'goerli' | 'sepolia' | 'mumbai' | 'fuji';
+
+export interface NetworkConfig {
+  chainId: number;
+  rpc: string;
+  name: string;
+  nativeCurrency: {
+    name: string;
+    symbol: string;
+    decimals: number;
+  };
+  blockExplorer?: string;
+}
+
+export interface QVTXConfig {
+  network?: NetworkName;
+  environment?: Environment;
+  apiKey?: string;
+  privateKey?: string;
+  rpcUrl?: string;
+  chainId?: number;
+}
+
+// Token Types
+export interface TokenInfo {
+  name: string;
+  symbol: string;
+  decimals: number;
+  totalSupply: string;
+}
+
+// Main SDK Class
+export class QVTXDeveloperKit {
+  constructor(config?: QVTXConfig);
+
+  version: string;
+  validatorId: string;
+  config: QVTXConfig;
+  web3?: Web3;
+  provider?: providers.JsonRpcProvider;
+
+  getRpcUrl(network?: NetworkName, env?: Environment): string | null;
+  initWeb3(providerUrl?: string): Promise<Web3>;
+  initEthers(providerUrl?: string): Promise<providers.JsonRpcProvider>;
+  deployContract(abi: any[], bytecode: string, constructorArgs?: any[], privateKey?: string): Promise<Contract>;
+  getTokenInfo(): TokenInfo;
+  getNetworks(): Record<NetworkName, Record<Environment, string>>;
+  getVersion(): string;
+}
+
+// Blockchain AI SDK Types
+export interface NeuralNetworkConfig {
+  layers?: number[];
+  activation?: string;
+  optimizer?: string;
+  loss?: string;
+  epochs?: number;
+  batchSize?: number;
+  useQuantumAcceleration?: boolean;
+}
+
+export interface InferenceOptions {
+  useQuantum?: boolean;
+  crossChainValidation?: boolean;
+  dnaEnhancement?: boolean;
+}
+
+export interface AIStatus {
+  qvtx_chain: {
+    chain_id: number;
+    connected: boolean;
+    ai_capable: boolean;
+  };
+  neural_engine: { active: boolean; models: number };
+  dna_computer: { active: boolean; algorithms: number };
+  quantum_processor: { active: boolean; qubits: number };
+  consensus_validator: { active: boolean; validations: number };
+  cross_chain_capabilities: {
+    enabled: boolean;
+    supported_chains: string[];
+  };
+}
+
+export class BlockchainAISDK {
+  constructor(config?: {
+    chainId?: number;
+    rpcUrl?: string;
+    apiKey?: string;
+    neuralCapacity?: number;
+    dnaConsensus?: boolean;
+    quantumComputing?: boolean;
+    crossChainAI?: boolean;
+  });
+
+  trainNeuralNetwork(networkConfig: NeuralNetworkConfig, trainingData: any): Promise<any>;
+  runInference(modelHash: string, inputData: any, options?: InferenceOptions): Promise<any>;
+  runDNAAlgorithm(algorithmType: string, parameters: any, geneticCode: string): Promise<any>;
+  transcribeNeuralPatterns(patterns: any, targetFormat?: string): Promise<any>;
+  initializeQuantumNetwork(qubits?: number): Promise<any>;
+  runQuantumAlgorithm(algorithm: string, data: any): Promise<any>;
+  orchestrateCrossChainAI(selectedChains?: string[]): Promise<any>;
+  deployAISmartContract(aiConfig: any, targetChains: string[]): Promise<any>;
+  validateQVTXConsensus(aiValidationData: any): Promise<any>;
+  generateAIConsensusProof(data: any, participants?: number): Promise<any>;
+  analyzeAIConfidenceScore(aiOutput: any, validationData: any): Promise<any>;
+  getAIStatus(): Promise<AIStatus>;
+  optimizeAISystem(optimizationType?: string): Promise<any>;
+}
+
+// Node SDK Types
+export interface DeployOptions {
+  template?: string;
+  networks?: NetworkName[];
+  parameters?: Record<string, any>;
+}
+
+export interface RewardConfig {
+  yieldStrategies?: string[];
+  rewardToken?: string;
+  autoCompound?: boolean;
+  minReward?: number;
+}
+
+export interface StoreDataResult {
+  networksCount: number;
+  distribution: Record<string, any>;
+  neuralHash: string;
+  retrievalKey: string;
+}
+
+export interface TransactionOptions {
+  type?: string;
+  amount?: number;
+  recipient?: string;
+  networks?: NetworkName[];
+  metadata?: Record<string, any>;
+}
+
+export interface ThroughputStats {
+  current: number;
+  maximum: number;
+  efficiency: string;
+  quantum_consensus: boolean;
+  neural_validation: boolean;
+}
+
+export class NodeSDK {
+  constructor(config?: {
+    chainId?: number;
+    rpcUrl?: string;
+    apiKey?: string;
+    networks?: NetworkName[];
+    infiniteThroughput?: boolean;
+    crossChainRewards?: boolean;
+    neuralStorage?: string;
+  });
+
+  deploySmartContract(options?: DeployOptions): Promise<Record<string, string>>;
+  initializeRewards(options?: RewardConfig): Promise<void>;
+  harvestRewards(networks?: NetworkName[] | 'all'): Promise<any>;
+  storeData(data: any, schema?: string): Promise<StoreDataResult>;
+  retrieveData(hash: string, schema?: string): Promise<any>;
+  queryData(query: string, networks?: NetworkName[] | 'all'): Promise<any>;
+  executeQVTXTransaction(options?: TransactionOptions): Promise<any>;
+  enableInfiniteThroughput(options?: any): Promise<boolean>;
+  getThroughputStats(): Promise<ThroughputStats>;
+  getStatus(): Promise<Record<string, any>>;
+}
+
+// Storage Types
+export interface EncryptedData {
+  encrypted: string;
+  iv: string;
+  authTag: string;
+}
+
+export interface IPFSUploadResult {
+  hash: string;
+  url: string;
+  size: number;
+}
+
+export interface NFTMetadata {
+  name: string;
+  description: string;
+  image: string;
+  attributes: Array<{
+    trait_type: string;
+    value: string | number;
+  }>;
+}
+
+export class QVTXStorage {
+  constructor(config?: {
+    provider?: string;
+    gateway?: string;
+    apiKey?: string;
+  });
+
+  hash(content: string): string;
+  uploadToIPFS(content: string | Buffer, options?: { filename?: string }): Promise<IPFSUploadResult>;
+  fetchFromIPFS(hash: string): Promise<any>;
+  createNFTMetadata(name: string, description: string, image: string, attributes?: Array<{ trait: string; value: string | number }>): NFTMetadata;
+  storeEncrypted(data: any, password: string): Promise<EncryptedData>;
+  retrieveEncrypted(encryptedData: EncryptedData, password: string): Promise<any>;
+}
+
+// Rewards Types
+export class QVTXRewards {
+  constructor(web3: Web3, contractAddress: string, abi?: any[]);
+
+  init(): Promise<this>;
+  getStake(address: string): Promise<BigNumber>;
+  getEarned(address: string): Promise<BigNumber>;
+  getTotalStaked(): Promise<BigNumber>;
+  getRewardRate(): Promise<BigNumber>;
+  stake(amount: string | BigNumber, fromAddress: string, privateKey: string): Promise<any>;
+  withdraw(amount: string | BigNumber, fromAddress: string, privateKey: string): Promise<any>;
+  claimReward(fromAddress: string, privateKey: string): Promise<any>;
+}
+
+// Solana Types
+export interface SolanaConfig {
+  network?: 'mainnet-beta' | 'devnet' | 'testnet';
+  rpcUrl?: string;
+}
+
+export class QVTXSolana {
+  constructor(config?: SolanaConfig);
+
+  connect(): Promise<void>;
+  getBalance(publicKey: string): Promise<number>;
+  transfer(fromKeypair: any, toPublicKey: string, amount: number): Promise<string>;
+  createToken(authority: any, decimals?: number): Promise<string>;
+  mintTokens(mint: string, destination: string, authority: any, amount: number): Promise<string>;
+  getTokenBalance(tokenAccount: string): Promise<number>;
+}
+
+// Direct Purchase Types
+export interface PurchaseRecord {
+  amount: string;
+  pricePaid: string;
+  paymentToken: string;
+  timestamp: Date;
+  referrer: string;
+}
+
+export interface VestingSchedule {
+  index: number;
+  totalAmount: string;
+  released: string;
+  remaining: string;
+  startTime: Date;
+  endTime: Date;
+  duration: number;
+  percentVested: number;
+}
+
+export interface PurchaseLimits {
+  minPurchase: string;
+  maxPurchase: string;
+  maxWalletPurchase: string;
+  totalSaleCap: string;
+  totalSold: string;
+  remainingSupply: string;
+}
+
+export interface WalletInfo {
+  totalPurchased: string;
+  remainingAllocation: string;
+  purchaseCount: number;
+  purchases: PurchaseRecord[];
+}
+
+export interface ReferralInfo {
+  totalEarnings: string;
+  referralCount: number;
+  referredBy: string | null;
+  rewardPercent: number;
+  discountPercent: number;
+}
+
+export interface PurchaseSummary {
+  qvtxAmount: string;
+  nativeCost: string;
+  referrer: string;
+  discount: string;
+  remainingSupply: string;
+  withinLimits: boolean;
+}
+
+export interface DirectPurchaseConfig {
+  provider: string | providers.Provider;
+  contractAddress?: string;
+  network?: string;
+  privateKey?: string;
+  signer?: Signer;
+}
+
+export interface PurchaseOptions {
+  referrer?: string;
+  approve?: boolean;
+  overrides?: Record<string, any>;
+}
+
+export class QVTXDirectPurchase {
+  constructor(options: DirectPurchaseConfig);
+
+  contractAddress: string;
+  provider: providers.Provider;
+  signer?: Signer;
+  contract: Contract;
+
+  // Read functions
+  getPriceInNative(): Promise<string>;
+  getPriceInToken(tokenAddress: string): Promise<string>;
+  calculateNativeCost(qvtxAmount: string | number, referrer?: string): Promise<string>;
+  calculateTokenCost(tokenAddress: string, qvtxAmount: string | number, referrer?: string): Promise<string>;
+  getQVTXForNative(nativeAmount: string | number): Promise<string>;
+  getQVTXForToken(tokenAddress: string, tokenAmount: string | number): Promise<string>;
+  canPurchase(buyer: string, amount: string | number): Promise<{ valid: boolean; reason: string }>;
+  getPurchaseLimits(): Promise<PurchaseLimits>;
+  getWalletInfo(wallet: string): Promise<WalletInfo>;
+  getReferralInfo(wallet: string): Promise<ReferralInfo>;
+  getVestingSchedules(wallet: string): Promise<VestingSchedule[]>;
+  getSupportedTokens(): Promise<string[]>;
+  isPaused(): Promise<boolean>;
+  isWhitelistEnabled(): Promise<boolean>;
+  isWhitelisted(address: string): Promise<boolean>;
+
+  // Purchase functions
+  purchaseWithNative(qvtxAmount: string | number, options?: PurchaseOptions): Promise<any>;
+  purchaseWithToken(tokenAddress: string, qvtxAmount: string | number, options?: PurchaseOptions): Promise<any>;
+  releaseVested(scheduleIndex: number, overrides?: Record<string, any>): Promise<any>;
+
+  // Admin functions
+  setNativePrice(price: string | number): Promise<any>;
+  addPaymentToken(tokenAddress: string, price: string | number): Promise<any>;
+  updateTokenPrice(tokenAddress: string, price: string | number): Promise<any>;
+  setPurchaseLimits(limits: { min?: string; max?: string; maxWallet?: string; totalCap?: string }): Promise<any>;
+  updateWhitelist(addresses: string[], status: boolean): Promise<any>;
+  pause(): Promise<any>;
+  unpause(): Promise<any>;
+  withdrawNative(): Promise<any>;
+  withdrawToken(tokenAddress: string): Promise<any>;
+
+  // Utility functions
+  generateReferralLink(referrerAddress: string, baseUrl?: string): string;
+  parseReferralCode(url: string): string | null;
+  getPurchaseSummary(qvtxAmount: string | number, referrer?: string): Promise<PurchaseSummary>;
+}
+
+export function createDirectPurchase(options: DirectPurchaseConfig): QVTXDirectPurchase;
+
+export const PURCHASE_CONTRACTS: Record<string, Record<string, string | null>>;
+export const STABLECOINS: Record<string, Record<string, string>>;
+export const DirectPurchaseABI: any[];
+
+// Contract ABIs
+export const QVTXTokenABI: any[];
+export const QVTXGovernanceABI: any[];
+export const QVTXBridgeABI: any[];
+export const QVTXNFTABI: any[];
+export const QVTXVestingABI: any[];
+export const QVTXRewardsABI: any[];
+export const QVTXDirectPurchaseABI: any[];
+
+// Default export
+export default QVTXDeveloperKit;
+export { QVTXDeveloperKit };
+export { BlockchainAISDK };
+export { NodeSDK };
+export { QVTXStorage };
+export { QVTXRewards };
+export { QVTXSolana };
+export { QVTXDirectPurchase };