Class SignerDogePrivateKey

A class extending SignerDoge that provides access to a Doge address.

Hierarchy (View Summary)

SignerDoge
- SignerDogePrivateKey

Constructors

constructor

new SignerDogePrivateKey(
    client: Client,
    privateKey: BytesLike,
    dogeNetwork?: number,
): SignerDogePrivateKey
Creates an instance of SignerDogePrivateKey
Parameters
- client: Client
  The client instance used for communication.
- privateKey: BytesLike
  The Doge private key with the signer.
- dogeNetwork: number = 0x1e
Returns SignerDogePrivateKey
Overrides SignerDoge.constructor
- Defined in signer/doge/signerDogePrivateKey.ts:28

Properties

`Readonly`dogeNetwork

dogeNetwork: number = 0x1e

`Protected`client_

client_: Client

The client used to interact with the CKB network.

Accessors

client

get client(): Client
Gets the client associated with this fee payer.

Returns Client
Inherited from SignerDoge.client
- Defined in feePayer/feePayer.ts:44

type

get type(): SignerType
Returns SignerType
Inherited from SignerDoge.type
- Defined in signer/doge/signerDoge.ts:17

signType

get signType(): SignerSignType
Returns SignerSignType
Inherited from SignerDoge.signType
- Defined in signer/doge/signerDoge.ts:21

Methods

getFeeRate

getFeeRate(options?: FeePayerGetFeeRateOptionsLike): Promise<bigint>
Gets the fee rate for the transaction.
Parameters
- Optionaloptions: FeePayerGetFeeRateOptionsLike
  Optional configuration for getting the fee rate.
Returns Promise<bigint>
A promise that resolves to the fee rate.
Inherited from SignerDoge.getFeeRate
- Defined in feePayer/feePayer.ts:107

completeFeeChangeTo

completeFeeChangeTo(
    txLike: TransactionLike,
    change: FeePayerCompleteFeeChangeFn,
    options?:
        | null
        | { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
            filter?: ClientCollectableSearchKeyFilterLike;
            shouldAddInputs?: boolean;
        },
): Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
Completes the transaction fee by applying a custom change function.
Parameters
- txLike: TransactionLike
  The transaction to complete the fee for.
- change: FeePayerCompleteFeeChangeFn
  A function that modifies the transaction to handle the change.
- Optionaloptions:
      | null
      | { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
          filter?: ClientCollectableSearchKeyFilterLike;
          shouldAddInputs?: boolean;
      }
  - null
  - { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
    filter?: ClientCollectableSearchKeyFilterLike;
    shouldAddInputs?: boolean;
    }
    OptionalfeeRate?: NumLike
    The fee rate to use. If provided, the fee payer will not fetch the fee rate from the client.
    
    OptionalfeeRateBlockRange?: NumLike
    The block range to use for calculating the fee rate.
    
    OptionalmaxFeeRate?: NumLike
    The maximum allowed fee rate.
    
    Optionalfilter?: ClientCollectableSearchKeyFilterLike
    The filter to use when searching for cells.
    
    OptionalshouldAddInputs?: boolean
    Whether to add inputs automatically to cover the fee. Defaults to true.
Returns Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
A promise that resolves to the transaction with the fee paid, whether it was modified, and the operation context.
Inherited from SignerDoge.completeFeeChangeTo
- Defined in feePayer/feePayer.ts:121

completeFeeChangeToLock

completeFeeChangeToLock(
    txLike: TransactionLike,
    change: ScriptLike,
    options?:
        | null
        | { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
            filter?: ClientCollectableSearchKeyFilterLike;
            shouldAddInputs?: boolean;
        },
): Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
Completes the transaction fee by adding inputs and creating a change output with the specified lock script. This is a convenience method that automatically creates a change cell with the provided lock script when there's excess capacity after paying the transaction fee.
Parameters
- txLike: TransactionLike
  The transaction to complete the fee for.
- change: ScriptLike
  The lock script for the change output cell.
- Optionaloptions:
      | null
      | { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
          filter?: ClientCollectableSearchKeyFilterLike;
          shouldAddInputs?: boolean;
      }
  Optional configuration for completing the fee.
  - null
  - { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
    filter?: ClientCollectableSearchKeyFilterLike;
    shouldAddInputs?: boolean;
    }
    OptionalfeeRate?: NumLike
    The fee rate to use. If provided, the fee payer will not fetch the fee rate from the client.
    
    OptionalfeeRateBlockRange?: NumLike
    The block range to use for calculating the fee rate.
    
    OptionalmaxFeeRate?: NumLike
    The maximum allowed fee rate.
    
    Optionalfilter?: ClientCollectableSearchKeyFilterLike
    The filter to use when searching for cells.
    
    OptionalshouldAddInputs?: boolean
    Whether to add inputs automatically to cover the fee. Defaults to true.
Returns Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
A promise that resolves to the transaction with the fee paid, whether it was modified, and the operation context.
Example
```
const changeScript = Script.from({
  codeHash: "0x...",
  hashType: "type",
  args: "0x..."
});

const { hasChanged } = await feePayer.completeFeeChangeToLock(
  tx,
  changeScript,
);
```
Inherited from SignerDoge.completeFeeChangeToLock
- Defined in feePayer/feePayer.ts:254

completeFeeChangeToOutput

completeFeeChangeToOutput(
    txLike: TransactionLike,
    index: NumLike,
    options?:
        | null
        | { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
            filter?: ClientCollectableSearchKeyFilterLike;
            shouldAddInputs?: boolean;
        },
): Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
Completes the transaction fee by adding excess capacity to an existing output. Instead of creating a new change output, this method adds any excess capacity to the specified existing output in the transaction.
Parameters
- txLike: TransactionLike
  The transaction to complete the fee for.
- index: NumLike
  The index of the existing output to add excess capacity to.
- Optionaloptions:
      | null
      | { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
          filter?: ClientCollectableSearchKeyFilterLike;
          shouldAddInputs?: boolean;
      }
  Optional configuration for completing the fee.
  - null
  - { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
    filter?: ClientCollectableSearchKeyFilterLike;
    shouldAddInputs?: boolean;
    }
    OptionalfeeRate?: NumLike
    The fee rate to use. If provided, the fee payer will not fetch the fee rate from the client.
    
    OptionalfeeRateBlockRange?: NumLike
    The block range to use for calculating the fee rate.
    
    OptionalmaxFeeRate?: NumLike
    The maximum allowed fee rate.
    
    Optionalfilter?: ClientCollectableSearchKeyFilterLike
    The filter to use when searching for cells.
    
    OptionalshouldAddInputs?: boolean
    Whether to add inputs automatically to cover the fee. Defaults to true.
Returns Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
A promise that resolves to the transaction with the fee paid, whether it was modified, and the operation context.
Throws
When the specified output index doesn't exist.
Example
```
// Add excess capacity to the first output (index 0)
const { hasChanged } = await feePayer.completeFeeChangeToOutput(
  tx,
  0, // Output index
);
```
Inherited from SignerDoge.completeFeeChangeToOutput
- Defined in feePayer/feePayer.ts:302

getAddresses

getAddresses(): Promise<string[]>
Gets an array of addresses associated with the signer as strings.

Returns Promise<string[]>
A promise that resolves to an array of addresses as strings.
Inherited from SignerDoge.getAddresses
- Defined in feePayer/feePayerFromAddress.ts:37

getRecommendedAddressObj

getRecommendedAddressObj(_preference?: unknown): Promise<Address>
Gets the recommended Address object for the signer.
Parameters
- Optional_preference: unknown
  Optional preference parameter.
Returns Promise<Address>
A promise that resolves to the recommended Address object.
Inherited from SignerDoge.getRecommendedAddressObj
- Defined in feePayer/feePayerFromAddress.ts:49

getRecommendedAddress

getRecommendedAddress(preference?: unknown): Promise<string>
Gets the recommended address for the signer as a string.
Parameters
- Optionalpreference: unknown
  Optional preference parameter.
Returns Promise<string>
A promise that resolves to the recommended address as a string.
Inherited from SignerDoge.getRecommendedAddress
- Defined in feePayer/feePayerFromAddress.ts:59

completeInputs

completeInputs<T>(
    txLike: TransactionLike,
    accumulator: (
        acc: T,
        v: Cell,
        i: number,
        array: Cell[],
    ) => undefined | T | Promise<undefined | T>,
    init: T,
    options?: FeePayerCompleteInputsOptionsLike,
): Promise<
    { tx: Transaction } & FeePayerCompleteInputsContext & {
        accumulated?: T;
    },
>
Completes transaction inputs by searching for cells associated with the fee payer's addresses.
Type Parameters
- T
Parameters
- txLike: TransactionLike
  The transaction to complete inputs for.
- accumulator: (
      acc: T,
      v: Cell,
      i: number,
      array: Cell[],
  ) => undefined | T | Promise<undefined | T>
  A function that accumulates cells until a condition is met.
- init: T
  The initial value for the accumulator.
- Optionaloptions: FeePayerCompleteInputsOptionsLike
  Optional configuration for completing inputs.
Returns Promise<
    { tx: Transaction } & FeePayerCompleteInputsContext & {
        accumulated?: T;
    },
>
A promise that resolves to the result of completing inputs.
Inherited from SignerDoge.completeInputs
- Defined in feePayer/feePayerFromAddress.ts:72

completeInputsByCapacity

completeInputsByCapacity(
    txLike: TransactionLike,
    capacityTweak?: NumLike,
    options?: FeePayerCompleteInputsOptionsLike,
): Promise<FeePayerCompleteInputsResult>
Completes transaction inputs to satisfy a required capacity.
Parameters
- txLike: TransactionLike
  The transaction to complete inputs for.
- OptionalcapacityTweak: NumLike
  Optional additional capacity needed.
- Optionaloptions: FeePayerCompleteInputsOptionsLike
  Optional configuration for completing inputs.
Returns Promise<FeePayerCompleteInputsResult>
A promise that resolves to the result of completing inputs.
Inherited from SignerDoge.completeInputsByCapacity
- Defined in feePayer/feePayerFromAddress.ts:157

completeInputsAll

completeInputsAll(
txLike: TransactionLike,
options?: FeePayerCompleteInputsOptionsLike,
): Promise<FeePayerCompleteInputsResult>
Completes transaction inputs by adding all available cells from the fee payer.
Parameters
- txLike: TransactionLike
  The transaction to complete inputs for.
- Optionaloptions: FeePayerCompleteInputsOptionsLike
  Optional configuration for completing inputs.
Returns Promise<FeePayerCompleteInputsResult>
A promise that resolves to the result of completing inputs.
Inherited from SignerDoge.completeInputsAll
- Defined in feePayer/feePayerFromAddress.ts:189

completeInputsAddOne

completeInputsAddOne(
txLike: TransactionLike,
options?: FeePayerCompleteInputsOptionsLike,
): Promise<FeePayerCompleteInputsResult>
Completes transaction inputs by adding exactly one more cell.
Parameters
- txLike: TransactionLike
  The transaction to complete inputs for.
- Optionaloptions: FeePayerCompleteInputsOptionsLike
  Optional configuration for completing inputs.
Returns Promise<FeePayerCompleteInputsResult>
A promise that resolves to the result of completing inputs.
Inherited from SignerDoge.completeInputsAddOne
- Defined in feePayer/feePayerFromAddress.ts:208

completeInputsAtLeastOne

completeInputsAtLeastOne(
txLike: TransactionLike,
options?: FeePayerCompleteInputsOptionsLike,
): Promise<FeePayerCompleteInputsResult>
Completes transaction inputs by adding at least one cell if no inputs exist.
Parameters
- txLike: TransactionLike
  The transaction to complete inputs for.
- Optionaloptions: FeePayerCompleteInputsOptionsLike
  Optional configuration for completing inputs.
Returns Promise<FeePayerCompleteInputsResult>
A promise that resolves to the result of completing inputs.
Inherited from SignerDoge.completeInputsAtLeastOne
- Defined in feePayer/feePayerFromAddress.ts:233

collectCapacity

collectCapacity(
    txLike: TransactionLike,
    capacityTweak?: NumLike,
    options?: FeePayerCompleteInputsOptionsLike,
    contextLike?: FeePayerCompleteInputsContext,
): Promise<
    FeePayerCollectCapacityResult<FeePayerCompleteInputsContext> & {
        expectedCapacity: bigint;
        accumulated?: bigint;
    },
>
Collects capacity for the transaction from the fee payer's addresses.
Parameters
- txLike: TransactionLike
  The transaction to collect capacity for.
- OptionalcapacityTweak: NumLike
  Optional additional capacity needed.
- Optionaloptions: FeePayerCompleteInputsOptionsLike
  Optional configuration for completing inputs.
- OptionalcontextLike: FeePayerCompleteInputsContext
  Optional context for completing inputs.
Returns Promise<
    FeePayerCollectCapacityResult<FeePayerCompleteInputsContext> & {
        expectedCapacity: bigint;
        accumulated?: bigint;
    },
>
A promise that resolves to the result of collecting capacity, including the total capacity collected from added inputs.

Remarks
This method attempts to collect sufficient capacity to meet the requirement (outputs capacity plus capacityTweak). If the requirement cannot be fully met, it adds as many inputs as possible to minimize the deficit and does NOT throw an error. This behavior enables multiple fee payers to collaborate in providing the necessary capacity.
Inherited from SignerDoge.collectCapacity
- Defined in feePayer/feePayerFromAddress.ts:263

completeFee

completeFee(
    txLike: TransactionLike,
    options?:
        | null
        | { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
            filter?: ClientCollectableSearchKeyFilterLike;
            shouldAddInputs?: boolean;
        },
): Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
Completes the transaction fee by adding a change output to a recommended address.
Parameters
- txLike: TransactionLike
  The transaction to complete the fee for.
- Optionaloptions:
      | null
      | { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
          filter?: ClientCollectableSearchKeyFilterLike;
          shouldAddInputs?: boolean;
      }
  Optional configuration for completing the fee.
  - null
  - { feeRate?: NumLike; feeRateBlockRange?: NumLike; maxFeeRate?: NumLike } & {
    filter?: ClientCollectableSearchKeyFilterLike;
    shouldAddInputs?: boolean;
    }
    OptionalfeeRate?: NumLike
    The fee rate to use. If provided, the fee payer will not fetch the fee rate from the client.
    
    OptionalfeeRateBlockRange?: NumLike
    The block range to use for calculating the fee rate.
    
    OptionalmaxFeeRate?: NumLike
    The maximum allowed fee rate.
    
    Optionalfilter?: ClientCollectableSearchKeyFilterLike
    The filter to use when searching for cells.
    
    OptionalshouldAddInputs?: boolean
    Whether to add inputs automatically to cover the fee. Defaults to true.
Returns Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>
A promise that resolves to the transaction with the fee paid, whether it was modified, and the operation context.
Inherited from SignerDoge.completeFee
- Defined in feePayer/feePayerFromAddress.ts:325

getInternalAddress

getInternalAddress(): Promise<string>
Gets the internal address, which is the Doge account in this case.

Returns Promise<string>
A promise that resolves to a string representing the internal address.
Inherited from SignerDoge.getInternalAddress
- Defined in signer/doge/signerDoge.ts:37

getIdentity

getIdentity(): Promise<string>
Gets the identity, which is the Doge address in this case.

Returns Promise<string>
A promise that resolves to a string representing the identity
Inherited from SignerDoge.getIdentity
- Defined in signer/doge/signerDoge.ts:46

getAddressObjs

getAddressObjs(): Promise<Address[]>
Gets an array of Address objects representing the known script addresses for the signer.

Returns Promise<Address[]>
A promise that resolves to an array of Address objects.
Inherited from SignerDoge.getAddressObjs
- Defined in signer/doge/signerDoge.ts:55

prepareTransaction

prepareTransaction(txLike: TransactionLike): Promise<Transaction>
prepare a transaction before signing. This method is not implemented and should be overridden by subclasses.
Parameters
- txLike: TransactionLike
  The transaction to prepare, represented as a TransactionLike object.
Returns Promise<Transaction>
A promise that resolves to the prepared Transaction object.
Inherited from SignerDoge.prepareTransaction
- Defined in signer/doge/signerDoge.ts:73

signOnlyTransaction

signOnlyTransaction(txLike: TransactionLike): Promise<Transaction>
Signs a transaction without modifying it.
Parameters
- txLike: TransactionLike
  The transaction to sign, represented as a TransactionLike object.
Returns Promise<Transaction>
A promise that resolves to a signed Transaction object.
Inherited from SignerDoge.signOnlyTransaction
- Defined in signer/doge/signerDoge.ts:87

connect

connect(): Promise<void>
Connects to the client. This implementation does nothing as the class is always connected.

Returns Promise<void>
A promise that resolves when the connection is complete.
Overrides SignerDoge.connect
- Defined in signer/doge/signerDogePrivateKey.ts:45

isConnected

isConnected(): Promise<boolean>
Check if the signer is connected.

Returns Promise<boolean>
A promise that resolves the connection status.
Overrides SignerDoge.isConnected
- Defined in signer/doge/signerDogePrivateKey.ts:52

getDogePublicKey

getDogePublicKey(): Promise<`0x${string}`>
Returns Promise<`0x${string}`>
- Defined in signer/doge/signerDogePrivateKey.ts:56

getDogeAddress

getDogeAddress(): Promise<string>
Gets the Doge address associated with the signer.

Returns Promise<string>
A promise that resolves to a string representing the Doge address.
Example
```
const account = await signer.getDogeAddress(); // Outputs the Doge address
```
Overrides SignerDoge.getDogeAddress
- Defined in signer/doge/signerDogePrivateKey.ts:70

signMessageRaw

signMessageRaw(msg: BytesLike): Promise<string>
Signs a message and returns signature only.
Parameters
- msg: BytesLike
  The message to sign, as a string or BytesLike object.
Returns Promise<string>
A promise that resolves to the signature as a string.

Throws
Will throw an error if not implemented.
Overrides SignerDoge.signMessageRaw
- Defined in signer/doge/signerDogePrivateKey.ts:84

matchNetworkPreference

matchNetworkPreference(
preferences: NetworkPreference[],
currentNetwork: undefined | string,
): undefined | NetworkPreference
Parameters
- preferences: NetworkPreference[]
- currentNetwork: undefined | string
Returns undefined | NetworkPreference
Inherited from SignerDoge.matchNetworkPreference
- Defined in signer/signer/index.ts:91

`Static`verifyMessage

verifyMessage(message: BytesLike, signature: Signature): Promise<boolean>
Parameters
- message: BytesLike
- signature: Signature
Returns Promise<boolean>
Inherited from SignerDoge.verifyMessage
- Defined in signer/signer/index.ts:112

onReplaced

onReplaced(_: () => void): () => void
Register a listener to be called when this signer is replaced.
Parameters
- _: () => void
Returns () => void
A function for unregister
Inherited from SignerDoge.onReplaced
- Defined in signer/signer/index.ts:170

disconnect

disconnect(): Promise<void>
Disconnects to the signer.

Returns Promise<void>
A promise that resolves when the signer is disconnected.
Inherited from SignerDoge.disconnect
- Defined in signer/signer/index.ts:179

findCellsOnChain

findCellsOnChain(
    filter: ClientIndexerSearchKeyFilterLike,
    withData?: null | boolean,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<Cell>
Find cells of this signer
Parameters
- filter: ClientIndexerSearchKeyFilterLike
  The filter for the search key.
- OptionalwithData: null | boolean
  Whether to include cell data in the response.
- Optionalorder: "asc" | "desc"
  The order of the returned cells, can be "asc" or "desc".
- Optionallimit: number
  The maximum number of cells for every querying chunk.
Returns AsyncGenerator<Cell>
A async generator that yields all matching cells
Inherited from SignerDoge.findCellsOnChain
- Defined in signer/signer/index.ts:213

findCells

findCells(
    filter: ClientCollectableSearchKeyFilterLike,
    withData?: null | boolean,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<Cell>
Find cells of this signer
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- OptionalwithData: null | boolean
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<Cell>
A async generator that yields all matches cells
Inherited from SignerDoge.findCells
- Defined in signer/signer/index.ts:242

findTransactions

findTransactions(
    filter: ClientCollectableSearchKeyFilterLike,
    groupByTransaction?: null | false,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    },
>
Find transactions of this signer
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- OptionalgroupByTransaction: null | false
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    },
>
A async generator that yields all matches transactions
Inherited from SignerDoge.findTransactions
- Defined in signer/signer/index.ts:271
findTransactions(
    filter: ClientCollectableSearchKeyFilterLike,
    groupByTransaction: true,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
Find transactions of this signer
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- groupByTransaction: true
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<
    {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
A async generator that yields all matches transactions
Inherited from SignerDoge.findTransactions
- Defined in signer/signer/index.ts:282
findTransactions(
    filter: ClientCollectableSearchKeyFilterLike,
    groupByTransaction?: null | boolean,
    order?: "asc" | "desc",
    limit?: number,
): AsyncGenerator<
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    }
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
Find transactions of this signer
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- OptionalgroupByTransaction: null | boolean
- Optionalorder: "asc" | "desc"
- Optionallimit: number
Returns AsyncGenerator<
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        isInput: boolean;
        cellIndex: bigint;
    }
    | {
        txHash: `0x${string}`;
        blockNumber: bigint;
        txIndex: bigint;
        cells: { isInput: boolean; cellIndex: bigint }[];
    },
>
A async generator that yields all matches transactions
Inherited from SignerDoge.findTransactions
- Defined in signer/signer/index.ts:293

getBalance

getBalance(): Promise<bigint>
Gets balance of all addresses

Returns Promise<bigint>
A promise that resolves to the balance
Inherited from SignerDoge.getBalance
- Defined in signer/signer/index.ts:339

signMessage

signMessage(message: BytesLike): Promise<Signature>
Signs a message.
Parameters
- message: BytesLike
  The message to sign, as a string or BytesLike object.
Returns Promise<Signature>
A promise that resolves to the signature info.

Throws
Will throw an error if not implemented.
Inherited from SignerDoge.signMessage
- Defined in signer/signer/index.ts:352

verifyMessage

verifyMessage(
message: BytesLike,
signature: string | Signature,
): Promise<boolean>
Verify a signature.
Parameters
- message: BytesLike
  The original message.
- signature: string | Signature
  The signature to verify.
Returns Promise<boolean>
A promise that resolves to the verification result.

Throws
Will throw an error if not implemented.
Inherited from SignerDoge.verifyMessage
- Defined in signer/signer/index.ts:379

sendTransaction

sendTransaction(tx: TransactionLike): Promise<`0x${string}`>
Sends a transaction after signing it.
Parameters
- tx: TransactionLike
  The transaction to send, represented as a TransactionLike object.
Returns Promise<`0x${string}`>
A promise that resolves to the transaction hash as a Hex string.
Inherited from SignerDoge.sendTransaction
- Defined in signer/signer/index.ts:407

signTransaction

signTransaction(tx: TransactionLike): Promise<Transaction>
Signs a transaction.
Parameters
- tx: TransactionLike
  The transaction to sign, represented as a TransactionLike object.
Returns Promise<Transaction>
A promise that resolves to the signed Transaction object.
Inherited from SignerDoge.signTransaction
- Defined in signer/signer/index.ts:417

Class SignerDogePrivateKey

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SignerDogePrivateKey

Properties

ReadonlydogeNetwork

Protectedclient_

Accessors

client

Returns Client

type

Returns SignerType

signType

Returns SignerSignType

Methods

getFeeRate

Parameters

Returns Promise<bigint>

completeFeeChangeTo

Parameters

OptionalfeeRate?: NumLike

OptionalfeeRateBlockRange?: NumLike

OptionalmaxFeeRate?: NumLike

Optionalfilter?: ClientCollectableSearchKeyFilterLike

OptionalshouldAddInputs?: boolean

Returns Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>

completeFeeChangeToLock

Parameters

OptionalfeeRate?: NumLike

OptionalfeeRateBlockRange?: NumLike

OptionalmaxFeeRate?: NumLike

Optionalfilter?: ClientCollectableSearchKeyFilterLike

OptionalshouldAddInputs?: boolean

Returns Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>

Example

completeFeeChangeToOutput

Parameters

OptionalfeeRate?: NumLike

OptionalfeeRateBlockRange?: NumLike

OptionalmaxFeeRate?: NumLike

Optionalfilter?: ClientCollectableSearchKeyFilterLike

OptionalshouldAddInputs?: boolean

Returns Promise<FeePayerCompleteFeeResult<FeePayerCompleteInputsContext>>

Throws

Example

getAddresses

Returns Promise<string[]>

getRecommendedAddressObj

Parameters

Returns Promise<Address>

getRecommendedAddress

Parameters

Returns Promise<string>

completeInputs

Type Parameters

Parameters

Returns Promise< { tx: Transaction } & FeePayerCompleteInputsContext & { accumulated?: T; },>

completeInputsByCapacity

Parameters

Returns Promise<FeePayerCompleteInputsResult>

completeInputsAll

Parameters

Returns Promise<FeePayerCompleteInputsResult>

completeInputsAddOne

Parameters

Returns Promise<FeePayerCompleteInputsResult>

completeInputsAtLeastOne

Parameters

Returns Promise<FeePayerCompleteInputsResult>

collectCapacity

Parameters

Returns Promise< FeePayerCollectCapacityResult<FeePayerCompleteInputsContext> & { expectedCapacity: bigint; accumulated?: bigint; },>

Remarks

`Readonly`dogeNetwork

`Protected`client_

`Optional`feeRate?: NumLike

`Optional`feeRateBlockRange?: NumLike

`Optional`maxFeeRate?: NumLike

`Optional`filter?: ClientCollectableSearchKeyFilterLike

`Optional`shouldAddInputs?: boolean

`Optional`feeRate?: NumLike

`Optional`feeRateBlockRange?: NumLike

`Optional`maxFeeRate?: NumLike

`Optional`filter?: ClientCollectableSearchKeyFilterLike

`Optional`shouldAddInputs?: boolean

`Optional`feeRate?: NumLike

`Optional`feeRateBlockRange?: NumLike

`Optional`maxFeeRate?: NumLike

`Optional`filter?: ClientCollectableSearchKeyFilterLike

`Optional`shouldAddInputs?: boolean

Returns Promise<
{ tx: Transaction } & FeePayerCompleteInputsContext & {
accumulated?: T;
},
>

Returns Promise<
FeePayerCollectCapacityResult<FeePayerCompleteInputsContext> & {
expectedCapacity: bigint;
accumulated?: bigint;
},
>

`Optional`feeRate?: NumLike

`Optional`feeRateBlockRange?: NumLike

`Optional`maxFeeRate?: NumLike

`Optional`filter?: ClientCollectableSearchKeyFilterLike

`Optional`shouldAddInputs?: boolean

`Static`verifyMessage

Returns AsyncGenerator<
{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
isInput: boolean;
cellIndex: bigint;
},
>

Returns AsyncGenerator<
{
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
cells: { isInput: boolean; cellIndex: bigint }[];
},
>

Returns AsyncGenerator<
| {
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
isInput: boolean;
cellIndex: bigint;
}
| {
txHash: `0x${string}`;
blockNumber: bigint;
txIndex: bigint;
cells: { isInput: boolean; cellIndex: bigint }[];
},
>