OptionalstackStatic OptionalprepareOptional override for formatting stack traces
StaticstackAbstractBase class for Web3 errors.
-Abstract ReadonlycodeReadonlynameStatic OptionalprepareOptional override for formatting stack traces
StaticstackUse the cause property instead.
Use the Common.custom static constructor for creating simple custom chain Common objects (more complete custom chain setups can be created via the main constructor and the CommonOpts.customChains parameter).
-Dictionary with hardfork params or null if hardfork not on chain
Alias to hardforkIsActiveOnBlock when hardfork is set
True if HF is active on block number
-Returns bootstrap nodes for the current chain
+Returns bootstrap nodes for the current chain
Dict with bootstrap nodes
Return an array listing the events for which the emitter has registered +
Rest...args: any[]Returns the Genesis parameters of the current chain
Genesis dictionary
@@ -115,7 +115,7 @@ is set tonull or otherwise needs to match (if not an error
will be thrown).
The name of the HF
-Alias to hardforkGteHardfork when hardfork is set
+Returns the hardfork set
@@ -143,16 +143,16 @@True if block number provided is the hardfork change block following the hardfork given or set
Optional_hardfork: stringTrue if blockNumber is HF block
Sets the chain
+Optionalevent: string | symbolSets the chain
String ('mainnet') or Number (1) chain representation. Or, a Dictionary of chain parameters for a private network.
The dictionary with parameters set as chain
@@ -194,7 +194,7 @@ is set tonull or otherwise needs to match (if not an error
will be thrown).
The name of the HF set
-Static_getOptionalcustomChains: ChainConfig[]StaticcustomCreates a Common object for a custom chain, based on a standard one.
+Static_getOptionalcustomChains: ChainConfig[]StaticcustomCreates a Common object for a custom chain, based on a standard one.
It uses all the Chain parameters from the baseChain option except the ones overridden in a provided chainParamsOrName dictionary. Some usage example:
Common.custom({chainId: 123})
diff --git a/docs/html/classes/_internal_.Contract-2.html b/docs/html/classes/_internal_.Contract-2.html
index 11cec6155..733fc48c6 100644
--- a/docs/html/classes/_internal_.Contract-2.html
+++ b/docs/html/classes/_internal_.Contract-2.html
@@ -152,7 +152,7 @@
const myContractAbi = [....] as const; // ABI definitions
const myContract = new web3.eth.Contract(myContractAbi, '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe');
-- new
Type Parameters
- Abi extends ContractAbi
Parameters
- jsonInterface: Abi
Optionaladdress: stringOptionalcontextOrReturnFormat: Partial<Web3ContextInitOptions<EthExecutionAPI, {
logs: typeof LogsSubscription;
newBlockHeaders: typeof NewHeadsSubscription;
newHeads: typeof NewHeadsSubscription;
}>> | Web3Context<unknown, any> | DataFormatOptionalreturnFormat: DataFormat
Returns Contract<Abi>
- new
Type Parameters
- Abi extends ContractAbi
Parameters
- jsonInterface: Abi
Optionaloptions: ContractInitOptionsOptionalcontextOrReturnFormat: Partial<Web3ContextInitOptions<EthExecutionAPI, {
logs: typeof LogsSubscription;
newBlockHeaders: typeof NewHeadsSubscription;
newHeads: typeof NewHeadsSubscription;
}>> | Web3Context<unknown, any> | DataFormatOptionalreturnFormat: DataFormat
Returns Contract<Abi>
- new
Type Parameters
- Abi extends ContractAbi
Parameters
- jsonInterface: Abi
- address: undefined | string
- options: ContractInitOptions
OptionalcontextOrReturnFormat: Partial<Web3ContextInitOptions<EthExecutionAPI, {
logs: typeof LogsSubscription;
newBlockHeaders: typeof NewHeadsSubscription;
newHeads: typeof NewHeadsSubscription;
}>> | Web3Context<unknown, any> | DataFormatOptionalreturnFormat: DataFormat
Returns Contract<Abi>
Properties
Protected Optional_account
Protected_request
Protected_subscription
_subscription
logs: typeof LogsSubscription;
newBlockHeaders: typeof NewHeadsSubscription;
newHeads: typeof NewHeadsSubscription;
}>Protected Optional_wallet
config
Readonlyoptions
The options object for the contract instance. from, gas and gasPrice are used as fallback values when sending transactions.
+- new
Type Parameters
- Abi extends ContractAbi
Parameters
- jsonInterface: Abi
Optionaladdress: stringOptionalcontextOrReturnFormat: Partial<Web3ContextInitOptions<EthExecutionAPI, {
logs: typeof LogsSubscription;
newBlockHeaders: typeof NewHeadsSubscription;
newHeads: typeof NewHeadsSubscription;
}>> | Web3Context<unknown, any> | DataFormatOptionalreturnFormat: DataFormat
Returns Contract<Abi>
- new
Type Parameters
- Abi extends ContractAbi
Parameters
- jsonInterface: Abi
Optionaloptions: ContractInitOptionsOptionalcontextOrReturnFormat: Partial<Web3ContextInitOptions<EthExecutionAPI, {
logs: typeof LogsSubscription;
newBlockHeaders: typeof NewHeadsSubscription;
newHeads: typeof NewHeadsSubscription;
}>> | Web3Context<unknown, any> | DataFormatOptionalreturnFormat: DataFormat
Returns Contract<Abi>
- new
Type Parameters
- Abi extends ContractAbi
Parameters
- jsonInterface: Abi
- address: undefined | string
- options: ContractInitOptions
OptionalcontextOrReturnFormat: Partial<Web3ContextInitOptions<EthExecutionAPI, {
logs: typeof LogsSubscription;
newBlockHeaders: typeof NewHeadsSubscription;
newHeads: typeof NewHeadsSubscription;
}>> | Web3Context<unknown, any> | DataFormatOptionalreturnFormat: DataFormat
Returns Contract<Abi>
Properties
Protected Optional_account
Protected_request
Protected_subscription
_subscription
logs: typeof LogsSubscription;
newBlockHeaders: typeof NewHeadsSubscription;
newHeads: typeof NewHeadsSubscription;
}>Protected Optional_wallet
config
Readonlyoptions
The options object for the contract instance. from, gas and gasPrice are used as fallback values when sending transactions.
myContract.options;
> {
address: '0x1234567890123456789012345678901234567891',
jsonInterface: [...],
from: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe',
gasPrice: '10000000000000',
gas: 1000000
}
myContract.options.from = '0x1234567890123456789012345678901234567891'; // default from address
myContract.options.gasPrice = '20000000000000'; // default gas price in wei
myContract.options.gas = 5000000; // provide as fallback always 5M gas
@@ -239,7 +239,7 @@
Parameters
- val: string
Returns void
default
default
default
- get defaultReturnFormat(): DataFormat
Returns DataFormat
- set defaultReturnFormat(val): void
Parameters
- val: DataFormat
Returns void
default
enable
- get enableExperimentalFeatures(): {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
} The enableExperimentalFeatures is used to enable trying new experimental features that are still not fully implemented or not fully tested or still have some related issues.
Default is false for every feature.
Returns {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
}
use
use
- set enableExperimentalFeatures(val): void
Will set the enableExperimentalFeatures
-Parameters
- val: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
}use
use
Returns void
events
- get events(): ContractEventsInterface<Abi, ContractEvents<Abi>>
Subscribe to an event.
+Parameters
- val: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
}use
use
Returns void
events
- get events(): ContractEventsInterface<Abi, ContractEvents<Abi>>
Subscribe to an event.
await myContract.events.MyEvent([options])
@@ -247,7 +247,7 @@
await myContract.events.allEvents([options])
-Returns ContractEventsInterface<Abi, ContractEvents<Abi>>
+
Returns ContractEventsInterface<Abi, ContractEvents<Abi>>
- When individual event is accessed will returns ContractBoundEvent object
given
- get givenProvider(): undefined | SupportedProviders<never>
Will return the givenProvider if available.
@@ -315,27 +315,27 @@
const contract1 = new web3.eth.Contract(abi, address, {gasPrice: '12345678', from: fromAddress});
const contract2 = contract1.clone();
contract2.options.address = '0xdAC17F958D2ee523a2206206994597C13D831ec7';
(contract1.options.address !== contract2.options.address);
> true
-contract
- contract
Type Parameters
- Options extends PayableCallOptions | NonPayableCallOptions
- ReturnFormat extends DataFormat
Parameters
- __namedParameters: {
abi: AbiFunctionFragment;
contractOptions?: ContractOptions;
options?: Options;
params: unknown[];
returnFormat: ReturnFormat;
}abi: AbiFunctionFragment
Optionalcontract
Optionaloptions?: Options
params: unknown[]
return
Returns Promise<NumberTypes[ReturnFormat["number"]]>
decode
- decode
__method__: string;
} Parameters
- data: string
Returns DecodedParams & {
__method__: string;
}
deploy
- deploy(deployOptions?): DeployerMethodClass<Abi>
Call this function to deploy the contract to the blockchain. After successful deployment the promise will resolve with a new contract instance.
+contract
- contract
Type Parameters
- Options extends PayableCallOptions | NonPayableCallOptions
- ReturnFormat extends DataFormat
Parameters
- __namedParameters: {
abi: AbiFunctionFragment;
contractOptions?: ContractOptions;
options?: Options;
params: unknown[];
returnFormat: ReturnFormat;
}abi: AbiFunctionFragment
Optionalcontract
Optionaloptions?: Options
params: unknown[]
return
Returns Promise<NumberTypes[ReturnFormat["number"]]>
decode
- decode
__method__: string;
} Parameters
- data: string
Returns DecodedParams & {
__method__: string;
}
deploy
- deploy(deployOptions?): DeployerMethodClass<Abi>
Call this function to deploy the contract to the blockchain. After successful deployment the promise will resolve with a new contract instance.
myContract.deploy({
input: '0x12345...', // data keyword can be used, too.
arguments: [123, 'My String']
})
.send({
from: '0x1234567890123456789012345678901234567891',
gas: 1500000,
gasPrice: '30000000000000'
}, function(error, transactionHash){ ... })
.on('error', function(error){ ... })
.on('transactionHash', function(transactionHash){ ... })
.on('receipt', function(receipt){
console.log(receipt.contractAddress) // contains the new contract address
})
.on('confirmation', function(confirmationNumber, receipt){ ... })
.then(function(newContractInstance){
console.log(newContractInstance.options.address) // instance with the new contract address
});
// When the data is already set as an option to the contract itself
myContract.options.data = '0x12345...';
myContract.deploy({
arguments: [123, 'My String']
})
.send({
from: '0x1234567890123456789012345678901234567891',
gas: 1500000,
gasPrice: '30000000000000'
})
.then(function(newContractInstance){
console.log(newContractInstance.options.address) // instance with the new contract address
});
// Simply encoding
myContract.deploy({
input: '0x12345...',
arguments: [123, 'My String']
})
.encodeABI();
> '0x12345...0000012345678765432'
// decoding
myContract.deploy({
input: '0x12345...',
// arguments: [123, 'My Greeting'] if you just need to decode the data, you can skip the arguments
})
.decodeData('0x12345...0000012345678765432');
> {
__method__: 'constructor',
__length__: 2,
'0': '123',
_id: '123',
'1': 'My Greeting',
_greeting: 'My Greeting',
}
// Gas estimation
myContract.deploy({
input: '0x12345...',
arguments: [123, 'My String']
})
.estimateGas(function(err, gas){
console.log(gas);
});
-Parameters
OptionaldeployOptions: {
arguments?: "/home/velenir-gnx570/Projects/Paraswap/paraswap-sdk/node_modules/web3-types/lib/commonjs/index".ContractConstructorArgs<Abi>;
data?: string;
input?: string;
}Optionalarguments?: "/home/velenir-gnx570/Projects/Paraswap/paraswap-sdk/node_modules/web3-types/lib/commonjs/index".ContractConstructorArgs<Abi>
The arguments which get passed to the constructor on deployment.
+Parameters
OptionaldeployOptions: {
arguments?: "/Users/andriishymkiv/work/velora/sdk/node_modules/web3-types/lib/commonjs/index".ContractConstructorArgs<Abi>;
data?: string;
input?: string;
}Optionalarguments?: "/Users/andriishymkiv/work/velora/sdk/node_modules/web3-types/lib/commonjs/index".ContractConstructorArgs<Abi>
The arguments which get passed to the constructor on deployment.
Optionaldata?: string
The byte code of the contract.
Optionalinput?: string
Returns DeployerMethodClass<Abi>
- The transaction object
emit
- emit<K>(eventName, params): void
Type Parameters
- K extends CONFIG_CHANGE
Parameters
- eventName: K
- params: {
CONFIG_CHANGE:
| {
name: "handleRevert";
newValue: boolean;
oldValue: boolean;
}
| {
name: "defaultAccount";
newValue: undefined | string;
oldValue: undefined | string;
}
| {
name: "defaultBlock";
newValue: BlockNumberOrTag;
oldValue: BlockNumberOrTag;
}
| {
name: "transactionSendTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionBlockTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionConfirmationBlocks";
newValue: number;
oldValue: number;
}
| {
name: "transactionPollingInterval";
newValue: number;
oldValue: number;
}
| {
name: "transactionPollingTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionReceiptPollingInterval";
newValue: undefined | number;
oldValue: undefined | number;
}
| {
name: "transactionConfirmationPollingInterval";
newValue: undefined | number;
oldValue: undefined | number;
}
| {
name: "blockHeaderTimeout";
newValue: number;
oldValue: number;
}
| {
name: "maxListenersWarningThreshold";
newValue: number;
oldValue: number;
}
| {
name: "contractDataInputFill";
newValue: "data" | "input" | "both";
oldValue: "data" | "input" | "both";
}
| {
name: "defaultNetworkId";
newValue: undefined | Numbers;
oldValue: undefined | Numbers;
}
| {
name: "defaultChain";
newValue: string;
oldValue: string;
}
| {
name: "defaultHardfork";
newValue: string;
oldValue: string;
}
| {
name: "ignoreGasPricing";
newValue: boolean;
oldValue: boolean;
}
| {
name: "defaultCommon";
newValue: undefined | Common;
oldValue: undefined | Common;
}
| {
name: "defaultTransactionType";
newValue: Numbers;
oldValue: Numbers;
}
| {
name: "defaultMaxPriorityFeePerGas";
newValue: Numbers;
oldValue: Numbers;
}
| {
name: "enableExperimentalFeatures";
newValue: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
};
oldValue: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
};
}
| {
name: "transactionBuilder";
newValue: undefined | TransactionBuilder;
oldValue: undefined | TransactionBuilder;
}
| {
name: "transactionTypeParser";
newValue: undefined | TransactionTypeParser;
oldValue: undefined | TransactionTypeParser;
}
| {
name: "customTransactionSchema";
newValue: undefined | CustomTransactionSchema;
oldValue: undefined | CustomTransactionSchema;
}
| {
name: "defaultReturnFormat";
newValue: DataFormat;
oldValue: DataFormat;
};
}[K]
Returns void
event
extend
- extend(extendObj): this
This method allows extending the web3 modules.
Note: This method is only for backward compatibility, and It is recommended to use Web3 v4 Plugin feature for extending web3.js functionality if you are developing something new.
-Parameters
- extendObj: ExtensionObject
Returns this
get
- get
logs: typeof LogsSubscription;
newBlockHeaders: typeof NewHeadsSubscription;
newHeads: typeof NewHeadsSubscription;
}> Returns Web3ContextObject<EthExecutionAPI, {
logs: typeof LogsSubscription;
newBlockHeaders: typeof NewHeadsSubscription;
newHeads: typeof NewHeadsSubscription;
}>
get
get
- get
Gets past events for this contract.
+Parameters
- extendObj: ExtensionObject
Returns this
get
- get
logs: typeof LogsSubscription;
newBlockHeaders: typeof NewHeadsSubscription;
newHeads: typeof NewHeadsSubscription;
}> Returns Web3ContextObject<EthExecutionAPI, {
logs: typeof LogsSubscription;
newBlockHeaders: typeof NewHeadsSubscription;
newHeads: typeof NewHeadsSubscription;
}>
get
get
- get
Gets past events for this contract.
const events = await myContract.getPastEvents('MyEvent', {
filter: {myIndexedParam: [20,23], myOtherIndexedParam: '0x123456789...'}, // Using an array means OR: e.g. 20 or 23
fromBlock: 0,
toBlock: 'latest'
});
> [{
returnValues: {
myIndexedParam: 20,
myOtherIndexedParam: '0x123456789...',
myNonIndexParam: 'My String'
},
raw: {
data: '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385',
topics: ['0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7', '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385']
},
event: 'MyEvent',
signature: '0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
logIndex: 0,
transactionIndex: 0,
transactionHash: '0x7f9fade1c0d57a7af66ab4ead79fade1c0d57a7af66ab4ead7c2c2eb7b11a91385',
blockHash: '0xfd43ade1c09fade1c0d57a7af66ab4ead7c2c2eb7b11a91ffdd57a7af66ab4ead7',
blockNumber: 1234,
address: '0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe'
},{
...
}]
Type Parameters
- ReturnFormat extends DataFormat = {
bytes: HEX;
number: BIGINT;
}
Parameters
OptionalreturnFormat: ReturnFormatReturn format
-
Returns Promise<(string | "/home/velenir-gnx570/Projects/Paraswap/paraswap-sdk/node_modules/web3-types/lib/commonjs/index".EventLog)[]>
+
Returns Promise<(string | "/Users/andriishymkiv/work/velora/sdk/node_modules/web3-types/lib/commonjs/index".EventLog)[]>
- An array with the past event
Objects, matching the given event name and filter.
-- get
Type Parameters
- ReturnFormat extends DataFormat = {
bytes: HEX;
number: BIGINT;
}
Parameters
- eventName: "allEvents" | keyof ContractEvents<Abi> | "ALLEVENTS"
OptionalreturnFormat: ReturnFormat
Returns Promise<(string | "/home/velenir-gnx570/Projects/Paraswap/paraswap-sdk/node_modules/web3-types/lib/commonjs/index".EventLog)[]>
- get
Type Parameters
- ReturnFormat extends DataFormat = {
bytes: HEX;
number: BIGINT;
}
Parameters
- filter: Omit<Filter, "address">
OptionalreturnFormat: ReturnFormat
Returns Promise<(string | "/home/velenir-gnx570/Projects/Paraswap/paraswap-sdk/node_modules/web3-types/lib/commonjs/index".EventLog)[]>
- get
Type Parameters
- ReturnFormat extends DataFormat = {
bytes: HEX;
number: BIGINT;
}
Parameters
- eventName: "allEvents" | keyof ContractEvents<Abi> | "ALLEVENTS"
- filter: Omit<Filter, "address">
OptionalreturnFormat: ReturnFormat
Returns Promise<(string | "/home/velenir-gnx570/Projects/Paraswap/paraswap-sdk/node_modules/web3-types/lib/commonjs/index".EventLog)[]>
get
- get
Returns undefined | TransactionMiddleware
link
- link<T>(parentContext): void
Link current context to another context.
-Type Parameters
- T extends Web3Context<unknown, any>
Parameters
- parentContext: T
Returns void
listener
- listener
Type Parameters
- K extends CONFIG_CHANGE
Parameters
- eventName: K
Returns number
listeners
- listeners<K>(eventName): ((...args: any[]) => void)[]
Type Parameters
- K extends CONFIG_CHANGE
Parameters
- eventName: K
Returns ((...args: any[]) => void)[]
off
- off<K>(eventName, fn): void
Type Parameters
- K extends CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{
CONFIG_CHANGE:
| {
name: "handleRevert";
newValue: boolean;
oldValue: boolean;
}
| {
name: "defaultAccount";
newValue: undefined | string;
oldValue: undefined | string;
}
| {
name: "defaultBlock";
newValue: BlockNumberOrTag;
oldValue: BlockNumberOrTag;
}
| {
name: "transactionSendTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionBlockTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionConfirmationBlocks";
newValue: number;
oldValue: number;
}
| {
name: "transactionPollingInterval";
newValue: number;
oldValue: number;
}
| {
name: "transactionPollingTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionReceiptPollingInterval";
newValue: undefined | number;
oldValue: undefined | number;
}
| {
name: "transactionConfirmationPollingInterval";
newValue: undefined | number;
oldValue: undefined | number;
}
| {
name: "blockHeaderTimeout";
newValue: number;
oldValue: number;
}
| {
name: "maxListenersWarningThreshold";
newValue: number;
oldValue: number;
}
| {
name: "contractDataInputFill";
newValue: "data" | "input" | "both";
oldValue: "data" | "input" | "both";
}
| {
name: "defaultNetworkId";
newValue: undefined | Numbers;
oldValue: undefined | Numbers;
}
| {
name: "defaultChain";
newValue: string;
oldValue: string;
}
| {
name: "defaultHardfork";
newValue: string;
oldValue: string;
}
| {
name: "ignoreGasPricing";
newValue: boolean;
oldValue: boolean;
}
| {
name: "defaultCommon";
newValue: undefined | Common;
oldValue: undefined | Common;
}
| {
name: "defaultTransactionType";
newValue: Numbers;
oldValue: Numbers;
}
| {
name: "defaultMaxPriorityFeePerGas";
newValue: Numbers;
oldValue: Numbers;
}
| {
name: "enableExperimentalFeatures";
newValue: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
};
oldValue: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
};
}
| {
name: "transactionBuilder";
newValue: undefined | TransactionBuilder;
oldValue: undefined | TransactionBuilder;
}
| {
name: "transactionTypeParser";
newValue: undefined | TransactionTypeParser;
oldValue: undefined | TransactionTypeParser;
}
| {
name: "customTransactionSchema";
newValue: undefined | CustomTransactionSchema;
oldValue: undefined | CustomTransactionSchema;
}
| {
name: "defaultReturnFormat";
newValue: DataFormat;
oldValue: DataFormat;
};
}[K]>
Returns void
on
- on<K>(eventName, fn): void
Type Parameters
- K extends CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{
CONFIG_CHANGE:
| {
name: "handleRevert";
newValue: boolean;
oldValue: boolean;
}
| {
name: "defaultAccount";
newValue: undefined | string;
oldValue: undefined | string;
}
| {
name: "defaultBlock";
newValue: BlockNumberOrTag;
oldValue: BlockNumberOrTag;
}
| {
name: "transactionSendTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionBlockTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionConfirmationBlocks";
newValue: number;
oldValue: number;
}
| {
name: "transactionPollingInterval";
newValue: number;
oldValue: number;
}
| {
name: "transactionPollingTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionReceiptPollingInterval";
newValue: undefined | number;
oldValue: undefined | number;
}
| {
name: "transactionConfirmationPollingInterval";
newValue: undefined | number;
oldValue: undefined | number;
}
| {
name: "blockHeaderTimeout";
newValue: number;
oldValue: number;
}
| {
name: "maxListenersWarningThreshold";
newValue: number;
oldValue: number;
}
| {
name: "contractDataInputFill";
newValue: "data" | "input" | "both";
oldValue: "data" | "input" | "both";
}
| {
name: "defaultNetworkId";
newValue: undefined | Numbers;
oldValue: undefined | Numbers;
}
| {
name: "defaultChain";
newValue: string;
oldValue: string;
}
| {
name: "defaultHardfork";
newValue: string;
oldValue: string;
}
| {
name: "ignoreGasPricing";
newValue: boolean;
oldValue: boolean;
}
| {
name: "defaultCommon";
newValue: undefined | Common;
oldValue: undefined | Common;
}
| {
name: "defaultTransactionType";
newValue: Numbers;
oldValue: Numbers;
}
| {
name: "defaultMaxPriorityFeePerGas";
newValue: Numbers;
oldValue: Numbers;
}
| {
name: "enableExperimentalFeatures";
newValue: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
};
oldValue: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
};
}
| {
name: "transactionBuilder";
newValue: undefined | TransactionBuilder;
oldValue: undefined | TransactionBuilder;
}
| {
name: "transactionTypeParser";
newValue: undefined | TransactionTypeParser;
oldValue: undefined | TransactionTypeParser;
}
| {
name: "customTransactionSchema";
newValue: undefined | CustomTransactionSchema;
oldValue: undefined | CustomTransactionSchema;
}
| {
name: "defaultReturnFormat";
newValue: DataFormat;
oldValue: DataFormat;
};
}[K]>
Returns void
once
- once<K>(eventName, fn): void
Type Parameters
- K extends CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{
CONFIG_CHANGE:
| {
name: "handleRevert";
newValue: boolean;
oldValue: boolean;
}
| {
name: "defaultAccount";
newValue: undefined | string;
oldValue: undefined | string;
}
| {
name: "defaultBlock";
newValue: BlockNumberOrTag;
oldValue: BlockNumberOrTag;
}
| {
name: "transactionSendTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionBlockTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionConfirmationBlocks";
newValue: number;
oldValue: number;
}
| {
name: "transactionPollingInterval";
newValue: number;
oldValue: number;
}
| {
name: "transactionPollingTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionReceiptPollingInterval";
newValue: undefined | number;
oldValue: undefined | number;
}
| {
name: "transactionConfirmationPollingInterval";
newValue: undefined | number;
oldValue: undefined | number;
}
| {
name: "blockHeaderTimeout";
newValue: number;
oldValue: number;
}
| {
name: "maxListenersWarningThreshold";
newValue: number;
oldValue: number;
}
| {
name: "contractDataInputFill";
newValue: "data" | "input" | "both";
oldValue: "data" | "input" | "both";
}
| {
name: "defaultNetworkId";
newValue: undefined | Numbers;
oldValue: undefined | Numbers;
}
| {
name: "defaultChain";
newValue: string;
oldValue: string;
}
| {
name: "defaultHardfork";
newValue: string;
oldValue: string;
}
| {
name: "ignoreGasPricing";
newValue: boolean;
oldValue: boolean;
}
| {
name: "defaultCommon";
newValue: undefined | Common;
oldValue: undefined | Common;
}
| {
name: "defaultTransactionType";
newValue: Numbers;
oldValue: Numbers;
}
| {
name: "defaultMaxPriorityFeePerGas";
newValue: Numbers;
oldValue: Numbers;
}
| {
name: "enableExperimentalFeatures";
newValue: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
};
oldValue: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
};
}
| {
name: "transactionBuilder";
newValue: undefined | TransactionBuilder;
oldValue: undefined | TransactionBuilder;
}
| {
name: "transactionTypeParser";
newValue: undefined | TransactionTypeParser;
oldValue: undefined | TransactionTypeParser;
}
| {
name: "customTransactionSchema";
newValue: undefined | CustomTransactionSchema;
oldValue: undefined | CustomTransactionSchema;
}
| {
name: "defaultReturnFormat";
newValue: DataFormat;
oldValue: DataFormat;
};
}[K]>
Returns void
register
- register
Parameters
- plugin: Web3PluginBase<unknown>
Returns void
remove
set
- set
Parameters
- options: Partial<Web3ConfigOptions>
Returns void
set
set
- set
Will set the provider.
+- get
Type Parameters
- ReturnFormat extends DataFormat = {
bytes: HEX;
number: BIGINT;
}
Parameters
- eventName: "allEvents" | keyof ContractEvents<Abi> | "ALLEVENTS"
OptionalreturnFormat: ReturnFormat
Returns Promise<(string | "/Users/andriishymkiv/work/velora/sdk/node_modules/web3-types/lib/commonjs/index".EventLog)[]>
- get
Type Parameters
- ReturnFormat extends DataFormat = {
bytes: HEX;
number: BIGINT;
}
Parameters
- filter: Omit<Filter, "address">
OptionalreturnFormat: ReturnFormat
Returns Promise<(string | "/Users/andriishymkiv/work/velora/sdk/node_modules/web3-types/lib/commonjs/index".EventLog)[]>
- get
Type Parameters
- ReturnFormat extends DataFormat = {
bytes: HEX;
number: BIGINT;
}
Parameters
- eventName: "allEvents" | keyof ContractEvents<Abi> | "ALLEVENTS"
- filter: Omit<Filter, "address">
OptionalreturnFormat: ReturnFormat
Returns Promise<(string | "/Users/andriishymkiv/work/velora/sdk/node_modules/web3-types/lib/commonjs/index".EventLog)[]>
get
- get
Returns undefined | TransactionMiddleware
link
- link<T>(parentContext): void
Link current context to another context.
+Type Parameters
- T extends Web3Context<unknown, any>
Parameters
- parentContext: T
Returns void
listener
- listener
Type Parameters
- K extends CONFIG_CHANGE
Parameters
- eventName: K
Returns number
listeners
- listeners<K>(eventName): ((...args: any[]) => void)[]
Type Parameters
- K extends CONFIG_CHANGE
Parameters
- eventName: K
Returns ((...args: any[]) => void)[]
off
- off<K>(eventName, fn): void
Type Parameters
- K extends CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{
CONFIG_CHANGE:
| {
name: "handleRevert";
newValue: boolean;
oldValue: boolean;
}
| {
name: "defaultAccount";
newValue: undefined | string;
oldValue: undefined | string;
}
| {
name: "defaultBlock";
newValue: BlockNumberOrTag;
oldValue: BlockNumberOrTag;
}
| {
name: "transactionSendTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionBlockTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionConfirmationBlocks";
newValue: number;
oldValue: number;
}
| {
name: "transactionPollingInterval";
newValue: number;
oldValue: number;
}
| {
name: "transactionPollingTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionReceiptPollingInterval";
newValue: undefined | number;
oldValue: undefined | number;
}
| {
name: "transactionConfirmationPollingInterval";
newValue: undefined | number;
oldValue: undefined | number;
}
| {
name: "blockHeaderTimeout";
newValue: number;
oldValue: number;
}
| {
name: "maxListenersWarningThreshold";
newValue: number;
oldValue: number;
}
| {
name: "contractDataInputFill";
newValue: "data" | "input" | "both";
oldValue: "data" | "input" | "both";
}
| {
name: "defaultNetworkId";
newValue: undefined | Numbers;
oldValue: undefined | Numbers;
}
| {
name: "defaultChain";
newValue: string;
oldValue: string;
}
| {
name: "defaultHardfork";
newValue: string;
oldValue: string;
}
| {
name: "ignoreGasPricing";
newValue: boolean;
oldValue: boolean;
}
| {
name: "defaultCommon";
newValue: undefined | Common;
oldValue: undefined | Common;
}
| {
name: "defaultTransactionType";
newValue: Numbers;
oldValue: Numbers;
}
| {
name: "defaultMaxPriorityFeePerGas";
newValue: Numbers;
oldValue: Numbers;
}
| {
name: "enableExperimentalFeatures";
newValue: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
};
oldValue: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
};
}
| {
name: "transactionBuilder";
newValue: undefined | TransactionBuilder;
oldValue: undefined | TransactionBuilder;
}
| {
name: "transactionTypeParser";
newValue: undefined | TransactionTypeParser;
oldValue: undefined | TransactionTypeParser;
}
| {
name: "customTransactionSchema";
newValue: undefined | CustomTransactionSchema;
oldValue: undefined | CustomTransactionSchema;
}
| {
name: "defaultReturnFormat";
newValue: DataFormat;
oldValue: DataFormat;
};
}[K]>
Returns void
on
- on<K>(eventName, fn): void
Type Parameters
- K extends CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{
CONFIG_CHANGE:
| {
name: "handleRevert";
newValue: boolean;
oldValue: boolean;
}
| {
name: "defaultAccount";
newValue: undefined | string;
oldValue: undefined | string;
}
| {
name: "defaultBlock";
newValue: BlockNumberOrTag;
oldValue: BlockNumberOrTag;
}
| {
name: "transactionSendTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionBlockTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionConfirmationBlocks";
newValue: number;
oldValue: number;
}
| {
name: "transactionPollingInterval";
newValue: number;
oldValue: number;
}
| {
name: "transactionPollingTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionReceiptPollingInterval";
newValue: undefined | number;
oldValue: undefined | number;
}
| {
name: "transactionConfirmationPollingInterval";
newValue: undefined | number;
oldValue: undefined | number;
}
| {
name: "blockHeaderTimeout";
newValue: number;
oldValue: number;
}
| {
name: "maxListenersWarningThreshold";
newValue: number;
oldValue: number;
}
| {
name: "contractDataInputFill";
newValue: "data" | "input" | "both";
oldValue: "data" | "input" | "both";
}
| {
name: "defaultNetworkId";
newValue: undefined | Numbers;
oldValue: undefined | Numbers;
}
| {
name: "defaultChain";
newValue: string;
oldValue: string;
}
| {
name: "defaultHardfork";
newValue: string;
oldValue: string;
}
| {
name: "ignoreGasPricing";
newValue: boolean;
oldValue: boolean;
}
| {
name: "defaultCommon";
newValue: undefined | Common;
oldValue: undefined | Common;
}
| {
name: "defaultTransactionType";
newValue: Numbers;
oldValue: Numbers;
}
| {
name: "defaultMaxPriorityFeePerGas";
newValue: Numbers;
oldValue: Numbers;
}
| {
name: "enableExperimentalFeatures";
newValue: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
};
oldValue: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
};
}
| {
name: "transactionBuilder";
newValue: undefined | TransactionBuilder;
oldValue: undefined | TransactionBuilder;
}
| {
name: "transactionTypeParser";
newValue: undefined | TransactionTypeParser;
oldValue: undefined | TransactionTypeParser;
}
| {
name: "customTransactionSchema";
newValue: undefined | CustomTransactionSchema;
oldValue: undefined | CustomTransactionSchema;
}
| {
name: "defaultReturnFormat";
newValue: DataFormat;
oldValue: DataFormat;
};
}[K]>
Returns void
once
- once<K>(eventName, fn): void
Type Parameters
- K extends CONFIG_CHANGE
Parameters
- eventName: K
- fn: Web3EventCallback<{
CONFIG_CHANGE:
| {
name: "handleRevert";
newValue: boolean;
oldValue: boolean;
}
| {
name: "defaultAccount";
newValue: undefined | string;
oldValue: undefined | string;
}
| {
name: "defaultBlock";
newValue: BlockNumberOrTag;
oldValue: BlockNumberOrTag;
}
| {
name: "transactionSendTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionBlockTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionConfirmationBlocks";
newValue: number;
oldValue: number;
}
| {
name: "transactionPollingInterval";
newValue: number;
oldValue: number;
}
| {
name: "transactionPollingTimeout";
newValue: number;
oldValue: number;
}
| {
name: "transactionReceiptPollingInterval";
newValue: undefined | number;
oldValue: undefined | number;
}
| {
name: "transactionConfirmationPollingInterval";
newValue: undefined | number;
oldValue: undefined | number;
}
| {
name: "blockHeaderTimeout";
newValue: number;
oldValue: number;
}
| {
name: "maxListenersWarningThreshold";
newValue: number;
oldValue: number;
}
| {
name: "contractDataInputFill";
newValue: "data" | "input" | "both";
oldValue: "data" | "input" | "both";
}
| {
name: "defaultNetworkId";
newValue: undefined | Numbers;
oldValue: undefined | Numbers;
}
| {
name: "defaultChain";
newValue: string;
oldValue: string;
}
| {
name: "defaultHardfork";
newValue: string;
oldValue: string;
}
| {
name: "ignoreGasPricing";
newValue: boolean;
oldValue: boolean;
}
| {
name: "defaultCommon";
newValue: undefined | Common;
oldValue: undefined | Common;
}
| {
name: "defaultTransactionType";
newValue: Numbers;
oldValue: Numbers;
}
| {
name: "defaultMaxPriorityFeePerGas";
newValue: Numbers;
oldValue: Numbers;
}
| {
name: "enableExperimentalFeatures";
newValue: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
};
oldValue: {
useRpcCallSpecification: boolean;
useSubscriptionWhenCheckingBlockTimeout: boolean;
};
}
| {
name: "transactionBuilder";
newValue: undefined | TransactionBuilder;
oldValue: undefined | TransactionBuilder;
}
| {
name: "transactionTypeParser";
newValue: undefined | TransactionTypeParser;
oldValue: undefined | TransactionTypeParser;
}
| {
name: "customTransactionSchema";
newValue: undefined | CustomTransactionSchema;
oldValue: undefined | CustomTransactionSchema;
}
| {
name: "defaultReturnFormat";
newValue: DataFormat;
oldValue: DataFormat;
};
}[K]>
Returns void
register
- register
Parameters
- plugin: Web3PluginBase<unknown>
Returns void
remove
set
- set
Parameters
- options: Partial<Web3ConfigOptions>
Returns void
set
set
- set
Will set the provider.
Parameters
Optionalprovider: string | SupportedProviders<EthExecutionAPI>SupportedProviders The provider to set
Returns boolean
Returns true if the provider was set
set
- set
Parameters
- requestManagerMiddleware: RequestManagerMiddleware<EthExecutionAPI>
Returns void
set
- set
Parameters
- transactionMiddleware: TransactionMiddleware
Returns void
Protectedsubscribe
- subscribe
Type Parameters
- T extends Web3Context<unknown, any>
Parameters
- context: T
Returns void
use
- use<T, T2>(ContextRef, ...args): T
Use to create new object of any type extended by Web3Context
diff --git a/docs/html/classes/_internal_.ContractExecutionError.html b/docs/html/classes/_internal_.ContractExecutionError.html
index 822579970..eb43fb324 100644
--- a/docs/html/classes/_internal_.ContractExecutionError.html
+++ b/docs/html/classes/_internal_.ContractExecutionError.html
@@ -13,7 +13,7 @@
Methods
Constructors
constructor
- new
Parameters
- rpcError: JsonRpcError<JsonRpcResult>
Returns ContractExecutionError
Constructors
constructor
- new
Parameters
- rpcError: JsonRpcError<JsonRpcResult>
Returns ContractExecutionError
Properties
cause
code
code: numbermessage
message: stringReadonlyname
name: stringOptionalreceipt
stack
stack: undefined | stringStatic Optionalprepare
Optional override for formatting stack traces
Staticstack
stack Accessors
inner
- get innerError(): undefined | Error | Error[]
Returns undefined | Error | Error[]
- set innerError(cause): void
Returns void
Deprecated
Use the cause property instead.
diff --git a/docs/html/classes/_internal_.DeployerMethodClass.html b/docs/html/classes/_internal_.DeployerMethodClass.html
index ad04d9b3b..ac5e66d84 100644
--- a/docs/html/classes/_internal_.DeployerMethodClass.html
+++ b/docs/html/classes/_internal_.DeployerMethodClass.html
@@ -12,6 +12,6 @@
estimate
Constructors
constructor
- new
Type Parameters
- FullContractAbi extends ContractAbi
Parameters
- parent: Contract<FullContractAbi>
- deployOptions: undefined | {
arguments?: "/home/velenir-gnx570/Projects/Paraswap/paraswap-sdk/node_modules/web3-types/lib/commonjs/index".ContractConstructorArgs<FullContractAbi>;
data?: string;
input?: string;
}
Returns DeployerMethodClass<FullContractAbi>
Properties
Protected Readonlyargs
Protected Readonlyconstructor
Protected Readonlycontract
Protected Optional Readonlydeploy
deploydeploy
deploy
arguments?: "/home/velenir-gnx570/Projects/Paraswap/paraswap-sdk/node_modules/web3-types/lib/commonjs/index".ContractConstructorArgs<FullContractAbi>;
data?: string;
input?: string;
}Type declaration
Optionalarguments?: "/home/velenir-gnx570/Projects/Paraswap/paraswap-sdk/node_modules/web3-types/lib/commonjs/index".ContractConstructorArgs<FullContractAbi>
The arguments which get passed to the constructor on deployment.
+
Constructors
constructor
- new
Type Parameters
- FullContractAbi extends ContractAbi
Parameters
- parent: Contract<FullContractAbi>
- deployOptions: undefined | {
arguments?: "/Users/andriishymkiv/work/velora/sdk/node_modules/web3-types/lib/commonjs/index".ContractConstructorArgs<FullContractAbi>;
data?: string;
input?: string;
}
Returns DeployerMethodClass<FullContractAbi>
Properties
Protected Readonlyargs
Protected Readonlyconstructor
Protected Readonlycontract
Protected Optional Readonlydeploy
deploydeploy
deploy
arguments?: "/Users/andriishymkiv/work/velora/sdk/node_modules/web3-types/lib/commonjs/index".ContractConstructorArgs<FullContractAbi>;
data?: string;
input?: string;
}Type declaration
Optionalarguments?: "/Users/andriishymkiv/work/velora/sdk/node_modules/web3-types/lib/commonjs/index".ContractConstructorArgs<FullContractAbi>
The arguments which get passed to the constructor on deployment.
Optionaldata?: string
The byte code of the contract.
-Optionalinput?: string
parent
Methods
Protected_contract
- _contract
Parameters
- tx: TransactionCall
Returns Web3PromiEvent<Contract<FullContractAbi>, SendTransactionEvents<DataFormat>>
Protectedcalculate
- calculate
abi: AbiConstructorFragment;
args: never[] | NonNullable<"/home/velenir-gnx570/Projects/Paraswap/paraswap-sdk/node_modules/web3-types/lib/commonjs/index".ContractConstructorArgs<FullContractAbi>>;
contractOptions: ContractOptions;
deployData: undefined | string;
} Returns {
abi: AbiConstructorFragment;
args: never[] | NonNullable<"/home/velenir-gnx570/Projects/Paraswap/paraswap-sdk/node_modules/web3-types/lib/commonjs/index".ContractConstructorArgs<FullContractAbi>>;
contractOptions: ContractOptions;
deployData: undefined | string;
}
abi: AbiConstructorFragment
args: never[] | NonNullable<"/home/velenir-gnx570/Projects/Paraswap/paraswap-sdk/node_modules/web3-types/lib/commonjs/index".ContractConstructorArgs<FullContractAbi>>
contract
deploy
decode
encodeABI
estimate
- estimate
Type Parameters
- ReturnFormat extends DataFormat = {
bytes: HEX;
number: BIGINT;
}
Parameters
Optionaloptions: PayableCallOptionsOptionalreturnFormat: ReturnFormat
Returns Promise<NumberTypes[ReturnFormat["number"]]>
populate
- populate
Parameters
OptionaltxOptions: PayableCallOptions | NonPayableCallOptions
Returns TransactionCall
send
- send(options?): ContractDeploySend<FullContractAbi>
Parameters
Optionaloptions: PayableCallOptions
Returns ContractDeploySend<FullContractAbi>
Optionalinput?: stringProtected_contractProtectedcalculateOptionaloptions: PayableCallOptionsOptionalreturnFormat: ReturnFormatOptionaltxOptions: PayableCallOptions | NonPayableCallOptionsOptionaloptions: PayableCallOptionsimport { ENS } from 'web3-eth-ens';
const ens = new ENS(undefined,'https://127.0.0.1:4545');
console.log(await ens.getAddress('vitalik.eth'));
Use to create an instance of ENS
OptionalregistryAddr: string(Optional) The address of the ENS registry (default: mainnet registry address)
-Optionalprovider: string | SupportedProviders<EthExecutionAPI & Web3NetAPI> | Web3ContextObject<EthExecutionAPI & Web3NetAPI>(Optional) The provider to use for the ENS instance
+Optionalprovider: string | SupportedProviders<EthExecutionAPI & Web3NetAPI> | Web3ContextObject<EthExecutionAPI & Web3NetAPI>(Optional) The provider to use for the ENS instance
Protected Optional_accountProtected_requestProtected_subscriptionProtected Optional_walletReadonlyprovidersThe registryAddress property can be used to define a custom registry address when you are connected to an unknown chain. It defaults to the main registry address.
+Protected Optional_accountProtected_requestProtected_subscriptionProtected Optional_walletReadonlyprovidersThe registryAddress property can be used to define a custom registry address when you are connected to an unknown chain. It defaults to the main registry address.
Static OptionalgivenStatic ReadonlyprovidersWill return the Web3BatchRequest constructor.
The blockHeaderTimeout is used over socket-based connections. This option defines the amount seconds it should wait for 'newBlockHeaders' event before falling back to polling to fetch transaction receipt.
Default is 10 seconds.
The enableExperimentalFeatures is used to enable trying new experimental features that are still not fully implemented or not fully tested or still have some related issues.
Default is false for every feature.
Will set the enableExperimentalFeatures
-Will return the givenProvider if available.
@@ -229,24 +229,24 @@This method allows extending the web3 modules. Note: This method is only for backward compatibility, and It is recommended to use Web3 v4 Plugin feature for extending web3.js functionality if you are developing something new.
-Resolves an ENS name to an Ethereum address.
+Resolves an ENS name to an Ethereum address.
The ENS name to resolve
OptionalcoinType: number(Optional) The coin type, defaults to 60 (ETH)
-const address = await web3.eth.ens.getAddress('ethereum.eth');
console.log(address);
> '0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359'
Returns the content hash object associated with an ENS node.
+Returns the content hash object associated with an ENS node.
The ENS name
-Returns the X and Y coordinates of the curve point for the public key.
+Returns the X and Y coordinates of the curve point for the public key.
The ENS name
-const key = await web3.eth.ens.getPubkey('ethereum.eth');
console.log(key);
> {
"0": "0x0000000000000000000000000000000000000000000000000000000000000000",
"1": "0x0000000000000000000000000000000000000000000000000000000000000000",
"x": "0x0000000000000000000000000000000000000000000000000000000000000000",
"y": "0x0000000000000000000000000000000000000000000000000000000000000000"
}
@@ -297,23 +297,23 @@
register
- register
Parameters
- plugin: Web3PluginBase<unknown>
Returns void
remove
set
- set
Sets the address of an ENS name in his resolver.
+
Sets the address of an ENS name in his resolver.
The ENS name
The address to set
-(Optional) The transaction config
-(Optional) The transaction config
+const receipt = await ens.setAddress('web3js.eth','0xe2597eb05cf9a87eb1309e86750c903ec38e527e');
Will set the provider.
-Optionalprovider: string | SupportedProviders<EthExecutionAPI & Web3NetAPI>SupportedProviders The provider to set
+Optionalprovider: string | SupportedProviders<EthExecutionAPI & Web3NetAPI>SupportedProviders The provider to set
Returns true if the provider was set
-Returns true if the related Resolver does support the given signature or interfaceId.
+Returns true if the related Resolver does support the given signature or interfaceId.
The ENS name
The signature of the function or the interfaceId as described in the ENS documentation
-true if the related Resolver does support the given signature or interfaceId.const supports = await web3.eth.ens.supportsInterface('ethereum.eth', 'addr(bytes32');
console.log(supports);
> true
diff --git a/docs/html/classes/_internal_.Eip838ExecutionError.html b/docs/html/classes/_internal_.Eip838ExecutionError.html
index f21eb8a55..83b1a28f5 100644
--- a/docs/html/classes/_internal_.Eip838ExecutionError.html
+++ b/docs/html/classes/_internal_.Eip838ExecutionError.html
@@ -18,7 +18,7 @@
toJSON
captureOptionaldataOptionalerrorOptionalerrorOptionalerrorReadonlynameOptionalreceiptStatic OptionalprepareOptional override for formatting stack traces
+OptionaldataOptionalerrorOptionalerrorOptionalerrorReadonlynameOptionalreceiptStatic OptionalprepareOptional override for formatting stack traces
StaticstackUse the cause property instead.
Minimal EventEmitter interface that is molded against the Node.js
EventEmitter interface.
Optionalcontext: ContextCalls each of the listeners registered for a given event.
-Rest...args: Parameters<EventListener<EventTypes, T>>Return an array listing the events for which the emitter has registered +
Optionalcontext: ContextCalls each of the listeners registered for a given event.
+Rest...args: Parameters<EventListener<EventTypes, T>>Return an array listing the events for which the emitter has registered listeners.
Return the number of listeners listening to a given event.
-Return the listeners registered for a given event.
-Optionalfn: EventListener<EventTypes, T>Optionalcontext: ContextOptionalonce: booleanAdd a listener for a given event.
-Optionalcontext: ContextAdd a one-time listener for a given event.
-Optionalcontext: ContextRemove all listeners, or those of the specified event.
+Return the listeners registered for a given event.
+Optionalfn: EventListener<EventTypes, T>Optionalcontext: ContextOptionalonce: booleanAdd a listener for a given event.
+Optionalcontext: ContextAdd a one-time listener for a given event.
+Optionalcontext: ContextRemove all listeners, or those of the specified event.
Optionalevent: EventEmitter.EventNames<EventTypes>Remove the listeners of a given event.
-Optionalfn: EventListener<EventTypes, T>Optionalcontext: ContextOptionalonce: booleanOptionalfn: EventListener<EventTypes, T>Optionalcontext: ContextOptionalonce: boolean
Optional override for formatting stack traces
+