Class SignerDogePrivateKey

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

Hierarchy (view full)

SignerDoge
- SignerDogePrivateKey

Constructors

constructor

new SignerDogePrivateKey(client, privateKey, dogeNetwork?): 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

Accessors

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

client

get client(): Client
Returns Client
Inherited from SignerDoge.client
- Defined in signer/signer/index.ts:86

Methods

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<ccc.Address[]>
Gets an array of Address objects representing the known script addresses for the signer.

Returns Promise<ccc.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): 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): 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): 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, currentNetwork): undefined | NetworkPreference
Parameters
- preferences: NetworkPreference[]
- currentNetwork: undefined | string
Returns undefined | NetworkPreference
Inherited from SignerDoge.matchNetworkPreference
- Defined in signer/signer/index.ts:92

`Static`verifyMessage

verifyMessage(message, 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)
Register a listener to be called when this signer is replaced.
Parameters
- _: (() => void)
  - - (): void
    - Returns void
Returns (() => void)
A function for unregister
- - (): void
  - Returns void
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

getRecommendedAddressObj

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

getRecommendedAddress

getRecommendedAddress(preference?): 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 signer/signer/index.ts:227

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 signer/signer/index.ts:236

findCells

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

findTransactions

findTransactions(filter, groupByTransaction?, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
}, any, unknown>
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;
}, any, unknown>
A async generator that yields all matches transactions
Inherited from SignerDoge.findTransactions
- Defined in signer/signer/index.ts:276
findTransactions(filter, groupByTransaction, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, unknown>
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;
    }[];
}, any, unknown>
A async generator that yields all matches transactions
Inherited from SignerDoge.findTransactions
- Defined in signer/signer/index.ts:287
findTransactions(filter, groupByTransaction?, order?, limit?): AsyncGenerator<{
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    isInput: boolean;
    cellIndex: bigint;
} | {
    txHash: `0x${string}`;
    blockNumber: bigint;
    txIndex: bigint;
    cells: {
        isInput: boolean;
        cellIndex: bigint;
    }[];
}, any, unknown>
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;
    }[];
}, any, unknown>
A async generator that yields all matches transactions
Inherited from SignerDoge.findTransactions
- Defined in signer/signer/index.ts:298

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:344

signMessage

signMessage(message): 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:357

verifyMessage

verifyMessage(message, 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:384

sendTransaction

sendTransaction(tx): 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:412

signTransaction

signTransaction(tx): 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:422

Class SignerDogePrivateKey

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SignerDogePrivateKey

Properties

ReadonlydogeNetwork

Protectedclient_

Accessors

type

Returns SignerType

signType

Returns SignerSignType

client

Returns Client

Methods

getInternalAddress

Returns Promise<string>

getIdentity

Returns Promise<string>

getAddressObjs

Returns Promise<ccc.Address[]>

prepareTransaction

Parameters

Returns Promise<Transaction>

signOnlyTransaction

Parameters

Returns Promise<Transaction>

connect

Returns Promise<void>

isConnected

Returns Promise<boolean>

getDogePublicKey

Returns Promise<`0x${string}`>

getDogeAddress

Returns Promise<string>

Example

signMessageRaw

Parameters

Returns Promise<string>

Throws

matchNetworkPreference

Parameters

Returns undefined | NetworkPreference

StaticverifyMessage

Parameters

Returns Promise<boolean>

onReplaced

Parameters

Returns void

Returns (() => void)

Returns void

disconnect

Returns Promise<void>

getRecommendedAddressObj

Parameters

Returns Promise<ccc.Address>

getRecommendedAddress

Parameters

Returns Promise<string>

getAddresses

Returns Promise<string[]>

findCells

Parameters

Returns AsyncGenerator<Cell, any, unknown>

findTransactions

Parameters

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

Parameters

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

Parameters

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; }[]; }, any, unknown>

getBalance

Returns Promise<bigint>

`Readonly`dogeNetwork

`Protected`client_

`Static`verifyMessage

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

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

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;
}[];
}, any, unknown>