Class Transaction<TResult>

Type Parameters

TResult = TransactionResult

Hierarchy

TransactionContext
- Transaction

Constructors

constructor

new Transaction<TResult>(options): Transaction<TResult>
Type Parameters
- TResult = Omit<TransactionResultWithMetadata<unknown>, "data">
Parameters
- options: TransactionOptionsWithContract<TResult>
Returns Transaction<TResult>
Overrides TransactionContext.constructor
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:304

Properties

`Protected` args

args: any[]

`Private` contract

contract: Contract

`Protected` `Optional` gasMultiple

gasMultiple?: number

`Private` `Optional` gaslessOptions

gaslessOptions?: {
    experimentalChainlessSupport: boolean;
    openzeppelin: { relayerUrl: string; useEOAForwarder: boolean; domainName: string; domainVersion: string; relayerForwarderAddress?: string | undefined; };
} | {
    biconomy: { apiId: string; apiKey: string; deadlineSeconds: number; };
} | {
    engine: { relayerUrl: string; };
}

Type declaration

experimentalChainlessSupport: boolean
openzeppelin: { relayerUrl: string; useEOAForwarder: boolean; domainName: string; domainVersion: string; relayerForwarderAddress?: string | undefined; }

Type declaration

biconomy: { apiId: string; apiKey: string; deadlineSeconds: number; }

Type declaration

engine: { relayerUrl: string; }

`Private` method

method: string

`Protected` overrides

overrides: CallOverrides

`Private` `Optional` parse

parse?: ParseTransactionReceipt<TResult>

`Protected` provider

provider: Provider

`Protected` signer

signer: Signer

`Protected` storage

storage: ThirdwebStorage<IpfsUploadBatchOptions>

Accessors

getProvider

get getProvider(): Provider
Returns Provider
Inherited from TransactionContext.getProvider
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:72

getSigner

get getSigner(): Signer
Returns Signer
Inherited from TransactionContext.getSigner
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:68

getStorage

get getStorage(): ThirdwebStorage<IpfsUploadBatchOptions>
Returns ThirdwebStorage<IpfsUploadBatchOptions>
Inherited from TransactionContext.getStorage
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:76

Methods

encode

encode(): string
Encode the function data for this transaction

Returns string
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:351

estimateGasCost

estimateGasCost(): Promise<{
ether: string;
wei: BigNumber;
}>
Estimate the total gas cost of this transaction (in both ether and wei)

Returns Promise<{
ether: string;
wei: BigNumber;
}>
Inherited from TransactionContext.estimateGasCost
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:189

estimateGasLimit

estimateGasLimit(): Promise<BigNumber>
Estimate the gas limit of this transaction

Returns Promise<BigNumber>
Overrides TransactionContext.estimateGasLimit
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:402

execute

execute(): Promise<TResult>
Send the transaction and wait for it to be mined

Returns Promise<TResult>
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:479

`Private` functionError

functionError(): Error
Returns Error
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:623

getArgs

getArgs(): any[]
Returns any[]
Inherited from TransactionContext.getArgs
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:80

`Protected` getGasOverrides

getGasOverrides(): Promise<{
    gasPrice?: undefined;
    maxFeePerGas?: undefined;
    maxPriorityFeePerGas?: undefined;
} | {
    gasPrice?: undefined;
    maxFeePerGas: BigNumber;
    maxPriorityFeePerGas: BigNumber;
} | {
    gasPrice: BigNumber;
    maxFeePerGas?: undefined;
    maxPriorityFeePerGas?: undefined;
}>
Get gas overrides for the transaction

Returns Promise<{
    gasPrice?: undefined;
    maxFeePerGas?: undefined;
    maxPriorityFeePerGas?: undefined;
} | {
    gasPrice?: undefined;
    maxFeePerGas: BigNumber;
    maxPriorityFeePerGas: BigNumber;
} | {
    gasPrice: BigNumber;
    maxFeePerGas?: undefined;
    maxPriorityFeePerGas?: undefined;
}>
Inherited from TransactionContext.getGasOverrides
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:219

getGasPrice

getGasPrice(): Promise<BigNumber>
Calculates the gas price for transactions (adding a 10% tip buffer)

Returns Promise<BigNumber>
Inherited from TransactionContext.getGasPrice
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:205

getGaslessOptions

getGaslessOptions(): undefined | {
    experimentalChainlessSupport: boolean;
    openzeppelin: { relayerUrl: string; useEOAForwarder: boolean; domainName: string; domainVersion: string; relayerForwarderAddress?: string | undefined; };
} | {
    biconomy: { apiId: string; apiKey: string; deadlineSeconds: number; };
} | {
    engine: { relayerUrl: string; };
}
Returns undefined | {
    experimentalChainlessSupport: boolean;
    openzeppelin: { relayerUrl: string; useEOAForwarder: boolean; domainName: string; domainVersion: string; relayerForwarderAddress?: string | undefined; };
} | {
    biconomy: { apiId: string; apiKey: string; deadlineSeconds: number; };
} | {
    engine: { relayerUrl: string; };
}
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:332

getMethod

getMethod(): string
Returns string
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:328

getOverrides

getOverrides(): CallOverrides
Returns CallOverrides
Inherited from TransactionContext.getOverrides
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:84

getSignerAddress

getSignerAddress(): Promise<string>
Get the address of the transaction signer

Returns Promise<string>
Inherited from TransactionContext.getSignerAddress
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:212

getTarget

getTarget(): string
Returns string
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:324

getValue

getValue(): BigNumberish | Promise<BigNumberish>
Returns BigNumberish | Promise<BigNumberish>
Inherited from TransactionContext.getValue
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:88

populateTransaction

populateTransaction(): Promise<TransactionRequest>
Returns Promise<TransactionRequest>
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:364

send

send(): Promise<ContractTransaction>
Send the transaction without waiting for it to be mined.

Returns Promise<ContractTransaction>
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:432

`Private` sendGasless

sendGasless(): Promise<ContractTransaction>
Execute the transaction with gasless

Returns Promise<ContractTransaction>
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:504

setAccessList

setAccessList(accessList): TransactionContext
Parameters
- accessList: undefined | AccessListish
Returns TransactionContext
Inherited from TransactionContext.setAccessList
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:146

setArgs

setArgs(args): TransactionContext
Parameters
- args: any[]
Returns TransactionContext
Inherited from TransactionContext.setArgs
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:92

setCcipReadEnabled

setCcipReadEnabled(ccipReadEnabled): TransactionContext
Parameters
- ccipReadEnabled: undefined | boolean
Returns TransactionContext
Inherited from TransactionContext.setCcipReadEnabled
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:156

setCustomData

setCustomData(customData): TransactionContext
Parameters
- customData: undefined | Record<string, any>
Returns TransactionContext
Inherited from TransactionContext.setCustomData
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:151

setGasLimit

setGasLimit(gasLimit): TransactionContext
Parameters
- gasLimit: undefined | BigNumberish | Promise<BigNumberish>
Returns TransactionContext
Inherited from TransactionContext.setGasLimit
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:112

setGasLimitMultiple

setGasLimitMultiple(factor): void
Set a multiple to multiply the gas limit by
Parameters
- factor: number
Returns void
Example
```
// Set the gas limit multiple to 1.2 (increase by 20%)
tx.setGasLimitMultiple(1.2)
```
Inherited from TransactionContext.setGasLimitMultiple
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:174

setGasPrice

setGasPrice(gasPrice): TransactionContext
Parameters
- gasPrice: undefined | BigNumberish | Promise<BigNumberish>
Returns TransactionContext
Inherited from TransactionContext.setGasPrice
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:117

setGaslessOptions

setGaslessOptions(options): Transaction<TResult>
Parameters
- options: undefined | {
      experimentalChainlessSupport: boolean;
      openzeppelin: { relayerUrl: string; useEOAForwarder: boolean; domainName: string; domainVersion: string; relayerForwarderAddress?: string | undefined; };
  } | {
      biconomy: { apiId: string; apiKey: string; deadlineSeconds: number; };
  } | {
      engine: { relayerUrl: string; };
  }
Returns Transaction<TResult>
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:336

setMaxFeePerGas

setMaxFeePerGas(maxFeePerGas): TransactionContext
Parameters
- maxFeePerGas: undefined | BigNumberish | Promise<BigNumberish>
Returns TransactionContext
Inherited from TransactionContext.setMaxFeePerGas
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:127

setMaxPriorityFeePerGas

setMaxPriorityFeePerGas(maxPriorityFeePerGas): TransactionContext
Parameters
- maxPriorityFeePerGas: undefined | BigNumberish | Promise<BigNumberish>
Returns TransactionContext
Inherited from TransactionContext.setMaxPriorityFeePerGas
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:134

setNonce

setNonce(nonce): TransactionContext
Parameters
- nonce: undefined | BigNumberish | Promise<BigNumberish>
Returns TransactionContext
Inherited from TransactionContext.setNonce
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:122

setOverrides

setOverrides(overrides): TransactionContext
Parameters
- overrides: CallOverrides
Returns TransactionContext
Inherited from TransactionContext.setOverrides
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:97

setParse

setParse(parse): Transaction<TResult>
Parameters
- parse: ParseTransactionReceipt<TResult>
Returns Transaction<TResult>
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:343

setType

setType(type): TransactionContext
Parameters
- type: undefined | number
Returns TransactionContext
Inherited from TransactionContext.setType
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:141

setValue

setValue(value): TransactionContext
Parameters
- value: undefined | BigNumberish | Promise<BigNumberish>
Returns TransactionContext
Inherited from TransactionContext.setValue
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:107

sign

sign(): Promise<string>
Get the signed transaction

Returns Promise<string>
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:358

simulate

simulate(): Promise<any>
Simulate the transaction on-chain without executing

Returns Promise<any>
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:384

`Private` transactionError

transactionError(error): Promise<TransactionError>
Create a nicely formatted error message with tx metadata and solidity stack trace
Parameters
- error: any
Returns Promise<TransactionError>
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:632

updateOverrides

updateOverrides(overrides): TransactionContext
Parameters
- overrides: CallOverrides
Returns TransactionContext
Inherited from TransactionContext.updateOverrides
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:102

`Static` fromContractInfo

fromContractInfo<TResult>(options): Promise<Transaction<TResult>>
Type Parameters
- TResult = Omit<TransactionResultWithMetadata<unknown>, "data">
Parameters
- options: TransactionOptionsWithContractInfo<TResult>
Returns Promise<Transaction<TResult>>
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:268

`Static` fromContractWrapper

fromContractWrapper<TContract, TResult>(options): Transaction<TResult>
Type Parameters
- TContract extends BaseContract
- TResult = Omit<TransactionResultWithMetadata<unknown>, "data">
Parameters
- options: TransactionOptionsWithContractWrapper<TContract, TResult>
Returns Transaction<TResult>
- Defined in packages/sdk/src/evm/core/classes/transactions.ts:243

Class Transaction<TResult>

Type Parameters

TResult = TransactionResult

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

TResult = Omit<TransactionResultWithMetadata<unknown>, "data">

Parameters

options: TransactionOptionsWithContract<TResult>

Returns Transaction<TResult>

Properties

Protected args

Private contract

Protected Optional gasMultiple

Private Optional gaslessOptions

Type declaration

experimentalChainlessSupport: boolean

openzeppelin: { relayerUrl: string; useEOAForwarder: boolean; domainName: string; domainVersion: string; relayerForwarderAddress?: string | undefined; }

Type declaration

biconomy: { apiId: string; apiKey: string; deadlineSeconds: number; }

Type declaration

engine: { relayerUrl: string; }

Private method

Protected overrides

Private Optional parse

Protected provider

Protected signer

Protected storage

Accessors

getProvider

Returns Provider

getSigner

Returns Signer

getStorage

Returns ThirdwebStorage<IpfsUploadBatchOptions>

Methods

encode

Returns string

estimateGasCost

Returns Promise<{ ether: string; wei: BigNumber; }>

estimateGasLimit

Returns Promise<BigNumber>

execute

Returns Promise<TResult>

Private functionError

Returns Error

getArgs

Returns any[]

Protected getGasOverrides

Returns Promise<{ gasPrice?: undefined; maxFeePerGas?: undefined; maxPriorityFeePerGas?: undefined; } | { gasPrice?: undefined; maxFeePerGas: BigNumber; maxPriorityFeePerGas: BigNumber; } | { gasPrice: BigNumber; maxFeePerGas?: undefined; maxPriorityFeePerGas?: undefined; }>

getGasPrice

Returns Promise<BigNumber>

getGaslessOptions

getMethod

Returns string

getOverrides

Returns CallOverrides

getSignerAddress

Returns Promise<string>

getTarget

Returns string

getValue

Returns BigNumberish | Promise<BigNumberish>

populateTransaction

Returns Promise<TransactionRequest>

send

Returns Promise<ContractTransaction>

Private sendGasless

Returns Promise<ContractTransaction>

setAccessList

Parameters

accessList: undefined | AccessListish

Returns TransactionContext

setArgs

`Protected` args

`Private` contract

`Protected` `Optional` gasMultiple

`Private` `Optional` gaslessOptions

`Private` method

`Protected` overrides

`Private` `Optional` parse

`Protected` provider

`Protected` signer

`Protected` storage

Returns Promise<{
ether: string;
wei: BigNumber;
}>

`Private` functionError

`Protected` getGasOverrides

Returns Promise<{
gasPrice?: undefined;
maxFeePerGas?: undefined;
maxPriorityFeePerGas?: undefined;
} | {
gasPrice?: undefined;
maxFeePerGas: BigNumber;
maxPriorityFeePerGas: BigNumber;
} | {
gasPrice: BigNumber;
maxFeePerGas?: undefined;
maxPriorityFeePerGas?: undefined;
}>

`Private` sendGasless

`Private` transactionError

`Static` fromContractInfo