@arkade-os/sdk Documentation - v0.4.21
    Preparing search index...

    Interface IDelegatorManager

    interface IDelegatorManager {
        delegate(
            vtxos: ContractVtxo[],
            destination: string,
            delegateAt?: Date,
        ): Promise<
            {
                delegated: Outpoint[];
                failed: { error: unknown; outpoints: Outpoint[] }[];
            },
        >;
        getDelegateInfo(): Promise<DelegateInfo>;
    }

    Implemented by

    Index

    Methods

    • Delegate virtual outputs to the remote delegation service.

      Vtxos that are not locked to a delegate-type contract (no tap leaf matches the delegator's pubkey) are filtered out silently, since they cannot be co-signed by the delegator.

      Parameters

      • vtxos: ContractVtxo[]

        Virtual outputs to delegate

      • destination: string

        Arkade address that should receive renewed funds

      • OptionaldelegateAt: Date

        Optional timestamp to force a specific delegation time

      Returns Promise<
          {
              delegated: Outpoint[];
              failed: { error: unknown; outpoints: Outpoint[] }[];
          },
      >

      Successfully delegated and failed outpoint groups