TransactionEnvelopeEip2930.getSignPayload
Returns the payload to sign for a TransactionEnvelopeEip2930.TransactionEnvelopeEip2930
.
Imports
Named
import { TransactionEnvelopeEip2930 } from 'ox'
Examples
The example below demonstrates how to compute the sign payload which can be used with ECDSA signing utilities like Secp256k1.sign
.
import { Secp256k1, TransactionEnvelopeEip2930 } from 'ox'
const envelope = TransactionEnvelopeEip2930.from({
chainId: 1,
nonce: 0n,
gasPrice: 1000000000n,
gas: 21000n,
to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
value: 1000000000000000000n,
})
const payload = TransactionEnvelopeEip2930.getSignPayload(envelope)
'0x...' const signature = Secp256k1.sign({ payload, privateKey: '0x...' })
Definition
function getSignPayload(
envelope: TransactionEnvelopeEip2930.TransactionEnvelopeEip2930,
): getSignPayload.ReturnType
Source: src/TransactionEnvelopeEip2930.ts
Parameters
envelope
The transaction envelope to get the sign payload for.
envelope.accessList
- Type:
readonly { address: abitype_Address; storageKeys: readonly 0x${string}[]; }[]
- Optional
EIP-2930 Access List.
envelope.chainId
- Type:
numberType
EIP-155 Chain ID.
envelope.data
- Type:
0x${string}
- Optional
Contract code or a hashed method call with encoded args
envelope.from
- Type:
Address.Address | undefined
- Optional
Sender of the transaction.
envelope.gas
- Type:
bigintType
- Optional
Gas provided for transaction execution
envelope.gasPrice
- Type:
bigintType
- Optional
Base fee per gas.
envelope.input
- Type:
0x${string}
- Optional
envelope.nonce
- Type:
bigintType
- Optional
Unique number identifying this transaction
envelope.r
- Type:
bigintType
envelope.s
- Type:
bigintType
envelope.to
- Type:
Address.Address | null | undefined
- Optional
Transaction recipient
envelope.type
- Type:
type
Transaction type
envelope.v
- Type:
numberType
- Optional
envelope.value
- Type:
bigintType
- Optional
Value in wei sent with this transaction
envelope.yParity
- Type:
numberType
- Optional
ECDSA signature yParity.
Return Type
The sign payload.
getSignPayload.ReturnType