@hsuite/smart-engines-sdk 3.0.3 → 3.1.0

package/dist/index.d.ts

@@ -970,6 +970,46 @@ export declare class MirrorNodeError extends Error {
 	statusCode: number;
 	constructor(message: string, statusCode: number);
 }
+export interface ClusterEndpointsView {
+	clusterId: string;
+	gatewayUrl: string;
+	harborUrl?: string;
+	natsUrl?: string;
+	publicIp?: string;
+	region?: string;
+}
+export interface ClusterInfo {
+	clusterId: string;
+	endpoints: ClusterEndpointsView;
+	nodeIds: string[];
+}
+export interface ClusterDiscoveryConfig {
+	bootstrap: string[];
+	cacheTtlMs?: number;
+	fetchTimeoutMs?: number;
+	trustAnchor?: ValidatorDiscoveryConfig;
+	allowInsecure?: boolean;
+}
+declare class ClusterDiscoveryClient {
+	private readonly bootstrap;
+	private readonly cacheTtlMs;
+	private readonly fetchTimeoutMs;
+	private readonly allowInsecure;
+	private readonly trustAnchorClient;
+	private cache;
+	constructor(config: ClusterDiscoveryConfig);
+	getClusters(forceRefresh?: boolean): Promise<ClusterInfo[]>;
+	getRandomCluster(forceRefresh?: boolean): Promise<ClusterInfo | null>;
+	getRandomGatewayUrl(forceRefresh?: boolean): Promise<string | null>;
+	getClusterById(clusterId: string, forceRefresh?: boolean): Promise<ClusterInfo | null>;
+	clearCache(): void;
+	private isCacheValid;
+	private fetchFromFirstAvailableSeed;
+	private fetchClustersFromSeed;
+	private normalizeClusterEntry;
+	private verifyAgainstTrustAnchor;
+	private pickRandomIndex;
+}
 export type AuthChain = "hedera" | "xrpl" | "polkadot" | "stellar" | "solana";
 export interface SecurityConfig {
 	allowInsecure?: boolean;
@@ -1070,6 +1110,14 @@ export declare class SdkHttpError extends Error {
 }
 export declare function createHttpClient(config: HttpClientConfig): HttpClient;
 export declare function encodePathParam(param: string): string;
+export interface RuleRejectedDetails {
+	error: "rule_rejected";
+	reason: string;
+	ruleAtoms: string[];
+}
+export declare function isRuleRejected(err: unknown): err is SdkHttpError & {
+	details: RuleRejectedDetails;
+};
 export type SubscriptionTierName = "free_testnet" | "starter" | "professional" | "enterprise";
 export type SubscriptionStatus = "pending_deposit" | "deposit_confirmed" | "active" | "expired" | "cancelled";
 export type DepositWalletStatus = "pending" | "locked" | "expired" | "slashed" | "released";
@@ -1570,6 +1618,48 @@ export declare class SnapshotsClient {
 	listByToken(tokenId: string, pagination?: PaginationOptions): Promise<SnapshotListResponse>;
 	download(snapshotId: string, format?: SnapshotFormat): Promise<any>;
 }
+export type HistoricalBalanceChain = "hedera" | "xrpl" | "polkadot";
+export type HistoricalBalanceQueryParams = {
+	chain: HistoricalBalanceChain;
+	entityId: string;
+	account: string;
+	atTimestamp: number;
+};
+export type HistoricalBalanceResult = {
+	chain: HistoricalBalanceChain;
+	entityId: string;
+	account: string;
+	atTimestamp: number;
+	balance: string;
+	source: "archive";
+};
+export type HistoricalBalanceClientConfig = {
+	baseUrl: string;
+	authToken?: string;
+	apiKey?: string;
+	timeoutMs?: number;
+	fetchImpl?: typeof fetch;
+};
+export declare class HistoricalBalanceClientError extends Error {
+	readonly statusCode: number;
+	readonly details?: unknown | undefined;
+	constructor(message: string, statusCode: number, details?: unknown | undefined);
+}
+export declare class HistoricalBalanceClient {
+	private readonly baseUrl?;
+	private readonly authToken?;
+	private readonly apiKey?;
+	private readonly timeoutMs;
+	private readonly fetchImpl?;
+	private readonly http?;
+	constructor(config: HistoricalBalanceClientConfig | {
+		http: HttpClient;
+	});
+	static fromHttp(http: HttpClient): HistoricalBalanceClient;
+	getBalance(params: HistoricalBalanceQueryParams): Promise<HistoricalBalanceResult>;
+	private validateParams;
+	private standaloneFetch;
+}
 export type SettlementPurpose = "subscription" | "deposit" | "fee";
 export type SettlementAsset = {
 	symbol: string;
@@ -1611,6 +1701,121 @@ export declare class SettlementClient {
 	confirmXrpLanded(settlementId: string): Promise<SettlementStatusResponse>;
 	getHistory(entityId: string): Promise<SettlementHistoryEntry[]>;
 }
+export type GovernanceVotingPowerMethod = "token_balance" | "quadratic" | "one_person_one_vote" | "nft_based" | "time_weighted" | "delegated";
+export type GovernanceProposalStatus = "pending" | "active" | "passed" | "failed" | "executed" | "cancelled" | "expired" | "vetoed";
+export type GovernanceVoteType = "for" | "against" | "abstain";
+export interface GovernanceProposalData {
+	proposalId: string;
+	proposer: string;
+	title: string;
+	description: string;
+	actions: unknown[];
+	status: GovernanceProposalStatus;
+	createdAt: string | Date;
+	votingStartsAt: string | Date;
+	votingEndsAt: string | Date;
+	executionDeadline?: string | Date;
+	votes: {
+		for: string;
+		against: string;
+		abstain: string;
+		totalVotingPower: string;
+	};
+	executionResult?: {
+		success: boolean;
+		transactionId?: string;
+		error?: string;
+	};
+}
+export interface GovernanceConfig {
+	governanceTokenId: string;
+	decimals?: number;
+	votingPowerMethod?: GovernanceVotingPowerMethod;
+	quorumPercent?: number;
+	approvalThresholdPercent?: number;
+	proposalThreshold: string;
+	votingPeriodMs: number;
+	timeLockMs?: number;
+	maxExecutionDelayMs?: number;
+	votingEligibility?: Record<string, unknown>;
+	proposalEligibility?: Record<string, unknown>;
+	allowDelegation?: boolean;
+	allowVoteChange?: boolean;
+	vetoCouncil?: string[];
+	maxActiveProposalsPerAccount?: number;
+	proposalCooldownMs?: number;
+	wisdomWeightFn?: {
+		registryKey: string;
+	};
+	delegation?: {
+		maxHops?: number;
+		decayPerHop?: number;
+		concentrationAlert?: number;
+	};
+	description?: string;
+}
+export interface GovernanceValidationContext {
+	chain?: string;
+	network?: "mainnet" | "testnet";
+	callerAccountId: string;
+	timestamp?: string | Date;
+	action: "create_proposal" | "cast_vote" | "execute_proposal" | "cancel_proposal" | "veto" | "delegate";
+	proposal?: GovernanceProposalData;
+	voteType?: GovernanceVoteType;
+	tokenBalance?: string;
+	votingPower?: string;
+	lastProposalAt?: string | Date;
+	activeProposalCount?: number;
+	delegation?: {
+		delegateTo?: string;
+		delegatedPower?: string;
+	};
+	daoId?: string;
+	totalDaoVotingPower?: string;
+}
+export interface GovernanceValidationResult {
+	isValid: boolean;
+	reason?: string;
+	metadata?: Record<string, unknown>;
+	validatedAt?: string;
+}
+export interface GovernanceSimulateRequest {
+	config: GovernanceConfig;
+	context: GovernanceValidationContext;
+}
+export declare class GovernanceClient {
+	private readonly http;
+	constructor(http: HttpClient);
+	simulate(params: GovernanceSimulateRequest): Promise<GovernanceValidationResult>;
+}
+export type PersonhoodAttestationMethod = "web-of-trust" | "biometric" | "pop-protocol";
+export interface PersonhoodProof {
+	attestationMethod: PersonhoodAttestationMethod;
+	payload: unknown;
+}
+export interface PersonhoodCert {
+	address: string;
+	issuerId: string;
+	attestationMethod: PersonhoodAttestationMethod;
+	issuedAt: number;
+	expiresAt: number;
+	signature: string;
+}
+export interface PersonhoodVerifyParams {
+	candidate: string;
+	proof: PersonhoodProof;
+}
+export declare const PERSONHOOD_VERIFIER_NOT_CONFIGURED: "personhood_verifier_not_configured";
+export declare class PersonhoodClient {
+	private readonly http;
+	constructor(http: HttpClient);
+	verify(params: PersonhoodVerifyParams): Promise<PersonhoodCert | null>;
+}
+export declare function isPersonhoodVerifierNotConfigured(err: unknown): err is SdkHttpError & {
+	details: {
+		error: typeof PERSONHOOD_VERIFIER_NOT_CONFIGURED;
+	};
+};
 export interface SmartEngineClientConfig {
 	baseUrl: string;
 	apiKey?: string;
@@ -1633,6 +1838,28 @@ export interface NetworkConnectionConfig {
 	mirrorNodeUrl?: string;
 	allowInsecure?: boolean;
 }
+export interface ClusterConnectionConfig {
+	bootstrap: string[];
+	chain: AuthChain;
+	address: string;
+	publicKey: string;
+	signFn: (challenge: string) => string | Promise<string>;
+	metadata?: {
+		appId?: string;
+		appName?: string;
+	};
+	trustAnchor?: {
+		network: "mainnet" | "testnet" | "previewnet";
+		registryTopicId: string;
+		mirrorNodeUrl?: string;
+	};
+	allowInsecure?: boolean;
+}
+export interface ClusterConnectionResult {
+	client: SmartEngineClient;
+	cluster: ClusterInfo;
+	session: AuthenticateResponse;
+}
 export interface NetworkConnectionResult {
 	client: SmartEngineClient;
 	validator: ValidatorInfo;
@@ -1649,9 +1876,13 @@ export declare class SmartEngineClient {
 	readonly ipfs: IPFSClient;
 	readonly transactions: TransactionsClient;
 	readonly snapshots: SnapshotsClient;
+	readonly historicalBalance: HistoricalBalanceClient;
 	readonly settlement: SettlementClient;
+	readonly governance: GovernanceClient;
+	readonly personhood: PersonhoodClient;
 	constructor(config: SmartEngineClientConfig);
 	static connectToNetwork(config: NetworkConnectionConfig): Promise<NetworkConnectionResult>;
+	static connectToCluster(config: ClusterConnectionConfig): Promise<ClusterConnectionResult>;
 	getBaseUrl(): string;
 	isAuthenticated(): boolean;
 	getHttpHealth(): {
@@ -2096,7 +2327,7 @@ declare function xlmToStroops(xlm: string | number): string;
 declare function validateBitcoinAddress(address: string): boolean;
 declare function satoshisToBtc(satoshis: string | number): string;
 declare function btcToSatoshis(btc: string | number): string;
-export type BaasService = "auth" | "database" | "storage" | "functions" | "messaging" | "customer-session";
+export type BaasService = "auth" | "database" | "storage" | "functions" | "messaging";
 export type BaasSupportedChain = "hedera" | "xrpl" | "polkadot" | "solana";
 export type BaasEndpoints = {
 	auth: string;
@@ -2854,7 +3085,7 @@ declare namespace baas {
 	export { AgentBalance, AgentEvent, AgentFundRequest, AgentInfo, AgentOperation, AgentRegisterRequest, AgentRules, AgentRulesValidationResult, AgentStatus, AgentTradeRequest, AgentWithdrawRequest, AgentsClient, AuthenticateOptions, BaasAppListResponse, BaasAuthConfig, BaasAuthResult, BaasChallengeRequest, BaasChallengeResponse, BaasChannelConfig, BaasClient, BaasClientConfig, BaasDeleteResult, BaasDeployRequest, BaasDeployResponse, BaasDocument, BaasEndpoints, BaasError, BaasErrorDetails, BaasErrorResponse, BaasFileInfo, BaasFileMetadata, BaasFindResult, BaasFunctionDeployRequest, BaasFunctionDeployResult, BaasFunctionInfo, BaasFunctionLog, BaasFunctionLogOptions, BaasFunctionResources, BaasFunctionResult, BaasFunctionRuntime, BaasHistoryOptions, BaasInitRequest, BaasInitResponse, BaasInsertResult, BaasMerkleProof, BaasMessage, BaasPresenceInfo, BaasPresenceMember, BaasPublishResult, BaasQueryOptions, BaasRollbackRequest, BaasRuntimeStatus, BaasService, BaasSessionInfo, BaasStateTransition, BaasStorageUsage, BaasSupportedChain, BaasTriggerType, BaasUpdateResult, BaasUploadFrontendResponse, BaasUploadResult, BaasVerifyRequest, ChannelSubscription, DatabaseClient, DatabaseStatsResponse, DbComparisonOperator, DbDocument, DbQuery, DeployedApp, DeployedAppInfo, DeployedAppLimits, DeployedAppStatus, DeployedAppUsage, DeploymentClient, DocumentProofResponse, FunctionsClient, MessageHandler, MessagingClient, StateRootResponse, StateTransitionsResponse, StorageClient, validateAgentRules };
 }
 declare namespace discovery {
-	export { MIRROR_NODE_URLS, MirrorNodeClient, MirrorNodeConfig, MirrorNodeError, TopicMessage, TopicMessagesResponse, ValidatorDiscoveryClient, ValidatorDiscoveryConfig, ValidatorInfo, ValidatorMetadata, ValidatorNetworkEndpoints };
+	export { ClusterDiscoveryClient, ClusterDiscoveryConfig, ClusterEndpointsView, ClusterInfo, MIRROR_NODE_URLS, MirrorNodeClient, MirrorNodeConfig, MirrorNodeError, TopicMessage, TopicMessagesResponse, ValidatorDiscoveryClient, ValidatorDiscoveryConfig, ValidatorInfo, ValidatorMetadata, ValidatorNetworkEndpoints };
 }
 declare namespace auth {
 	export { AuthChain, AuthenticateRequest, AuthenticateResponse, ChallengeResponse, SecurityConfig, SessionInfo, ValidatorAuthClient, ValidatorAuthConfig, ValidatorAuthError };
@@ -2868,6 +3099,12 @@ declare namespace subscription {
 declare namespace settlement {
 	export { SettlementAsset, SettlementClient, SettlementHistoryEntry, SettlementInitiateRequest, SettlementPurpose, SettlementStatusResponse };
 }
+declare namespace governance {
+	export { GovernanceClient, GovernanceConfig, GovernanceProposalData, GovernanceProposalStatus, GovernanceSimulateRequest, GovernanceValidationContext, GovernanceValidationResult, GovernanceVoteType, GovernanceVotingPowerMethod };
+}
+declare namespace personhood {
+	export { PERSONHOOD_VERIFIER_NOT_CONFIGURED, PersonhoodAttestationMethod, PersonhoodCert, PersonhoodClient, PersonhoodProof, PersonhoodVerifyParams, isPersonhoodVerifierNotConfigured };
+}
 
 export {
 	RetryConfig as ResilienceRetryConfig,
@@ -2876,6 +3113,8 @@ export {
 	baas,
 	chains,
 	discovery,
+	governance,
+	personhood,
 	settlement,
 	subscription,
 };