SignerEvm
@ckb-ccc/core • Docs
@ckb-ccc/core / ccc / SignerEvm
Class: abstract SignerEvm
An abstract class extending Signer for Ethereum Virtual Machine (EVM) based signing operations. This class provides methods to get EVM account, internal address, and signing transactions.
Extends
Signer
Extended by
SignerEvmAddressReadonly
Constructors
new SignerEvm()
new SignerEvm(
client_):SignerEvm
Parameters
• client_: Client
Returns
SignerEvm
Inherited from
Signer.constructor
Source
signer/signer/index.ts:40
Properties
client_
protectedclient_:Client
Inherited from
Signer.client_
Source
signer/signer/index.ts:40
Accessors
client
getclient():Client
Returns
Client
Source
signer/signer/index.ts:45
signType
getsignType():SignerSignType
Returns
SignerSignType
Source
signer/evm/signerEvm.ts:19
type
gettype():SignerType
Returns
SignerType
Source
signer/evm/signerEvm.ts:15
Methods
_getOmniLockEvmAddressObj()
_getOmniLockEvmAddressObj(
account):Promise<Address>
Parameters
• account: string
Returns
Promise<Address>
Source
signer/evm/signerEvm.ts:52
_getOmniLockOldEvmAddressObj()
_getOmniLockOldEvmAddressObj(
account):Promise<Address>
Parameters
• account: string
Returns
Promise<Address>
Source
signer/evm/signerEvm.ts:60
_signOmniLockScriptForTransaction()
_signOmniLockScriptForTransaction(
tx,script,messageTransformer):Promise<Transaction>
Parameters
• tx: Transaction
• script: Script
• messageTransformer
Returns
Promise<Transaction>
Source
signer/evm/signerEvm.ts:111
connect()
abstractconnect():Promise<void>
Connects to the signer.
Returns
Promise<void>
A promise that resolves when the connection is complete.
Inherited from
Signer.connect
Source
signer/signer/index.ts:89
disconnect()
disconnect():
Promise<void>
Disconnects to the signer.
Returns
Promise<void>
A promise that resolves when disconnected.
Inherited from
Signer.disconnect
Source
signer/signer/index.ts:96
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
Source
signer/evm/signerEvm.ts:44
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
Source
signer/signer/index.ts:153
getBalance()
getBalance():
Promise<bigint>
Gets balance of all addresses
Returns
Promise<bigint>
A promise that resolves to the balance
Inherited from
Signer.getBalance
Source
signer/signer/index.ts:164
getEvmAccount()
abstractgetEvmAccount():Promise<string>
Gets the EVM account associated with the signer.
Returns
Promise<string>
A promise that resolves to a string representing the EVM account.
Source
signer/evm/signerEvm.ts:28
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
Source
signer/signer/index.ts:117
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
Source
signer/evm/signerEvm.ts:35
getRecommendedAddress()
getRecommendedAddress(
preference?):Promise<string>
Gets the recommended address for the signer as a string.
Parameters
• preference?: unknown
Optional preference parameter.
Returns
Promise<string>
A promise that resolves to the recommended address as a string.
Inherited from
Signer.getRecommendedAddress
Source
signer/signer/index.ts:144
getRecommendedAddressObj()
getRecommendedAddressObj(
_preference?):Promise<Address>
Gets the recommended Address object for the signer.
Parameters
• _preference?: unknown
Optional preference parameter.
Returns
Promise<Address>
A promise that resolves to the recommended Address object.
Inherited from
Signer.getRecommendedAddressObj
Source
signer/signer/index.ts:134
isConnected()
abstractisConnected():Promise<boolean>
Check if the signer is connected.
Returns
Promise<boolean>
A promise that resolves the connection status.
Inherited from
Signer.isConnected
Source
signer/signer/index.ts:103
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.
Overrides
Signer.prepareTransaction
Source
signer/evm/signerEvm.ts:74
replaceClient()
replaceClient(
client):Promise<void>
Replace the current client.
Parameters
• client: Client
Returns
Promise<void>
Inherited from
Signer.replaceClient
Source
signer/signer/index.ts:80
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
Source
signer/signer/index.ts:240
signMessage()
signMessage(
message):Promise<Signature>
Signs a message.
Parameters
• message: BytesLike
Returns
Promise<Signature>
A promise that resolves to the signature info.
Inherited from
Signer.signMessage
Throws
Will throw an error if not implemented.
Source
signer/signer/index.ts:177
signMessageRaw()
signMessageRaw(
_):Promise<string>
Signs a message and returns signature only. This method is not implemented and should be overridden by subclasses.
Parameters
• _: BytesLike
The message to sign, as a string or BytesLike object.
Returns
Promise<string>
A promise that resolves to the signature as a string.
Inherited from
Signer.signMessageRaw
Throws
Will throw an error if not implemented.
Source
signer/signer/index.ts:192
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.
Overrides
Signer.signOnlyTransaction
Source
signer/evm/signerEvm.ts:89
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
Signer.signTransaction
Source
signer/signer/index.ts:250
verifyMessage()
verifyMessage(
message,signature):Promise<boolean>
Verify a signature.
Parameters
• message: BytesLike
• signature: string | Signature
Returns
Promise<boolean>
A promise that resolves to the verification result.
Inherited from
Signer.verifyMessage
Throws
Will throw an error if not implemented.
Source
signer/signer/index.ts:204
verifyMessageRaw()
verifyMessageRaw(
_0,_1):Promise<boolean>
Verify a string signature. This method is not implemented and should be overridden by subclasses.
Parameters
• _0: BytesLike
The original message.
• _1: string
The signature to verify.
Returns
Promise<boolean>
A promise that resolves to the verification result.
Inherited from
Signer.verifyMessageRaw
Throws
Will throw an error if not implemented.
Source
signer/signer/index.ts:230
verifyMessage()
staticverifyMessage(message,signature):Promise<boolean>
Parameters
• message: BytesLike
• signature: Signature
Returns
Promise<boolean>
Inherited from
Signer.verifyMessage
Source
signer/signer/index.ts:49