@galaxy-kj/core-stellar-sdk 2.0.0

package/dist/sponsored-reserves/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @fileoverview Sponsored Reserves Module Exports
+ * @description Main entry point for the Galaxy Stellar SDK sponsored reserves functionality
+ * @author Galaxy DevKit Team
+ * @version 1.0.0
+ * @since 2024-12-01
+ */
+export type { SponsoredEntryType, SponsorshipConfig, EntrySpecificConfig, AccountEntryConfig, TrustlineEntryConfig, OfferEntryConfig, DataEntryConfig, ClaimableBalanceEntryConfig, SignerEntryConfig, Claimant, ClaimPredicate, SponsoredEntry, SponsorshipCost, CostBreakdownItem, SponsorshipResult, SponsoredEntryInfo, RevokeSponsorshipTarget, UserOnboardingConfig, ClaimableBalanceSponsorshipConfig, MultiOperationSponsorshipConfig, SponsoredOperation, SponsoredEntriesQueryOptions, SponsorshipEligibility, UnsignedTransactionOptions, UnsignedTransactionResult, } from './types/sponsored-reserves-types';
+export { SponsoredReservesManager } from './services/sponsored-reserves-manager';
+export { SponsoredAccountBuilder } from './builders/sponsored-account-builder';
+export { SponsoredTrustlineBuilder } from './builders/sponsored-trustline-builder';
+export { SponsoredClaimableBalanceBuilder } from './builders/sponsored-claimable-balance-builder';
+export { SponsoredSignerBuilder } from './builders/sponsored-signer-builder';
+export { SponsoredDataEntryBuilder } from './builders/sponsored-data-entry-builder';
+export { UserOnboardingTemplate } from './templates/user-onboarding-template';
+export { ClaimableBalanceTemplate } from './templates/claimable-balance-template';
+export { MultiOperationTemplate } from './templates/multi-operation-template';
+export { validatePublicKey, validateSecretKey, validateSponsorBalance, validateOperationSequence, validateAssetCode, validateAmount, validateClaimants, validateClaimPredicate, validateDataEntryName, validateDataEntryValue, validateSignerWeight, validateEntryType, validatePreAuthTxHash, validateSha256Hash, } from './utils/sponsorship-validation';
+export { BASE_RESERVE_XLM, MINIMUM_ACCOUNT_BALANCE_XLM, DEFAULT_FEE_STROOPS, calculateEntryReserve, calculateTotalCost, calculateMultipleCost, getDetailedBreakdown, calculateOnboardingCost, calculateMultiOperationCost, estimateTransactionFee, calculateRequiredSponsorBalance, xlmToStroops, stroopsToXlm, formatCost, } from './utils/cost-calculator';
+//# sourceMappingURL=index.d.ts.map

package/dist/sponsored-reserves/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/sponsored-reserves/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,YAAY,EACV,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,eAAe,EACf,2BAA2B,EAC3B,iBAAiB,EACjB,QAAQ,EACR,cAAc,EACd,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,uBAAuB,EACvB,oBAAoB,EACpB,iCAAiC,EACjC,+BAA+B,EAC/B,kBAAkB,EAClB,4BAA4B,EAC5B,sBAAsB,EACtB,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,kCAAkC,CAAC;AAG1C,OAAO,EAAE,wBAAwB,EAAE,MAAM,uCAAuC,CAAC;AAGjF,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACnF,OAAO,EAAE,gCAAgC,EAAE,MAAM,gDAAgD,CAAC;AAClG,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AAGpF,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAC9E,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAG9E,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,sBAAsB,EACtB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,sBAAsB,EACtB,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,GACnB,MAAM,gCAAgC,CAAC;AAGxC,OAAO,EACL,gBAAgB,EAChB,2BAA2B,EAC3B,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,2BAA2B,EAC3B,sBAAsB,EACtB,+BAA+B,EAC/B,YAAY,EACZ,YAAY,EACZ,UAAU,GACX,MAAM,yBAAyB,CAAC"}

package/dist/sponsored-reserves/index.js

@@ -0,0 +1,24 @@
+/**
+ * @fileoverview Sponsored Reserves Module Exports
+ * @description Main entry point for the Galaxy Stellar SDK sponsored reserves functionality
+ * @author Galaxy DevKit Team
+ * @version 1.0.0
+ * @since 2024-12-01
+ */
+// Export main manager
+export { SponsoredReservesManager } from './services/sponsored-reserves-manager';
+// Export builders
+export { SponsoredAccountBuilder } from './builders/sponsored-account-builder';
+export { SponsoredTrustlineBuilder } from './builders/sponsored-trustline-builder';
+export { SponsoredClaimableBalanceBuilder } from './builders/sponsored-claimable-balance-builder';
+export { SponsoredSignerBuilder } from './builders/sponsored-signer-builder';
+export { SponsoredDataEntryBuilder } from './builders/sponsored-data-entry-builder';
+// Export templates
+export { UserOnboardingTemplate } from './templates/user-onboarding-template';
+export { ClaimableBalanceTemplate } from './templates/claimable-balance-template';
+export { MultiOperationTemplate } from './templates/multi-operation-template';
+// Export validation utilities
+export { validatePublicKey, validateSecretKey, validateSponsorBalance, validateOperationSequence, validateAssetCode, validateAmount, validateClaimants, validateClaimPredicate, validateDataEntryName, validateDataEntryValue, validateSignerWeight, validateEntryType, validatePreAuthTxHash, validateSha256Hash, } from './utils/sponsorship-validation';
+// Export cost calculation utilities
+export { BASE_RESERVE_XLM, MINIMUM_ACCOUNT_BALANCE_XLM, DEFAULT_FEE_STROOPS, calculateEntryReserve, calculateTotalCost, calculateMultipleCost, getDetailedBreakdown, calculateOnboardingCost, calculateMultiOperationCost, estimateTransactionFee, calculateRequiredSponsorBalance, xlmToStroops, stroopsToXlm, formatCost, } from './utils/cost-calculator';
+//# sourceMappingURL=index.js.map

package/dist/sponsored-reserves/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/sponsored-reserves/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AA+BH,sBAAsB;AACtB,OAAO,EAAE,wBAAwB,EAAE,MAAM,uCAAuC,CAAC;AAEjF,kBAAkB;AAClB,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACnF,OAAO,EAAE,gCAAgC,EAAE,MAAM,gDAAgD,CAAC;AAClG,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AAEpF,mBAAmB;AACnB,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAC9E,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAE9E,8BAA8B;AAC9B,OAAO,EACL,iBAAiB,EACjB,iBAAiB,EACjB,sBAAsB,EACtB,yBAAyB,EACzB,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,sBAAsB,EACtB,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,GACnB,MAAM,gCAAgC,CAAC;AAExC,oCAAoC;AACpC,OAAO,EACL,gBAAgB,EAChB,2BAA2B,EAC3B,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,2BAA2B,EAC3B,sBAAsB,EACtB,+BAA+B,EAC/B,YAAY,EACZ,YAAY,EACZ,UAAU,GACX,MAAM,yBAAyB,CAAC"}

package/dist/sponsored-reserves/services/sponsored-reserves-manager.d.ts

@@ -0,0 +1,144 @@
+/**
+ * @fileoverview Main manager class for sponsored reserves operations
+ * @description Handles all Stellar sponsored reserves functionality
+ * @author Galaxy DevKit Team
+ * @version 1.0.0
+ * @since 2024-12-01
+ */
+import { xdr, Claimant as StellarClaimant } from '@stellar/stellar-sdk';
+import { NetworkConfig } from '../../types/stellar-types';
+import { SponsorshipConfig, SponsoredEntry, SponsorshipResult, RevokeSponsorshipTarget, SponsorshipCost, SponsorshipEligibility, SponsoredEntriesQueryOptions, UnsignedTransactionOptions, UnsignedTransactionResult, Claimant, ClaimPredicate } from '../types/sponsored-reserves-types';
+/**
+ * Manager class for Stellar sponsored reserves operations
+ * @class SponsoredReservesManager
+ * @description Provides methods for sponsoring reserves, building transactions, and querying sponsored entries
+ */
+export declare class SponsoredReservesManager {
+    private server;
+    private networkConfig;
+    /**
+     * Creates a new SponsoredReservesManager instance
+     * @param networkConfig - Network configuration
+     */
+    constructor(networkConfig: NetworkConfig);
+    /**
+     * Creates a beginSponsoringFutureReserves operation
+     * @param sponsoredPublicKey - Public key of the account to sponsor
+     * @returns The Stellar operation
+     */
+    beginSponsoringFutureReserves(sponsoredPublicKey: string): xdr.Operation;
+    /**
+     * Creates an endSponsoringFutureReserves operation
+     * @param sponsoredPublicKey - Public key of the sponsored account (used as source)
+     * @returns The Stellar operation
+     */
+    endSponsoringFutureReserves(sponsoredPublicKey: string): xdr.Operation;
+    /**
+     * Creates a revoke sponsorship operation
+     * @param target - Target specification for revocation
+     * @returns The Stellar operation
+     */
+    revokeSponsorship(target: RevokeSponsorshipTarget): xdr.Operation;
+    /**
+     * Executes a complete sponsorship transaction
+     * @param config - Sponsorship configuration
+     * @param sponsorSecret - Sponsor's secret key
+     * @param sponsoredSecret - Sponsored account's secret key
+     * @param operations - Additional operations to include between begin and end
+     * @returns Promise<SponsorshipResult>
+     */
+    executeSponsorshipTransaction(config: SponsorshipConfig, sponsorSecret: string, sponsoredSecret: string, operations: xdr.Operation[]): Promise<SponsorshipResult>;
+    /**
+     * Builds an unsigned sponsorship transaction
+     * @param config - Sponsorship configuration
+     * @param operations - Operations to include
+     * @param options - Transaction options
+     * @returns Promise<UnsignedTransactionResult>
+     */
+    buildUnsignedSponsorshipTransaction(config: SponsorshipConfig, operations: xdr.Operation[], options?: UnsignedTransactionOptions): Promise<UnsignedTransactionResult>;
+    /**
+     * Signs and submits a sponsorship transaction from XDR
+     * @param transactionXdr - Transaction XDR
+     * @param signerSecrets - Array of secret keys for signing
+     * @returns Promise<SponsorshipResult>
+     */
+    signAndSubmitSponsorshipTransaction(transactionXdr: string, signerSecrets: string[]): Promise<SponsorshipResult>;
+    /**
+     * Gets entries sponsored FOR an account (entries where this account has sponsored reserves)
+     * @param accountPublicKey - Account public key
+     * @param options - Query options
+     * @returns Promise<SponsoredEntry[]>
+     */
+    getSponsoredEntries(accountPublicKey: string, options?: SponsoredEntriesQueryOptions): Promise<SponsoredEntry[]>;
+    /**
+     * Gets entries sponsored BY an account (entries this account is sponsoring)
+     * @param sponsorPublicKey - Sponsor's public key
+     * @param options - Query options
+     * @returns Promise<SponsoredEntry[]>
+     */
+    getEntriesSponsoredBy(sponsorPublicKey: string, _options?: SponsoredEntriesQueryOptions): Promise<SponsoredEntry[]>;
+    /**
+     * Checks if a sponsor is eligible for a sponsorship operation
+     * @param sponsorPublicKey - Sponsor's public key
+     * @param config - Sponsorship configuration or cost breakdown
+     * @returns Promise<SponsorshipEligibility>
+     */
+    checkSponsorshipEligibility(sponsorPublicKey: string, config: SponsorshipConfig | SponsorshipCost): Promise<SponsorshipEligibility>;
+    /**
+     * Calculates the cost of a sponsorship configuration
+     * @param config - Sponsorship configuration
+     * @returns SponsorshipCost
+     */
+    calculateSponsorshipCost(config: SponsorshipConfig): SponsorshipCost;
+    /**
+     * Calculates the cost for multiple entries
+     * @param entryTypes - Array of entry types with counts
+     * @returns SponsorshipCost
+     */
+    calculateMultipleSponsorshipCost(entryTypes: Array<{
+        type: string;
+        count: number;
+    }>): SponsorshipCost;
+    /**
+     * Converts a ClaimPredicate to Stellar SDK format
+     * @param predicate - Claim predicate
+     * @returns Stellar SDK claimant predicate
+     */
+    buildClaimPredicate(predicate: ClaimPredicate): xdr.ClaimPredicate;
+    /**
+     * Builds a Stellar Claimant from our Claimant interface
+     * @param claimant - Claimant configuration
+     * @returns Stellar SDK Claimant
+     */
+    buildStellarClaimant(claimant: Claimant): StellarClaimant;
+    /**
+     * Gets the current network configuration
+     * @returns NetworkConfig
+     */
+    getNetworkConfig(): NetworkConfig;
+    /**
+     * Switches to a different network
+     * @param networkConfig - New network configuration
+     */
+    switchNetwork(networkConfig: NetworkConfig): void;
+    /**
+     * Estimates transaction fee
+     * @param operationCount - Number of operations
+     * @returns Fee in stroops as string
+     */
+    private estimateFee;
+    /**
+     * Submits transaction with retry logic
+     * @param transaction - Transaction to submit
+     * @param maxRetries - Maximum retry attempts
+     * @returns Transaction result
+     */
+    private submitWithRetry;
+    /**
+     * Checks if an error is retryable
+     * @param error - Error to check
+     * @returns true if retryable
+     */
+    private isRetryableError;
+}
+//# sourceMappingURL=sponsored-reserves-manager.d.ts.map

package/dist/sponsored-reserves/services/sponsored-reserves-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sponsored-reserves-manager.d.ts","sourceRoot":"","sources":["../../../src/sponsored-reserves/services/sponsored-reserves-manager.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAQL,GAAG,EACH,QAAQ,IAAI,eAAe,EAC5B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,uBAAuB,EACvB,eAAe,EACf,sBAAsB,EACtB,4BAA4B,EAC5B,0BAA0B,EAC1B,yBAAyB,EACzB,QAAQ,EACR,cAAc,EACf,MAAM,mCAAmC,CAAC;AAW3C;;;;GAIG;AACH,qBAAa,wBAAwB;IACnC,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,aAAa,CAAgB;IAErC;;;OAGG;gBACS,aAAa,EAAE,aAAa;IAKxC;;;;OAIG;IACH,6BAA6B,CAAC,kBAAkB,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS;IAUxE;;;;OAIG;IACH,2BAA2B,CAAC,kBAAkB,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS;IAUtE;;;;OAIG;IACH,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,GAAG,CAAC,SAAS;IA+EjE;;;;;;;OAOG;IACG,6BAA6B,CACjC,MAAM,EAAE,iBAAiB,EACzB,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,GAAG,CAAC,SAAS,EAAE,GAC1B,OAAO,CAAC,iBAAiB,CAAC;IA4D7B;;;;;;OAMG;IACG,mCAAmC,CACvC,MAAM,EAAE,iBAAiB,EACzB,UAAU,EAAE,GAAG,CAAC,SAAS,EAAE,EAC3B,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC,yBAAyB,CAAC;IAkDrC;;;;;OAKG;IACG,mCAAmC,CACvC,cAAc,EAAE,MAAM,EACtB,aAAa,EAAE,MAAM,EAAE,GACtB,OAAO,CAAC,iBAAiB,CAAC;IA4B7B;;;;;OAKG;IACG,mBAAmB,CACvB,gBAAgB,EAAE,MAAM,EACxB,OAAO,GAAE,4BAAiC,GACzC,OAAO,CAAC,cAAc,EAAE,CAAC;IAoF5B;;;;;OAKG;IACG,qBAAqB,CACzB,gBAAgB,EAAE,MAAM,EACxB,QAAQ,GAAE,4BAAiC,GAC1C,OAAO,CAAC,cAAc,EAAE,CAAC;IAoB5B;;;;;OAKG;IACG,2BAA2B,CAC/B,gBAAgB,EAAE,MAAM,EACxB,MAAM,EAAE,iBAAiB,GAAG,eAAe,GAC1C,OAAO,CAAC,sBAAsB,CAAC;IA0ElC;;;;OAIG;IACH,wBAAwB,CAAC,MAAM,EAAE,iBAAiB,GAAG,eAAe;IAIpE;;;;OAIG;IACH,gCAAgC,CAC9B,UAAU,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,GACjD,eAAe;IASlB;;;;OAIG;IACH,mBAAmB,CAAC,SAAS,EAAE,cAAc,GAAG,GAAG,CAAC,cAAc;IAkClE;;;;OAIG;IACH,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,GAAG,eAAe;IAOzD;;;OAGG;IACH,gBAAgB,IAAI,aAAa;IAIjC;;;OAGG;IACH,aAAa,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAKjD;;;;OAIG;YACW,WAAW;IAUzB;;;;;OAKG;YACW,eAAe;IAiB7B;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;CAUzB"}