Class SignerNostr`Abstract`

An abstract class representing a generic signer. This class provides methods to connect, get addresses, and sign transactions.

Hierarchy (view full)

ccc.Signer
- SignerNostr

Constructors

constructor

new SignerNostr(client_): SignerNostr
Parameters
- client_: Client
Returns SignerNostr
Inherited from Signer.constructor
- Defined in signer/signer/index.ts:74

Properties

`Static`CKB_SIG_HASH_ALL_TAG

CKB_SIG_HASH_ALL_TAG: string = "ckb_sighash_all"

`Static`CKB_UNLOCK_EVENT_KIND

CKB_UNLOCK_EVENT_KIND: number = 23334

`Static`CKB_UNLOCK_EVENT_CONTENT

CKB_UNLOCK_EVENT_CONTENT: string = "Signing a CKB transaction\n\nIMPORTANT: Please verify the integrity and authenticity of connected Nostr client before signing this message\n"

`Protected`client_

client_: Client

Accessors

type

get type(): SignerType
Returns SignerType
Overrides Signer.type
- Defined in signer/nostr/signerNostr.ts:33

signType

get signType(): SignerSignType
Returns SignerSignType
Overrides Signer.signType
- Defined in signer/nostr/signerNostr.ts:37

client

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

Methods

`Abstract`getNostrPublicKey

getNostrPublicKey(): Promise<`0x${string}`>
Gets the Nostr public key associated with the signer.

Returns Promise<`0x${string}`>
A promise that resolves to a string representing the Nostr public key.
- Defined in signer/nostr/signerNostr.ts:46

`Abstract`signNostrEvent

signNostrEvent(event): Promise<Required<NostrEvent>>
Sign a nostr event.
Parameters
- event: NostrEvent
Returns Promise<Required<NostrEvent>>
A promise that resolves to the signed event.
- Defined in signer/nostr/signerNostr.ts:53

signMessageRaw

signMessageRaw(message): Promise<`0x${string}`>
Sign a message.
Parameters
- message: BytesLike
Returns Promise<`0x${string}`>
A promise that resolves to the signature.
Overrides Signer.signMessageRaw
- Defined in signer/nostr/signerNostr.ts:60

getInternalAddress

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

Returns Promise<string>
A promise that resolves to a string representing the internal address.
Overrides Signer.getInternalAddress
- Defined in signer/nostr/signerNostr.ts:71

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.
Overrides Signer.getAddressObjs
- Defined in signer/nostr/signerNostr.ts:83

prepareTransaction

prepareTransaction(txLike): Promise<ccc.Transaction>
prepare a transaction before signing.
Parameters
- txLike: TransactionLike
  The transaction to prepare, represented as a TransactionLike object.
Returns Promise<ccc.Transaction>
A promise that resolves to the prepared Transaction object.
Overrides Signer.prepareTransaction
- Defined in signer/nostr/signerNostr.ts:100

signOnlyTransaction

signOnlyTransaction(txLike): Promise<ccc.Transaction>
Signs a transaction without modifying it.
Parameters
- txLike: TransactionLike
  The transaction to sign, represented as a TransactionLike object.
Returns Promise<ccc.Transaction>
A promise that resolves to a signed Transaction object.
Overrides Signer.signOnlyTransaction
- Defined in signer/nostr/signerNostr.ts:114

matchNetworkPreference

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

`Static`verifyMessage

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

`Abstract`connect

connect(): Promise<void>
Connects to the signer.

Returns Promise<void>
A promise that resolves when the connection is complete.
Inherited from Signer.connect
- Defined in signer/signer/index.ts:150

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 Signer.onReplaced
- Defined in signer/signer/index.ts:157

disconnect

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

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

`Abstract`isConnected

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

Returns Promise<boolean>
A promise that resolves the connection status.
Inherited from Signer.isConnected
- Defined in signer/signer/index.ts:173

getIdentity

getIdentity(): Promise<string>
Gets the identity for verifying signature, usually it's address

Returns Promise<string>
A promise that resolves to a string representing the identity
Inherited from Signer.getIdentity
- Defined in signer/signer/index.ts:187

getRecommendedAddressObj

getRecommendedAddressObj(_preference?): 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 Signer.getRecommendedAddressObj
- Defined in signer/signer/index.ts:204

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 Signer.getRecommendedAddress
- Defined in signer/signer/index.ts:214

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 Signer.getAddresses
- Defined in signer/signer/index.ts:223

findCells

findCells(filter, withData?): AsyncGenerator<Cell, any, unknown>
Parameters
- filter: ClientCollectableSearchKeyFilterLike
- OptionalwithData: null | boolean
Returns AsyncGenerator<Cell, any, unknown>
Inherited from Signer.findCells
- Defined in signer/signer/index.ts:229

getBalance

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

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

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 Signer.signMessage
- Defined in signer/signer/index.ts:265

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 Signer.verifyMessage
- Defined in signer/signer/index.ts:292

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 Signer.sendTransaction
- Defined in signer/signer/index.ts:320

signTransaction

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

Class SignerNostrAbstract

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SignerNostr

Properties

StaticCKB_SIG_HASH_ALL_TAG

StaticCKB_UNLOCK_EVENT_KIND

StaticCKB_UNLOCK_EVENT_CONTENT

Protectedclient_

Accessors

type

Returns SignerType

signType

Returns SignerSignType

client

Returns Client

Methods

AbstractgetNostrPublicKey

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

AbstractsignNostrEvent

Parameters

Returns Promise<Required<NostrEvent>>

signMessageRaw

Parameters

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

getInternalAddress

Returns Promise<string>

getAddressObjs

Returns Promise<Address[]>

prepareTransaction

Parameters

Returns Promise<ccc.Transaction>

signOnlyTransaction

Parameters

Returns Promise<ccc.Transaction>

matchNetworkPreference

Parameters

Returns undefined | NetworkPreference

StaticverifyMessage

Parameters

Returns Promise<boolean>

Abstractconnect

Returns Promise<void>

onReplaced

Parameters

Returns void

Returns (() => void)

Returns void

disconnect

Returns Promise<void>

AbstractisConnected

Returns Promise<boolean>

getIdentity

Returns Promise<string>

getRecommendedAddressObj

Parameters

Returns Promise<Address>

getRecommendedAddress

Parameters

Returns Promise<string>

getAddresses

Returns Promise<string[]>

findCells

Parameters

Returns AsyncGenerator<Cell, any, unknown>

getBalance

Returns Promise<bigint>

signMessage

Parameters

Returns Promise<Signature>

Throws

verifyMessage

Parameters

Class SignerNostr`Abstract`

`Static`CKB_SIG_HASH_ALL_TAG

`Static`CKB_UNLOCK_EVENT_KIND

`Static`CKB_UNLOCK_EVENT_CONTENT

`Protected`client_

`Abstract`getNostrPublicKey

`Abstract`signNostrEvent

`Static`verifyMessage

`Abstract`connect

`Abstract`isConnected