hive-stream 3.0.3 → 3.0.5

package/dist/builders.d.ts

@@ -0,0 +1,444 @@
+import type { Streamer } from './streamer';
+import type { BatchBuilder, BurnOperationBuilder, CommunityOperationBuilder, EngineCancelOrderBuilder, EngineDelegateBuilder, EngineMarketOrderBuilder, EngineStakeBuilder, EngineUnstakeBuilder, CancelOrderBuilder, ClaimRewardsBuilder, CollateralizedConvertBuilder, CommentOptionsBuilder, ConvertBuilder, DelegateBuilder, DeleteCommentBuilder, EscrowTransferBuilder, FlowAllocationInput, FlowDedupeStore, FlowGroupRecipient, FlowGroupSplitStrategy, FlowMemoInput, FlowSubscriptionHandle, FollowBuilder, HiveEngineBurnBuilder, HiveEngineIssueBuilder, HiveEngineTransferBuilder, IncomingTransferFlowBuilder, LimitOrderBuilder, PlannedIncomingTransferRoutes, PostBuilder, PowerDownBuilder, PowerUpBuilder, ProposalBuilder, ProposalVotesBuilder, ReblogBuilder, RemoveProposalsBuilder, RecurrentTransferBuilder, SavingsTransferBuilder, SetProxyBuilder, TransferEvent, TransferOperationBuilder, UpdateProfileBuilder, VoteBuilder, WitnessVoteBuilder, WithdrawRouteBuilder } from './types/hive-stream';
+export declare class IncomingTransfersBuilder implements IncomingTransferFlowBuilder {
+    private readonly streamer;
+    private account?;
+    private allowedSymbols?;
+    private dedupeStore?;
+    private ignoreZeroAmountValue?;
+    private errorHandler?;
+    private defaultMemo?;
+    private steps;
+    constructor(streamer: Streamer, account?: string);
+    forAccount(account: string): this;
+    allowSymbols(...symbols: string[]): this;
+    memo(memo: FlowMemoInput): this;
+    dedupeWith(store: FlowDedupeStore): this;
+    ignoreZeroAmount(ignore?: boolean): this;
+    onError(handler: (error: unknown, event: TransferEvent) => void | Promise<void>): this;
+    burn(allocation: FlowAllocationInput, memo?: FlowMemoInput): this;
+    burnOnTop(allocation: FlowAllocationInput, memo?: FlowMemoInput): this;
+    forwardTo(to: string, allocation?: FlowAllocationInput, memo?: FlowMemoInput): this;
+    forwardOnTop(to: string, allocation: FlowAllocationInput, memo?: FlowMemoInput): this;
+    donateOnTop(to: string, allocation: FlowAllocationInput, memo?: FlowMemoInput): this;
+    forwardGroup(recipients: FlowGroupRecipient[], allocation: FlowAllocationInput, options?: {
+        memo?: FlowMemoInput;
+        split?: FlowGroupSplitStrategy;
+    }): this;
+    forwardGroupOnTop(recipients: FlowGroupRecipient[], allocation: FlowAllocationInput, options?: {
+        memo?: FlowMemoInput;
+        split?: FlowGroupSplitStrategy;
+    }): this;
+    remainderTo(to: string, memo?: FlowMemoInput): this;
+    remainderToGroup(recipients: FlowGroupRecipient[], options?: {
+        memo?: FlowMemoInput;
+        split?: FlowGroupSplitStrategy;
+    }): this;
+    refund(memo?: FlowMemoInput): this;
+    refundPortion(allocation: FlowAllocationInput, memo?: FlowMemoInput): this;
+    remainderToSender(memo?: FlowMemoInput): this;
+    plan(transfer: string | TransferEvent | {
+        amount?: string;
+        from?: string;
+        to?: string;
+        memo?: string;
+    }): PlannedIncomingTransferRoutes;
+    start(): FlowSubscriptionHandle;
+    private buildRoutes;
+}
+export declare class HiveTransferBuilder implements TransferOperationBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    from(account: string): this;
+    to(account: string): this;
+    amount(amount: string | number, symbol?: string): this;
+    hive(amount: string | number): this;
+    hbd(amount: string | number): this;
+    memo(memo: string): this;
+    send(): any;
+}
+export declare class HiveBurnBuilder implements BurnOperationBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    from(account: string): this;
+    amount(amount: string | number, symbol?: string): this;
+    hive(amount: string | number): this;
+    hbd(amount: string | number): this;
+    memo(memo: string): this;
+    send(): any;
+}
+export declare class HiveEscrowTransferBuilder implements EscrowTransferBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    from(account: string): this;
+    to(account: string): this;
+    agent(account: string): this;
+    id(escrowId: number): this;
+    hive(amount: string | number): this;
+    hbd(amount: string | number): this;
+    fee(amount: string | number, symbol?: string): this;
+    ratificationDeadline(value: string | Date): this;
+    expiration(value: string | Date): this;
+    jsonMeta(meta: string | Record<string, any>): this;
+    send(signingKeys?: string | string[]): any;
+}
+export declare class HiveRecurrentTransferBuilder implements RecurrentTransferBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    from(account: string): this;
+    to(account: string): this;
+    amount(amount: string | number, symbol?: string): this;
+    hive(amount: string | number): this;
+    hbd(amount: string | number): this;
+    memo(memo: string): this;
+    recurrence(value: number): this;
+    executions(value: number): this;
+    send(signingKeys?: string | string[]): any;
+}
+export declare class HiveProposalBuilder implements ProposalBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    creator(account: string): this;
+    receiver(account: string): this;
+    startDate(value: string | Date): this;
+    endDate(value: string | Date): this;
+    dailyPay(amount: string | number, symbol?: string): this;
+    dailyHive(amount: string | number): this;
+    dailyHbd(amount: string | number): this;
+    subject(value: string): this;
+    permlink(value: string): this;
+    send(signingKeys?: string | string[]): any;
+}
+export declare class HiveEngineTokenTransferBuilder implements HiveEngineTransferBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    from(account: string): this;
+    to(account: string): this;
+    symbol(symbol: string): this;
+    quantity(quantity: string | number): this;
+    memo(memo: string): this;
+    send(): any;
+}
+export declare class HiveEngineTokenBurnBuilder implements HiveEngineBurnBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    from(account: string): this;
+    symbol(symbol: string): this;
+    quantity(quantity: string | number): this;
+    memo(memo: string): this;
+    send(): any;
+}
+export declare class HiveEngineTokenIssueBuilder implements HiveEngineIssueBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    from(account: string): this;
+    to(account: string): this;
+    symbol(symbol: string): this;
+    quantity(quantity: string | number): this;
+    memo(memo: string): this;
+    send(): any;
+}
+export declare class HiveProposalVotesBuilder implements ProposalVotesBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    voter(account: string): this;
+    ids(...proposalIds: number[]): this;
+    approve(value?: boolean): this;
+    reject(): this;
+    send(signingKeys?: string | string[]): any;
+}
+export declare class HiveRemoveProposalsBuilder implements RemoveProposalsBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    owner(account: string): this;
+    ids(...proposalIds: number[]): this;
+    send(signingKeys?: string | string[]): any;
+}
+export declare class HiveVoteBuilder implements VoteBuilder {
+    private readonly streamer;
+    private readonly direction;
+    private state;
+    constructor(streamer: Streamer, direction: 'upvote' | 'downvote');
+    author(account: string): this;
+    permlink(value: string): this;
+    weight(value: string | number): this;
+    send(): any;
+}
+export declare class HiveFollowBuilder implements FollowBuilder {
+    private readonly streamer;
+    private readonly mode;
+    private state;
+    constructor(streamer: Streamer, mode: 'follow' | 'unfollow' | 'mute');
+    follower(account: string): this;
+    following(account: string): this;
+    send(): any;
+}
+export declare class HiveReblogBuilder implements ReblogBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    account(account: string): this;
+    author(account: string): this;
+    permlink(value: string): this;
+    send(): any;
+}
+export declare class HivePowerUpBuilder implements PowerUpBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    from(account: string): this;
+    to(account: string): this;
+    amount(amount: string | number): this;
+    send(): any;
+}
+export declare class HivePowerDownBuilder implements PowerDownBuilder {
+    private readonly streamer;
+    private readonly cancel;
+    private state;
+    constructor(streamer: Streamer, cancel?: boolean);
+    account(account: string): this;
+    vestingShares(amount: string): this;
+    send(): any;
+}
+export declare class HiveDelegateBuilder implements DelegateBuilder {
+    private readonly streamer;
+    private readonly undelegate;
+    private state;
+    constructor(streamer: Streamer, undelegate?: boolean);
+    delegator(account: string): this;
+    delegatee(account: string): this;
+    vestingShares(amount: string): this;
+    send(): any;
+}
+export declare class HiveClaimRewardsBuilder implements ClaimRewardsBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    account(account: string): this;
+    rewardHive(amount: string): this;
+    rewardHbd(amount: string): this;
+    rewardVests(amount: string): this;
+    send(): any;
+}
+export declare class HiveWitnessVoteBuilder implements WitnessVoteBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    account(account: string): this;
+    witness(account: string): this;
+    approve(value?: boolean): this;
+    unapprove(): this;
+    send(): any;
+}
+export declare class HiveSetProxyBuilder implements SetProxyBuilder {
+    private readonly streamer;
+    private readonly clear;
+    private state;
+    constructor(streamer: Streamer, clear?: boolean);
+    account(account: string): this;
+    proxy(account: string): this;
+    send(): any;
+}
+export declare class HiveUpdateProfileBuilder implements UpdateProfileBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    account(account: string): this;
+    name(value: string): this;
+    about(value: string): this;
+    location(value: string): this;
+    website(value: string): this;
+    profileImage(url: string): this;
+    coverImage(url: string): this;
+    set(key: string, value: any): this;
+    send(): any;
+}
+export declare class HiveSavingsTransferBuilder implements SavingsTransferBuilder {
+    private readonly streamer;
+    private readonly direction;
+    private state;
+    constructor(streamer: Streamer, direction: 'to' | 'from');
+    from(account: string): this;
+    to(account: string): this;
+    amount(amount: string | number, symbol?: string): this;
+    hive(amount: string | number): this;
+    hbd(amount: string | number): this;
+    memo(memo: string): this;
+    requestId(id: number): this;
+    send(): any;
+}
+export declare class HiveConvertBuilder implements ConvertBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    from(account: string): this;
+    amount(amount: string | number, symbol?: string): this;
+    hbd(amount: string | number): this;
+    requestId(id: number): this;
+    send(): any;
+}
+export declare class HiveCollateralizedConvertBuilder implements CollateralizedConvertBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    from(account: string): this;
+    amount(amount: string | number, symbol?: string): this;
+    hive(amount: string | number): this;
+    requestId(id: number): this;
+    send(): any;
+}
+export declare class HiveDeleteCommentBuilder implements DeleteCommentBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    author(account: string): this;
+    permlink(value: string): this;
+    send(): any;
+}
+export declare class HiveLimitOrderBuilder implements LimitOrderBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    owner(account: string): this;
+    orderId(id: number): this;
+    amountToSell(amount: string | number, symbol?: string): this;
+    minToReceive(amount: string | number, symbol?: string): this;
+    fillOrKill(value?: boolean): this;
+    expiration(value: string | Date): this;
+    send(signingKeys?: string | string[]): any;
+}
+export declare class HiveCancelOrderBuilder implements CancelOrderBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    owner(account: string): this;
+    orderId(id: number): this;
+    send(signingKeys?: string | string[]): any;
+}
+export declare class HiveWithdrawRouteBuilder implements WithdrawRouteBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    from(account: string): this;
+    to(account: string): this;
+    percent(value: number): this;
+    autoVest(value?: boolean): this;
+    send(signingKeys?: string | string[]): any;
+}
+export declare class HiveCommentOptionsBuilder implements CommentOptionsBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    author(account: string): this;
+    permlink(value: string): this;
+    maxAcceptedPayout(amount: string | number, symbol?: string): this;
+    percentHbd(value: number): this;
+    allowVotes(value?: boolean): this;
+    allowCurationRewards(value?: boolean): this;
+    beneficiary(account: string, weight: number): this;
+    send(): any;
+}
+export declare class HivePostBuilder implements PostBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    author(account: string): this;
+    title(value: string): this;
+    body(value: string): this;
+    permlink(value: string): this;
+    tags(...tags: string[]): this;
+    community(name: string): this;
+    parentAuthor(account: string): this;
+    parentPermlink(value: string): this;
+    beneficiary(account: string, weight: number): this;
+    maxAcceptedPayout(amount: string | number, symbol?: string): this;
+    percentHbd(value: number): this;
+    allowVotes(value?: boolean): this;
+    allowCurationRewards(value?: boolean): this;
+    app(name: string): this;
+    format(value: string): this;
+    description(value: string): this;
+    image(...urls: string[]): this;
+    metadata(key: string, value: any): this;
+    send(): any;
+}
+export declare class HiveBatchBuilder implements BatchBuilder {
+    private readonly streamer;
+    private operations;
+    constructor(streamer: Streamer);
+    add(operation: [string, any]): this;
+    transfer(from: string, to: string, amount: string, memo?: string): this;
+    vote(voter: string, author: string, permlink: string, weight: number): this;
+    customJson(id: string, json: any, postingAuth?: string, activeAuth?: string): this;
+    comment(author: string, permlink: string, parentAuthor: string, parentPermlink: string, title: string, body: string, jsonMetadata?: string): this;
+    send(signingKeys?: string | string[]): any;
+}
+export declare class HiveEngineStakeBuilder implements EngineStakeBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    from(account: string): this;
+    to(account: string): this;
+    symbol(symbol: string): this;
+    quantity(quantity: string | number): this;
+    send(): any;
+}
+export declare class HiveEngineUnstakeBuilder implements EngineUnstakeBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    from(account: string): this;
+    symbol(symbol: string): this;
+    quantity(quantity: string | number): this;
+    send(): any;
+}
+export declare class HiveEngineMarketOrderBuilder implements EngineMarketOrderBuilder {
+    private readonly streamer;
+    private readonly side;
+    private state;
+    constructor(streamer: Streamer, side: 'buy' | 'sell');
+    from(account: string): this;
+    symbol(symbol: string): this;
+    quantity(quantity: string | number): this;
+    price(price: string | number): this;
+    send(): any;
+}
+export declare class HiveEngineCancelOrderBuilder implements EngineCancelOrderBuilder {
+    private readonly streamer;
+    private state;
+    constructor(streamer: Streamer);
+    from(account: string): this;
+    type(type: 'buy' | 'sell'): this;
+    orderId(id: string): this;
+    send(): any;
+}
+export declare class HiveEngineDelegateBuilder implements EngineDelegateBuilder {
+    private readonly streamer;
+    private readonly undelegate;
+    private state;
+    constructor(streamer: Streamer, undelegate?: boolean);
+    from(account: string): this;
+    to(account: string): this;
+    symbol(symbol: string): this;
+    quantity(quantity: string | number): this;
+    send(): any;
+}
+export declare class HiveCommunityOperationBuilder implements CommunityOperationBuilder {
+    private readonly streamer;
+    private readonly action;
+    private state;
+    constructor(streamer: Streamer, action: 'subscribe' | 'unsubscribe');
+    account(account: string): this;
+    community(name: string): this;
+    send(): any;
+}