@hsuite/smart-engines-sdk 3.0.3 → 3.2.0

package/dist/nestjs/index.d.ts

@@ -683,6 +683,19 @@ export interface ValidatorInfo {
 	registeredAt: string;
 	messageType?: "validator.join" | "validator.leave" | "validator.update";
 }
+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 type AuthChain = "hedera" | "xrpl" | "polkadot" | "stellar" | "solana";
 export interface AuthenticateResponse {
 	token: string;
@@ -1002,6 +1015,7 @@ declare class IPFSClient {
 	getStatus(): Promise<IpfsStatusResponse>;
 	getStorageUsage(): Promise<IpfsStorageUsageResponse>;
 }
+export type SecurityMode = "none" | "partial" | "full";
 export type PreparedTransaction = {
 	success?: boolean;
 	transactionBytes: string;
@@ -1017,135 +1031,267 @@ export type PreparedTransaction = {
 };
 export type PrepareTransferRequest = {
 	chain: ChainType;
-	payerAccountId: string;
+	payerAccountId?: string;
 	from: string;
 	to: string;
 	amount: string;
 	tokenId?: string;
 	entityId?: string;
 	memo?: string;
+	securityMode?: SecurityMode;
+	appOwnerPublicKey?: string;
+	ss58Format?: number;
 };
 export type PrepareNftMintRequest = {
 	chain: ChainType;
-	payerAccountId: string;
-	tokenId: string;
-	metadata: string | string[];
+	payerAccountId?: string;
+	tokenId?: string;
+	metadata?: string | string[];
 	entityId?: string;
+	securityMode?: SecurityMode;
+	appOwnerPublicKey?: string;
+	ss58Format?: number;
+	collection?: number;
+	item?: number;
+	mintTo?: string;
+	witnessData?: unknown;
+	recipient?: string;
+	collectionMint?: string;
+	name?: string;
+	symbol?: string;
+	uri?: string;
+	sellerFeeBasisPoints?: number;
+	mintAuthority?: string;
 };
 export type PrepareNftBurnRequest = {
 	chain: ChainType;
-	payerAccountId: string;
-	tokenId: string;
-	serialNumber: number;
+	payerAccountId?: string;
+	tokenId?: string;
+	serialNumber?: number;
 	entityId?: string;
+	securityMode?: SecurityMode;
+	appOwnerPublicKey?: string;
+	ss58Format?: number;
+	collection?: number;
+	item?: number;
+	mint?: string;
+	owner?: string;
 };
 export type PrepareNftTransferRequest = {
 	chain: ChainType;
-	payerAccountId: string;
-	tokenId: string;
-	serialNumber: number;
-	fromAccountId: string;
-	toAccountId: string;
+	payerAccountId?: string;
+	tokenId?: string;
+	serialNumber?: number;
+	fromAccountId?: string;
+	toAccountId?: string;
 	entityId?: string;
+	securityMode?: SecurityMode;
+	appOwnerPublicKey?: string;
+	ss58Format?: number;
+	collection?: number;
+	item?: number;
+	dest?: string;
+	mint?: string;
+	fromOwner?: string;
+	toOwner?: string;
 };
 export type PrepareTokenCreateRequest = {
-	chain: "hedera";
-	payerAccountId: string;
-	name: string;
-	symbol: string;
-	decimals: number;
-	initialSupply: string;
-	treasuryAccountId: string;
-	entityId: string;
+	chain: ChainType;
+	payerAccountId?: string;
+	name?: string;
+	symbol?: string;
+	decimals?: number;
+	initialSupply?: string;
+	treasuryAccountId?: string;
+	entityId?: string;
 	memo?: string;
 	tokenType?: "FUNGIBLE_COMMON" | "NON_FUNGIBLE_UNIQUE";
+	securityMode?: SecurityMode;
+	appOwnerPublicKey?: string;
 	supplyKey?: string;
 	adminKey?: string;
 	pauseKey?: string;
 	freezeKey?: string;
 	kycKey?: string;
 	wipeKey?: string;
+	mintAuthority?: string;
+	assetId?: number;
+	admin?: string;
+	minBalance?: string;
+	assetName?: string;
+	noneOwnerVkeyHex?: string;
+	initialRecipient?: string;
 };
 export type PrepareTokenMintRequest = {
 	chain: ChainType;
-	payerAccountId: string;
-	tokenId: string;
+	payerAccountId?: string;
+	tokenId?: string;
 	amount: string;
 	recipientAccountId?: string;
 	entityId?: string;
+	securityMode?: SecurityMode;
+	appOwnerPublicKey?: string;
+	assetId?: number;
+	beneficiary?: string;
+	appOwnerVkeyHex?: string;
+	noneOwnerVkeyHex?: string;
+	destination?: string;
 };
 export type PrepareTokenBurnRequest = {
-	chain: "hedera";
-	payerAccountId: string;
-	tokenId: string;
+	chain: ChainType;
+	payerAccountId?: string;
+	tokenId?: string;
 	amount: string;
-	entityId: string;
+	entityId?: string;
+	securityMode?: SecurityMode;
+	appOwnerPublicKey?: string;
+	assetId?: number;
+	who?: string;
+	appOwnerVkeyHex?: string;
+	noneOwnerVkeyHex?: string;
+	source?: string;
 };
-export type PrepareTokenAssociationRequest = {
-	chain: "hedera";
-	payerAccountId: string;
+export type PrepareTokenAssociateRequest = {
+	chain: ChainType;
+	payerAccountId?: string;
 	accountId: string;
 	tokenIds: string[];
-	entityId: string;
+	entityId?: string;
+	owner?: string;
+};
+export type PrepareTokenPauseRequest = {
+	chain: ChainType;
+	payerAccountId?: string;
+	tokenId?: string;
+	assetId?: number;
+	entityId?: string;
+	securityMode?: SecurityMode;
+	appOwnerPublicKey?: string;
+	ss58Format?: number;
+	currentAuthority?: string;
+	newMintAuthority?: string | null;
+	memo?: string;
+};
+export type PrepareTokenUnpauseRequest = PrepareTokenPauseRequest;
+export type PrepareTokenRestrictRequest = {
+	chain: ChainType;
+	payerAccountId?: string;
+	tokenId?: string;
+	accountId?: string;
+	entityId?: string;
+	securityMode?: SecurityMode;
+	appOwnerPublicKey?: string;
+	ss58Format?: number;
+	assetId?: number;
+	who?: string;
+	account?: string;
+	freezeAuthority?: string;
+	memo?: string;
+};
+export type PrepareTokenUnrestrictRequest = PrepareTokenRestrictRequest;
+export type TransactionInfoResponse = {
+	model?: string;
+	description?: string;
+	principles?: string[];
+	supportedChains: string[];
+	responseFormat?: Record<string, string>;
 };
 export type PrepareTopicCreateRequest = {
-	chain: "hedera";
-	payerAccountId: string;
+	payerAccountId?: string;
 	memo?: string;
 	adminKeyRequired?: boolean;
 	submitKeyRequired?: boolean;
 	entityId: string;
 };
 export type PrepareTopicMessageRequest = {
-	chain: "hedera";
-	payerAccountId: string;
+	payerAccountId?: string;
 	topicId: string;
 	message: string | Record<string, unknown>;
 	entityId: string;
 };
-export type PrepareTokenPauseRequest = {
-	chain: "hedera";
-	payerAccountId: string;
-	tokenId: string;
-	entityId: string;
-	memo?: string;
-};
-export type PrepareTokenUnpauseRequest = PrepareTokenPauseRequest;
-export type PrepareTokenRestrictRequest = {
-	chain: "hedera";
-	payerAccountId: string;
+export type PrepareTokenComplianceEnableRequest = {
+	payerAccountId?: string;
 	tokenId: string;
 	accountId: string;
 	entityId: string;
+	securityMode?: SecurityMode;
+	appOwnerPublicKey?: string;
 	memo?: string;
 };
-export type PrepareTokenUnrestrictRequest = PrepareTokenRestrictRequest;
-export type PrepareTokenComplianceEnableRequest = PrepareTokenRestrictRequest;
-export type PrepareTokenComplianceDisableRequest = PrepareTokenRestrictRequest;
+export type PrepareTokenComplianceDisableRequest = PrepareTokenComplianceEnableRequest;
 export type PrepareTokenWipeRequest = {
-	chain: "hedera";
-	payerAccountId: string;
+	payerAccountId?: string;
 	tokenId: string;
 	accountId: string;
 	amount: string;
 	entityId: string;
 	memo?: string;
 };
+declare class HederaTransactionsClient {
+	private readonly http;
+	constructor(http: HttpClient);
+	prepareTopicCreate(request: PrepareTopicCreateRequest): Promise<PreparedTransaction>;
+	prepareTopicMessage(request: PrepareTopicMessageRequest): Promise<PreparedTransaction>;
+	prepareTokenComplianceEnable(request: PrepareTokenComplianceEnableRequest): Promise<PreparedTransaction>;
+	prepareTokenComplianceDisable(request: PrepareTokenComplianceDisableRequest): Promise<PreparedTransaction>;
+	prepareTokenWipe(request: PrepareTokenWipeRequest): Promise<PreparedTransaction>;
+}
 export type PrepareTrustLineRequest = {
-	chain: "xrpl";
-	accountAddress: string;
+	accountAddress?: string;
+	payerAccountId?: string;
 	currency: string;
 	issuerAddress: string;
 	limit?: string;
 	entityId: string;
 };
-export type TransactionInfoResponse = {
-	model?: string;
-	description?: string;
-	principles?: string[];
-	supportedChains: string[];
-	responseFormat?: Record<string, string>;
+declare class XrplTransactionsClient {
+	private readonly http;
+	constructor(http: HttpClient);
+	prepareTrustLine(request: PrepareTrustLineRequest): Promise<PreparedTransaction>;
+}
+export type PrepareTokenCloseAccountRequest = {
+	payerAccountId?: string;
+	account: string;
+	destination: string;
+	owner?: string;
+	entityId?: string;
+	securityMode?: SecurityMode;
+	appOwnerPublicKey?: string;
+	memo?: string;
 };
+declare class SolanaTransactionsClient {
+	private readonly http;
+	constructor(http: HttpClient);
+	prepareTokenCloseAccount(request: PrepareTokenCloseAccountRequest): Promise<PreparedTransaction>;
+}
+export type PrepareAssetSetTeamRequest = {
+	payerAccountId?: string;
+	assetId: number;
+	issuer: string;
+	admin: string;
+	freezer: string;
+	entityId?: string;
+	securityMode?: SecurityMode;
+	appOwnerPublicKey?: string;
+	ss58Format?: number;
+};
+export type PrepareAssetSetMetadataRequest = {
+	payerAccountId?: string;
+	assetId: number;
+	name: string;
+	symbol: string;
+	decimals: number;
+	entityId?: string;
+	securityMode?: SecurityMode;
+	appOwnerPublicKey?: string;
+	ss58Format?: number;
+};
+declare class PolkadotTransactionsClient {
+	private readonly http;
+	constructor(http: HttpClient);
+	prepareAssetSetTeam(request: PrepareAssetSetTeamRequest): Promise<PreparedTransaction>;
+	prepareAssetSetMetadata(request: PrepareAssetSetMetadataRequest): Promise<PreparedTransaction>;
+}
 declare class TransactionsClient {
 	private readonly http;
 	constructor(http: HttpClient);
@@ -1157,17 +1303,11 @@ declare class TransactionsClient {
 	prepareTokenCreate(request: PrepareTokenCreateRequest): Promise<PreparedTransaction>;
 	prepareTokenMint(request: PrepareTokenMintRequest): Promise<PreparedTransaction>;
 	prepareTokenBurn(request: PrepareTokenBurnRequest): Promise<PreparedTransaction>;
-	prepareTokenAssociation(request: PrepareTokenAssociationRequest): Promise<PreparedTransaction>;
+	prepareTokenAssociate(request: PrepareTokenAssociateRequest): Promise<PreparedTransaction>;
 	prepareTokenPause(request: PrepareTokenPauseRequest): Promise<PreparedTransaction>;
 	prepareTokenUnpause(request: PrepareTokenUnpauseRequest): Promise<PreparedTransaction>;
 	prepareTokenRestrict(request: PrepareTokenRestrictRequest): Promise<PreparedTransaction>;
 	prepareTokenUnrestrict(request: PrepareTokenUnrestrictRequest): Promise<PreparedTransaction>;
-	prepareTokenComplianceEnable(request: PrepareTokenComplianceEnableRequest): Promise<PreparedTransaction>;
-	prepareTokenComplianceDisable(request: PrepareTokenComplianceDisableRequest): Promise<PreparedTransaction>;
-	prepareTokenWipe(request: PrepareTokenWipeRequest): Promise<PreparedTransaction>;
-	prepareTopicCreate(request: PrepareTopicCreateRequest): Promise<PreparedTransaction>;
-	prepareTopicMessage(request: PrepareTopicMessageRequest): Promise<PreparedTransaction>;
-	prepareTrustLine(request: PrepareTrustLineRequest): Promise<PreparedTransaction>;
 }
 export type SnapshotStatus = "pending" | "generating" | "completed" | "failed";
 export type SnapshotFormat = "json" | "csv";
@@ -1211,6 +1351,43 @@ 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;
+};
+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;
@@ -1252,6 +1429,115 @@ 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;
+}
+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;
+}
+declare class PersonhoodClient {
+	private readonly http;
+	constructor(http: HttpClient);
+	verify(params: PersonhoodVerifyParams): Promise<PersonhoodCert | null>;
+}
 export interface SmartEngineClientConfig {
 	baseUrl: string;
 	apiKey?: string;
@@ -1274,6 +1560,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;
@@ -1289,10 +1597,18 @@ declare class SmartEngineClient {
 	readonly tss: TSSClient;
 	readonly ipfs: IPFSClient;
 	readonly transactions: TransactionsClient;
+	readonly hedera: HederaTransactionsClient;
+	readonly xrpl: XrplTransactionsClient;
+	readonly solana: SolanaTransactionsClient;
+	readonly polkadot: PolkadotTransactionsClient;
 	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(): {
@@ -1706,7 +2022,7 @@ declare class SmartGatewayClient {
 	getMetrics(refresh?: boolean): Promise<GatewayMetricsResponse>;
 	getMetricsSummary(): Promise<GatewayMetricsSummaryResponse>;
 }
-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;