hive-stream 3.0.4 → 3.0.5

package/dist/utils.d.ts

@@ -363,5 +363,447 @@ export declare const Utils: {
      * @returns The complete Hivesigner transfer URL
      */
     getTransferUrl(to: string, memo: string, amount: string, redirectUri: string): string;
+    /**
+     * Follows a Hive user by broadcasting a custom_json 'follow' operation
+     * @param client - The Hive client instance
+     * @param config - Configuration containing the posting key
+     * @param follower - The account doing the following
+     * @param following - The account to follow
+     * @returns Promise resolving to the broadcast result
+     */
+    follow(client: Client, config: Partial<ConfigInterface>, follower: string, following: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    /**
+     * Unfollows a Hive user by broadcasting a custom_json 'follow' operation with empty what
+     * @param client - The Hive client instance
+     * @param config - Configuration containing the posting key
+     * @param follower - The account doing the unfollowing
+     * @param following - The account to unfollow
+     * @returns Promise resolving to the broadcast result
+     */
+    unfollow(client: Client, config: Partial<ConfigInterface>, follower: string, following: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    /**
+     * Mutes a Hive user by broadcasting a custom_json 'follow' operation with 'ignore'
+     * @param client - The Hive client instance
+     * @param config - Configuration containing the posting key
+     * @param follower - The account doing the muting
+     * @param following - The account to mute
+     * @returns Promise resolving to the broadcast result
+     */
+    mute(client: Client, config: Partial<ConfigInterface>, follower: string, following: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    /**
+     * Reblogs (resteems) a post on Hive
+     * @param client - The Hive client instance
+     * @param config - Configuration containing the posting key
+     * @param account - The account performing the reblog
+     * @param author - The original post author
+     * @param permlink - The permlink of the post to reblog
+     * @returns Promise resolving to the broadcast result
+     */
+    reblog(client: Client, config: Partial<ConfigInterface>, account: string, author: string, permlink: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    /**
+     * Powers up HIVE to Hive Power (VESTS) for an account
+     * @param client - The Hive client instance
+     * @param config - Configuration containing the active key
+     * @param from - The account providing the HIVE
+     * @param to - The account receiving the Hive Power (can be same as from)
+     * @param amount - The amount of HIVE to power up
+     * @returns Promise resolving to the broadcast result
+     */
+    powerUp(client: Client, config: Partial<ConfigInterface>, from: string, to: string, amount: string): any;
+    /**
+     * Initiates a power down (withdrawal of vesting shares) for an account
+     * @param client - The Hive client instance
+     * @param config - Configuration containing the active key
+     * @param account - The account to power down
+     * @param vestingShares - The amount of VESTS to power down (e.g. '1000.000000 VESTS')
+     * @returns Promise resolving to the broadcast result
+     */
+    powerDown(client: Client, config: Partial<ConfigInterface>, account: string, vestingShares: string): any;
+    /**
+     * Cancels an active power down by setting vesting shares to 0
+     * @param client - The Hive client instance
+     * @param config - Configuration containing the active key
+     * @param account - The account to cancel power down for
+     * @returns Promise resolving to the broadcast result
+     */
+    cancelPowerDown(client: Client, config: Partial<ConfigInterface>, account: string): any;
+    /**
+     * Delegates vesting shares (Hive Power) to another account
+     * @param client - The Hive client instance
+     * @param config - Configuration containing the active key
+     * @param delegator - The account delegating HP
+     * @param delegatee - The account receiving the delegation
+     * @param vestingShares - The amount of VESTS to delegate (e.g. '1000.000000 VESTS')
+     * @returns Promise resolving to the broadcast result
+     */
+    delegateVestingShares(client: Client, config: Partial<ConfigInterface>, delegator: string, delegatee: string, vestingShares: string): any;
+    /**
+     * Removes a vesting shares delegation by delegating 0 VESTS
+     * @param client - The Hive client instance
+     * @param config - Configuration containing the active key
+     * @param delegator - The account removing the delegation
+     * @param delegatee - The account to remove delegation from
+     * @returns Promise resolving to the broadcast result
+     */
+    undelegateVestingShares(client: Client, config: Partial<ConfigInterface>, delegator: string, delegatee: string): any;
+    /**
+     * Claims pending rewards for an account
+     * @param client - The Hive client instance
+     * @param config - Configuration containing the posting key
+     * @param account - The account to claim rewards for
+     * @param rewardHive - HIVE rewards to claim (e.g. '0.000 HIVE')
+     * @param rewardHbd - HBD rewards to claim (e.g. '0.000 HBD')
+     * @param rewardVests - VESTS rewards to claim (e.g. '0.000000 VESTS')
+     * @returns Promise resolving to the broadcast result
+     */
+    claimRewards(client: Client, config: Partial<ConfigInterface>, account: string, rewardHive: string, rewardHbd: string, rewardVests: string): any;
+    /**
+     * Votes for or unvotes a witness
+     * @param client - The Hive client instance
+     * @param config - Configuration containing the active key
+     * @param account - The account casting the witness vote
+     * @param witness - The witness account to vote for
+     * @param approve - true to vote, false to remove vote
+     * @returns Promise resolving to the broadcast result
+     */
+    witnessVote(client: Client, config: Partial<ConfigInterface>, account: string, witness: string, approve?: boolean): any;
+    /**
+     * Sets a governance proxy for an account (delegates witness voting to another account)
+     * @param client - The Hive client instance
+     * @param config - Configuration containing the active key
+     * @param account - The account setting the proxy
+     * @param proxy - The account to proxy votes to
+     * @returns Promise resolving to the broadcast result
+     */
+    setProxy(client: Client, config: Partial<ConfigInterface>, account: string, proxy: string): any;
+    /**
+     * Clears the governance proxy for an account
+     * @param client - The Hive client instance
+     * @param config - Configuration containing the active key
+     * @param account - The account clearing the proxy
+     * @returns Promise resolving to the broadcast result
+     */
+    clearProxy(client: Client, config: Partial<ConfigInterface>, account: string): any;
+    /**
+     * Updates an account's profile metadata using account_update2
+     * @param client - The Hive client instance
+     * @param config - Configuration containing the posting key
+     * @param account - The account to update
+     * @param profile - Profile data (name, about, location, website, profile_image, cover_image)
+     * @returns Promise resolving to the broadcast result
+     */
+    updateProfile(client: Client, config: Partial<ConfigInterface>, account: string, profile: {
+        name?: string;
+        about?: string;
+        location?: string;
+        website?: string;
+        profile_image?: string;
+        cover_image?: string;
+        [key: string]: any;
+    }): Promise<any>;
+    /**
+     * Fetches account data for a single account
+     * @param client - The Hive client instance
+     * @param username - The account name to look up
+     * @returns Promise resolving to the account data, or null if not found
+     */
+    getAccount(client: Client, username: string): Promise<any>;
+    /**
+     * Fetches account data for multiple accounts
+     * @param client - The Hive client instance
+     * @param usernames - Array of account names to look up
+     * @returns Promise resolving to array of account data
+     */
+    getAccounts(client: Client, usernames: string[]): Promise<any[]>;
+    /**
+     * Converts raw Hive reputation value to a human-readable score (roughly 25-75 range)
+     * @param rawReputation - The raw reputation value from the blockchain (can be string or number)
+     * @returns The human-readable reputation score
+     */
+    calculateReputation(rawReputation: string | number): number;
+    /**
+     * Converts VESTS to Hive Power (HP)
+     * @param vests - The amount of VESTS (as string or number)
+     * @param totalVestingFundHive - Total vesting fund in HIVE from dynamic global properties
+     * @param totalVestingShares - Total vesting shares from dynamic global properties
+     * @returns The equivalent Hive Power amount as a string with 3 decimal places
+     */
+    vestToHP(vests: string | number, totalVestingFundHive: string | number, totalVestingShares: string | number): string;
+    /**
+     * Converts Hive Power (HP) to VESTS
+     * @param hp - The amount of HP (as string or number)
+     * @param totalVestingFundHive - Total vesting fund in HIVE from dynamic global properties
+     * @param totalVestingShares - Total vesting shares from dynamic global properties
+     * @returns The equivalent VESTS amount as a string with 6 decimal places
+     */
+    hpToVest(hp: string | number, totalVestingFundHive: string | number, totalVestingShares: string | number): string;
+    /**
+     * Parses Hive account profile metadata from json_metadata or posting_json_metadata
+     * @param jsonMetadata - The raw JSON metadata string from the account
+     * @returns Parsed profile object, or empty object if parsing fails
+     */
+    parseProfileMetadata(jsonMetadata: string): {
+        name?: string;
+        about?: string;
+        location?: string;
+        website?: string;
+        profile_image?: string;
+        cover_image?: string;
+        [key: string]: any;
+    };
+    /**
+     * Converts a Hive Power (HP) amount to a formatted VESTS string suitable for delegation/power down
+     * @param hp - The amount of HP
+     * @param totalVestingFundHive - Total vesting fund in HIVE
+     * @param totalVestingShares - Total vesting shares
+     * @returns Formatted VESTS string (e.g. '1234.567890 VESTS')
+     */
+    hpToVestString(hp: string | number, totalVestingFundHive: string | number, totalVestingShares: string | number): string;
+    transferToSavings(client: Client, config: Partial<ConfigInterface>, from: string, to: string, amount: string, symbol: string, memo?: string): any;
+    transferFromSavings(client: Client, config: Partial<ConfigInterface>, from: string, to: string, amount: string, symbol: string, requestId: number, memo?: string): any;
+    cancelTransferFromSavings(client: Client, config: Partial<ConfigInterface>, from: string, requestId: number): any;
+    convert(client: Client, config: Partial<ConfigInterface>, owner: string, amount: string, requestId?: number): any;
+    collateralizedConvert(client: Client, config: Partial<ConfigInterface>, owner: string, amount: string, requestId?: number): any;
+    deleteComment(client: Client, config: Partial<ConfigInterface>, author: string, permlink: string): any;
+    commentOptions(client: Client, config: Partial<ConfigInterface>, author: string, permlink: string, options: {
+        max_accepted_payout?: string;
+        percent_hbd?: number;
+        allow_votes?: boolean;
+        allow_curation_rewards?: boolean;
+        extensions?: any[];
+    }): any;
+    limitOrderCreate(client: Client, config: Partial<ConfigInterface>, owner: string, orderId: number, amountToSell: string, minToReceive: string, fillOrKill?: boolean, expiration?: string | Date): any;
+    limitOrderCancel(client: Client, config: Partial<ConfigInterface>, owner: string, orderId: number): any;
+    setWithdrawVestingRoute(client: Client, config: Partial<ConfigInterface>, fromAccount: string, toAccount: string, percent: number, autoVest?: boolean, signingKeys?: HiveKeyInput | HiveKeyInput[]): any;
+    claimAccount(client: Client, config: Partial<ConfigInterface>, creator: string, fee?: string): any;
+    createClaimedAccount(client: Client, config: Partial<ConfigInterface>, creator: string, newAccountName: string, owner: AuthorityInput, active: AuthorityInput, posting: AuthorityInput, memoKey: string, jsonMetadata?: string): any;
+    feedPublish(client: Client, config: Partial<ConfigInterface>, publisher: string, baseAmount: string, quoteAmount?: string): any;
+    /**
+     * Calculates current voting mana percentage for an account
+     * @param account - Extended account object from getAccounts()
+     * @returns Voting mana as a percentage (0-100)
+     */
+    calculateVotingMana(account: any): number;
+    /**
+     * Gets the effective vesting shares for an account (own + received - delegated)
+     * @param account - Extended account object
+     * @returns Effective vesting shares as a number
+     */
+    getEffectiveVestingShares(account: any): number;
+    /**
+     * Estimates the value of a vote in USD
+     * @param votingPower - Current voting power percentage (0-100)
+     * @param weight - Vote weight percentage (0-100)
+     * @param effectiveVests - Effective vesting shares as number
+     * @param rewardFund - Reward fund object from condenser_api.get_reward_fund
+     * @param medianPrice - Median price object from getDynamicGlobalProperties
+     * @returns Estimated vote value in USD
+     */
+    estimateVoteValue(votingPower: number, weight: number, effectiveVests: number, rewardFund: {
+        reward_balance: string;
+        recent_claims: string;
+    }, medianPrice: {
+        base: string;
+        quote: string;
+    }): number;
+    /**
+     * Generates a URL-safe permlink from a title
+     * @param title - The post title
+     * @returns A valid Hive permlink string
+     */
+    generatePermlink(title: string): string;
+    /**
+     * Validates a Hive account name according to blockchain rules
+     * @param name - The account name to validate
+     * @returns null if valid, or an error message string
+     */
+    validateAccountName(name: string): string | null;
+    /**
+     * Returns true if the given string is a valid Hive account name
+     * @param name - The account name to check
+     * @returns true if valid, false otherwise
+     */
+    isValidAccountName(name: string): boolean;
+    /**
+     * Checks if an account exists on the blockchain
+     * @param client - The Hive client instance
+     * @param username - Account name to check
+     * @returns Promise resolving to true if account exists
+     */
+    accountExists(client: Client, username: string): Promise<boolean>;
+    /**
+     * Parses a Hive URL or link into its components
+     * @param url - URL like https://hive.blog/@author/permlink or @author/permlink
+     * @returns Parsed components { author, permlink, category? } or null if invalid
+     */
+    parseHiveUrl(url: string): {
+        author: string;
+        permlink: string;
+        category?: string;
+    } | null;
+    /**
+     * Generates a unique permlink with timestamp for replies
+     * @param parentPermlink - The parent post's permlink (optional)
+     * @returns A unique permlink string
+     */
+    generateReplyPermlink(parentPermlink?: string): string;
+    /**
+     * Creates the json_metadata string for a Hive post
+     * @param options - Post metadata options
+     * @returns JSON string for json_metadata field
+     */
+    createPostMetadata(options?: {
+        tags?: string[];
+        image?: string[];
+        links?: string[];
+        app?: string;
+        format?: string;
+        description?: string;
+        [key: string]: any;
+    }): string;
+    /**
+     * Encodes a memo with a shared secret (requires sender private memo key and receiver public memo key)
+     * Note: Requires @hiveio/dhive Memo support
+     */
+    encodeMemo(privateKey: string, publicKey: string, message: string): string;
+    /**
+     * Decodes an encrypted memo
+     * Note: Requires @hiveio/dhive Memo support
+     */
+    decodeMemo(privateKey: string, encodedMemo: string): string;
+    /**
+     * Checks if an account has granted posting authority to an app/account
+     */
+    hasPostingAuth(client: Client, account: string, authAccount: string): Promise<boolean>;
+    /**
+     * Grants posting authority to an app/account
+     */
+    grantPostingAuth(client: Client, config: Partial<ConfigInterface>, account: string, authAccount: string, signingKeys?: HiveKeyInput | HiveKeyInput[]): Promise<any>;
+    /**
+     * Revokes posting authority from an app/account
+     */
+    revokePostingAuth(client: Client, config: Partial<ConfigInterface>, account: string, authAccount: string, signingKeys?: HiveKeyInput | HiveKeyInput[]): Promise<any>;
+    /**
+     * Calculates the remaining power down schedule for an account
+     * @param account - Extended account object from getAccounts()
+     * @returns Array of weekly payment entries with dates and amounts
+     */
+    calculatePowerDownSchedule(account: any): Array<{
+        week: number;
+        date: Date;
+        amount: string;
+        vestingShares: string;
+    }>;
+    /**
+     * Calculates pending HBD savings interest
+     * @param hbdBalance - HBD savings balance (e.g. '100.000 HBD')
+     * @param lastInterestPayment - Date of last interest payment
+     * @param annualRate - Annual interest rate as percentage (default: 15)
+     * @returns Pending interest amount as a string
+     */
+    calculateHbdInterest(hbdBalance: string | number, lastInterestPayment: string | Date, annualRate?: number): string;
+    /**
+     * Checks if a post is still within its payout window (7 days)
+     */
+    isInPayoutWindow(post: any): boolean;
+    /**
+     * Returns milliseconds until payout, or 0 if already paid out
+     */
+    timeUntilPayout(post: any): number;
+    /**
+     * Calculates the pending payout value of a post in HBD
+     */
+    getPendingPayout(post: any): string;
+    /**
+     * Calculates total account value breakdown
+     * @param account - Extended account object
+     * @param hivePrice - Current HIVE price in USD
+     * @param hbdPrice - Current HBD price in USD (usually ~1.00)
+     * @param totalVestingFundHive - From dynamic global properties
+     * @param totalVestingShares - From dynamic global properties
+     * @returns Breakdown of account value
+     */
+    calculateAccountValue(account: any, hivePrice: number, hbdPrice?: number, totalVestingFundHive?: string | number, totalVestingShares?: string | number): {
+        hive: number;
+        hbd: number;
+        savings_hive: number;
+        savings_hbd: number;
+        hp: number;
+        total_hive: number;
+        total_usd: number;
+    };
+    /**
+     * Extracts all image URLs from a post body (markdown/HTML)
+     */
+    extractImagesFromBody(body: string): string[];
+    /**
+     * Extracts all hyperlinks from a post body
+     */
+    extractLinksFromBody(body: string): string[];
+    /**
+     * Generates a plain-text summary from a post body by stripping markdown/HTML
+     */
+    generatePostSummary(body: string, maxLength?: number): string;
+    /**
+     * Generates a Hivesigner signing URL for any operation
+     */
+    getHivesignerSignUrl(operationType: string, params: Record<string, any>, redirectUri?: string): string;
+    /**
+     * Generates a Hivesigner vote URL
+     */
+    getVoteUrl(voter: string, author: string, permlink: string, weight: number, redirectUri?: string): string;
+    /**
+     * Generates a Hivesigner delegation URL
+     */
+    getDelegateUrl(delegator: string, delegatee: string, vestingShares: string, redirectUri?: string): string;
+    /**
+     * Generates a Hivesigner follow URL
+     */
+    getFollowUrl(follower: string, following: string, redirectUri?: string): string;
+    /**
+     * Checks if a memo is encrypted (starts with #)
+     */
+    isEncryptedMemo(memo: string): boolean;
+    /**
+     * Creates a JSON-encoded memo string for structured data in transfers
+     */
+    createJsonMemo(data: Record<string, any>): string;
+    /**
+     * Attempts to parse a transfer memo as JSON, returns null if not valid JSON
+     */
+    parseJsonMemo(memo: string): Record<string, any> | null;
+    /**
+     * Derives all private and public keys from a Hive master password
+     * @param account - The Hive account name
+     * @param password - The master password
+     * @returns Object with owner, active, posting, memo keys (private and public)
+     */
+    deriveKeys(account: string, password: string): {
+        owner: string;
+        active: string;
+        posting: string;
+        memo: string;
+        ownerPublic: string;
+        activePublic: string;
+        postingPublic: string;
+        memoPublic: string;
+    };
+    /**
+     * Gets the public key from a private key string
+     */
+    getPublicKey(privateKey: string): string;
+    stakeEngineTokens(client: Client, config: Partial<ConfigInterface>, from: string, to: string, symbol: string, quantity: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    unstakeEngineTokens(client: Client, config: Partial<ConfigInterface>, from: string, symbol: string, quantity: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    buyEngineTokens(client: Client, config: Partial<ConfigInterface>, from: string, symbol: string, quantity: string, price: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    sellEngineTokens(client: Client, config: Partial<ConfigInterface>, from: string, symbol: string, quantity: string, price: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    cancelEngineOrder(client: Client, config: Partial<ConfigInterface>, from: string, type: "buy" | "sell", orderId: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    delegateEngineTokens(client: Client, config: Partial<ConfigInterface>, from: string, to: string, symbol: string, quantity: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    undelegateEngineTokens(client: Client, config: Partial<ConfigInterface>, from: string, to: string, symbol: string, quantity: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    subscribeCommunity(client: Client, config: Partial<ConfigInterface>, account: string, community: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    unsubscribeCommunity(client: Client, config: Partial<ConfigInterface>, account: string, community: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    pinCommunityPost(client: Client, config: Partial<ConfigInterface>, account: string, community: string, author: string, permlink: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    unpinCommunityPost(client: Client, config: Partial<ConfigInterface>, account: string, community: string, author: string, permlink: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    muteCommunityUser(client: Client, config: Partial<ConfigInterface>, account: string, community: string, targetAccount: string, notes?: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
+    unmuteCommunityUser(client: Client, config: Partial<ConfigInterface>, account: string, community: string, targetAccount: string, notes?: string): Promise<import("@hiveio/dhive").TransactionConfirmation>;
 };
 export {};