superxerox-sdk
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Etherscan
Provider
constructor
_bootstrap
Poll
_emitted
_events
_fast
Block
Number
_fast
Block
Number
Promise
_fast
Query
Date
_internal
Block
Number
_is
Provider
_last
Block
Number
_max
Internal
Block
Number
_network
_network
Promise
_poller
_polling
Interval
any
Network
api
Key
base
Url
formatter
block
Number
network
polling
polling
Interval
ready
_add
Event
Listener
_get
Address
_get
Block
_get
Block
Tag
_get
Fast
Block
Number
_get
Filter
_get
Internal
Block
Number
_get
Resolver
_get
Transaction
Request
_ready
_set
Fast
Block
Number
_start
Event
_stop
Event
_wait
For
Transaction
_wrap
Transaction
add
Listener
call
detect
Network
emit
estimate
Gas
fetch
get
Balance
get
Base
Url
get
Block
get
Block
Number
get
Block
With
Transactions
get
Code
get
Ether
Price
get
Fee
Data
get
Gas
Price
get
History
get
Logs
get
Network
get
Post
Data
get
Post
Url
get
Resolver
get
Storage
At
get
Transaction
get
Transaction
Count
get
Transaction
Receipt
get
Url
is
Community
Resource
listener
Count
listeners
lookup
Address
off
on
once
perform
poll
remove
All
Listeners
remove
Listener
reset
Events
Block
resolve
Name
send
Transaction
wait
For
Transaction
get
Formatter
get
Network
is
Provider
Hierarchy
BaseProvider
EtherscanProvider
Index
Constructors
constructor
Properties
_bootstrap
Poll
_emitted
_events
_fast
Block
Number
_fast
Block
Number
Promise
_fast
Query
Date
_internal
Block
Number
_is
Provider
_last
Block
Number
_max
Internal
Block
Number
_network
_network
Promise
_poller
_polling
Interval
any
Network
api
Key
base
Url
formatter
Accessors
block
Number
network
polling
polling
Interval
ready
Methods
_add
Event
Listener
_get
Address
_get
Block
_get
Block
Tag
_get
Fast
Block
Number
_get
Filter
_get
Internal
Block
Number
_get
Resolver
_get
Transaction
Request
_ready
_set
Fast
Block
Number
_start
Event
_stop
Event
_wait
For
Transaction
_wrap
Transaction
add
Listener
call
detect
Network
emit
estimate
Gas
fetch
get
Balance
get
Base
Url
get
Block
get
Block
Number
get
Block
With
Transactions
get
Code
get
Ether
Price
get
Fee
Data
get
Gas
Price
get
History
get
Logs
get
Network
get
Post
Data
get
Post
Url
get
Resolver
get
Storage
At
get
Transaction
get
Transaction
Count
get
Transaction
Receipt
get
Url
is
Community
Resource
listener
Count
listeners
lookup
Address
off
on
once
perform
poll
remove
All
Listeners
remove
Listener
reset
Events
Block
resolve
Name
send
Transaction
wait
For
Transaction
get
Formatter
get
Network
is
Provider
Constructors
constructor
new
Etherscan
Provider
(
network
?:
Networkish
, apiKey
?:
string
)
:
EtherscanProvider
Parameters
Optional
network:
Networkish
Optional
apiKey:
string
Returns
EtherscanProvider
Properties
_bootstrap
Poll
_bootstrap
Poll
:
Timer
_emitted
_emitted
:
{}
Type declaration
[
eventName:
string
]:
number
|
"pending"
_events
_events
:
Event
[]
_fast
Block
Number
_fast
Block
Number
:
number
_fast
Block
Number
Promise
_fast
Block
Number
Promise
:
Promise
<
number
>
_fast
Query
Date
_fast
Query
Date
:
number
_internal
Block
Number
_internal
Block
Number
:
Promise
<
{
blockNumber
:
number
;
reqTime
:
number
;
respTime
:
number
}
>
Readonly
_is
Provider
_is
Provider
:
boolean
_last
Block
Number
_last
Block
Number
:
number
_max
Internal
Block
Number
_max
Internal
Block
Number
:
number
_network
_network
:
Network
_network
Promise
_network
Promise
:
Promise
<
Network
>
_poller
_poller
:
Timer
_polling
Interval
_polling
Interval
:
number
Readonly
any
Network
any
Network
:
boolean
Readonly
api
Key
api
Key
:
string
Readonly
base
Url
base
Url
:
string
formatter
formatter
:
Formatter
Accessors
block
Number
get
blockNumber
(
)
:
number
Returns
number
network
get
network
(
)
:
Network
Returns
Network
polling
get
polling
(
)
:
boolean
set
polling
(
value
:
boolean
)
:
any
Returns
boolean
Parameters
value:
boolean
Returns
any
polling
Interval
get
pollingInterval
(
)
:
number
set
pollingInterval
(
value
:
number
)
:
any
Returns
number
Parameters
value:
number
Returns
any
ready
get
ready
(
)
:
Promise
<
Network
>
Returns
Promise
<
Network
>
Methods
_add
Event
Listener
_add
Event
Listener
(
eventName
:
EventType
, listener
:
Listener
, once
:
boolean
)
:
EtherscanProvider
Parameters
eventName:
EventType
listener:
Listener
once:
boolean
Returns
EtherscanProvider
_get
Address
_get
Address
(
addressOrName
:
string
|
Promise
<
string
>
)
:
Promise
<
string
>
Parameters
addressOrName:
string
|
Promise
<
string
>
Returns
Promise
<
string
>
_get
Block
_get
Block
(
blockHashOrBlockTag
:
BlockTag
|
Promise
<
BlockTag
>
, includeTransactions
?:
boolean
)
:
Promise
<
Block
|
BlockWithTransactions
>
Parameters
blockHashOrBlockTag:
BlockTag
|
Promise
<
BlockTag
>
Optional
includeTransactions:
boolean
Returns
Promise
<
Block
|
BlockWithTransactions
>
_get
Block
Tag
_get
Block
Tag
(
blockTag
:
BlockTag
|
Promise
<
BlockTag
>
)
:
Promise
<
BlockTag
>
Parameters
blockTag:
BlockTag
|
Promise
<
BlockTag
>
Returns
Promise
<
BlockTag
>
_get
Fast
Block
Number
_get
Fast
Block
Number
(
)
:
Promise
<
number
>
Returns
Promise
<
number
>
_get
Filter
_get
Filter
(
filter
:
Filter
|
FilterByBlockHash
|
Promise
<
Filter
|
FilterByBlockHash
>
)
:
Promise
<
Filter
|
FilterByBlockHash
>
Parameters
filter:
Filter
|
FilterByBlockHash
|
Promise
<
Filter
|
FilterByBlockHash
>
Returns
Promise
<
Filter
|
FilterByBlockHash
>
_get
Internal
Block
Number
_get
Internal
Block
Number
(
maxAge
:
number
)
:
Promise
<
number
>
Parameters
maxAge:
number
Returns
Promise
<
number
>
_get
Resolver
_get
Resolver
(
name
:
string
)
:
Promise
<
string
>
Parameters
name:
string
Returns
Promise
<
string
>
_get
Transaction
Request
_get
Transaction
Request
(
transaction
:
Deferrable
<
TransactionRequest
>
)
:
Promise
<
Transaction
>
Parameters
transaction:
Deferrable
<
TransactionRequest
>
Returns
Promise
<
Transaction
>
_ready
_ready
(
)
:
Promise
<
Network
>
Returns
Promise
<
Network
>
_set
Fast
Block
Number
_set
Fast
Block
Number
(
blockNumber
:
number
)
:
void
Parameters
blockNumber:
number
Returns
void
_start
Event
_start
Event
(
event
:
Event
)
:
void
Parameters
event:
Event
Returns
void
_stop
Event
_stop
Event
(
event
:
Event
)
:
void
Parameters
event:
Event
Returns
void
_wait
For
Transaction
_wait
For
Transaction
(
transactionHash
:
string
, confirmations
:
number
, timeout
:
number
, replaceable
:
{
data
:
string
;
from
:
string
;
nonce
:
number
;
startBlock
:
number
;
to
:
string
;
value
:
BigNumber
}
)
:
Promise
<
TransactionReceipt
>
Parameters
transactionHash:
string
confirmations:
number
timeout:
number
replaceable:
{
data
:
string
;
from
:
string
;
nonce
:
number
;
startBlock
:
number
;
to
:
string
;
value
:
BigNumber
}
data
:
string
from
:
string
nonce
:
number
start
Block
:
number
to
:
string
value
:
BigNumber
Returns
Promise
<
TransactionReceipt
>
_wrap
Transaction
_wrap
Transaction
(
tx
:
Transaction
, hash
?:
string
, startBlock
?:
number
)
:
TransactionResponse
Parameters
tx:
Transaction
Optional
hash:
string
Optional
startBlock:
number
Returns
TransactionResponse
add
Listener
add
Listener
(
eventName
:
EventType
, listener
:
Listener
)
:
Provider
Parameters
eventName:
EventType
listener:
Listener
Returns
Provider
call
call
(
transaction
:
Deferrable
<
TransactionRequest
>
, blockTag
?:
BlockTag
|
Promise
<
BlockTag
>
)
:
Promise
<
string
>
Parameters
transaction:
Deferrable
<
TransactionRequest
>
Optional
blockTag:
BlockTag
|
Promise
<
BlockTag
>
Returns
Promise
<
string
>
detect
Network
detect
Network
(
)
:
Promise
<
Network
>
Returns
Promise
<
Network
>
emit
emit
(
eventName
:
EventType
,
...
args
:
any
[]
)
:
boolean
Parameters
eventName:
EventType
Rest
...
args:
any
[]
Returns
boolean
estimate
Gas
estimate
Gas
(
transaction
:
Deferrable
<
TransactionRequest
>
)
:
Promise
<
BigNumber
>
Parameters
transaction:
Deferrable
<
TransactionRequest
>
Returns
Promise
<
BigNumber
>
fetch
fetch
(
module
:
string
, params
:
Record
<
string
,
any
>
, post
?:
boolean
)
:
Promise
<
any
>
Parameters
module:
string
params:
Record
<
string
,
any
>
Optional
post:
boolean
Returns
Promise
<
any
>
get
Balance
get
Balance
(
addressOrName
:
string
|
Promise
<
string
>
, blockTag
?:
BlockTag
|
Promise
<
BlockTag
>
)
:
Promise
<
BigNumber
>
Parameters
addressOrName:
string
|
Promise
<
string
>
Optional
blockTag:
BlockTag
|
Promise
<
BlockTag
>
Returns
Promise
<
BigNumber
>
get
Base
Url
get
Base
Url
(
)
:
string
Returns
string
get
Block
get
Block
(
blockHashOrBlockTag
:
BlockTag
|
Promise
<
BlockTag
>
)
:
Promise
<
Block
>
Parameters
blockHashOrBlockTag:
BlockTag
|
Promise
<
BlockTag
>
Returns
Promise
<
Block
>
get
Block
Number
get
Block
Number
(
)
:
Promise
<
number
>
Returns
Promise
<
number
>
get
Block
With
Transactions
get
Block
With
Transactions
(
blockHashOrBlockTag
:
BlockTag
|
Promise
<
BlockTag
>
)
:
Promise
<
BlockWithTransactions
>
Parameters
blockHashOrBlockTag:
BlockTag
|
Promise
<
BlockTag
>
Returns
Promise
<
BlockWithTransactions
>
get
Code
get
Code
(
addressOrName
:
string
|
Promise
<
string
>
, blockTag
?:
BlockTag
|
Promise
<
BlockTag
>
)
:
Promise
<
string
>
Parameters
addressOrName:
string
|
Promise
<
string
>
Optional
blockTag:
BlockTag
|
Promise
<
BlockTag
>
Returns
Promise
<
string
>
get
Ether
Price
get
Ether
Price
(
)
:
Promise
<
number
>
Returns
Promise
<
number
>
get
Fee
Data
get
Fee
Data
(
)
:
Promise
<
FeeData
>
Returns
Promise
<
FeeData
>
get
Gas
Price
get
Gas
Price
(
)
:
Promise
<
BigNumber
>
Returns
Promise
<
BigNumber
>
get
History
get
History
(
addressOrName
:
string
|
Promise
<
string
>
, startBlock
?:
BlockTag
, endBlock
?:
BlockTag
)
:
Promise
<
TransactionResponse
[]
>
Parameters
addressOrName:
string
|
Promise
<
string
>
Optional
startBlock:
BlockTag
Optional
endBlock:
BlockTag
Returns
Promise
<
TransactionResponse
[]
>
get
Logs
get
Logs
(
filter
:
Filter
|
FilterByBlockHash
|
Promise
<
Filter
|
FilterByBlockHash
>
)
:
Promise
<
Log
[]
>
Parameters
filter:
Filter
|
FilterByBlockHash
|
Promise
<
Filter
|
FilterByBlockHash
>
Returns
Promise
<
Log
[]
>
get
Network
get
Network
(
)
:
Promise
<
Network
>
Returns
Promise
<
Network
>
get
Post
Data
get
Post
Data
(
module
:
string
, params
:
Record
<
string
,
any
>
)
:
Record
<
string
,
any
>
Parameters
module:
string
params:
Record
<
string
,
any
>
Returns
Record
<
string
,
any
>
get
Post
Url
get
Post
Url
(
)
:
string
Returns
string
get
Resolver
get
Resolver
(
name
:
string
)
:
Promise
<
Resolver
>
Parameters
name:
string
Returns
Promise
<
Resolver
>
get
Storage
At
get
Storage
At
(
addressOrName
:
string
|
Promise
<
string
>
, position
:
BigNumberish
|
Promise
<
BigNumberish
>
, blockTag
?:
BlockTag
|
Promise
<
BlockTag
>
)
:
Promise
<
string
>
Parameters
addressOrName:
string
|
Promise
<
string
>
position:
BigNumberish
|
Promise
<
BigNumberish
>
Optional
blockTag:
BlockTag
|
Promise
<
BlockTag
>
Returns
Promise
<
string
>
get
Transaction
get
Transaction
(
transactionHash
:
string
|
Promise
<
string
>
)
:
Promise
<
TransactionResponse
>
Parameters
transactionHash:
string
|
Promise
<
string
>
Returns
Promise
<
TransactionResponse
>
get
Transaction
Count
get
Transaction
Count
(
addressOrName
:
string
|
Promise
<
string
>
, blockTag
?:
BlockTag
|
Promise
<
BlockTag
>
)
:
Promise
<
number
>
Parameters
addressOrName:
string
|
Promise
<
string
>
Optional
blockTag:
BlockTag
|
Promise
<
BlockTag
>
Returns
Promise
<
number
>
get
Transaction
Receipt
get
Transaction
Receipt
(
transactionHash
:
string
|
Promise
<
string
>
)
:
Promise
<
TransactionReceipt
>
Parameters
transactionHash:
string
|
Promise
<
string
>
Returns
Promise
<
TransactionReceipt
>
get
Url
get
Url
(
module
:
string
, params
:
Record
<
string
,
string
>
)
:
string
Parameters
module:
string
params:
Record
<
string
,
string
>
Returns
string
is
Community
Resource
is
Community
Resource
(
)
:
boolean
Returns
boolean
listener
Count
listener
Count
(
eventName
?:
EventType
)
:
number
Parameters
Optional
eventName:
EventType
Returns
number
listeners
listeners
(
eventName
?:
EventType
)
:
Listener
[]
Parameters
Optional
eventName:
EventType
Returns
Listener
[]
lookup
Address
lookup
Address
(
address
:
string
|
Promise
<
string
>
)
:
Promise
<
string
>
Parameters
address:
string
|
Promise
<
string
>
Returns
Promise
<
string
>
off
off
(
eventName
:
EventType
, listener
?:
Listener
)
:
EtherscanProvider
Parameters
eventName:
EventType
Optional
listener:
Listener
Returns
EtherscanProvider
on
on
(
eventName
:
EventType
, listener
:
Listener
)
:
EtherscanProvider
Parameters
eventName:
EventType
listener:
Listener
Returns
EtherscanProvider
once
once
(
eventName
:
EventType
, listener
:
Listener
)
:
EtherscanProvider
Parameters
eventName:
EventType
listener:
Listener
Returns
EtherscanProvider
perform
perform
(
method
:
string
, params
:
any
)
:
Promise
<
any
>
Parameters
method:
string
params:
any
Returns
Promise
<
any
>
poll
poll
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
remove
All
Listeners
remove
All
Listeners
(
eventName
?:
EventType
)
:
EtherscanProvider
Parameters
Optional
eventName:
EventType
Returns
EtherscanProvider
remove
Listener
remove
Listener
(
eventName
:
EventType
, listener
:
Listener
)
:
Provider
Parameters
eventName:
EventType
listener:
Listener
Returns
Provider
reset
Events
Block
reset
Events
Block
(
blockNumber
:
number
)
:
void
Parameters
blockNumber:
number
Returns
void
resolve
Name
resolve
Name
(
name
:
string
|
Promise
<
string
>
)
:
Promise
<
string
>
Parameters
name:
string
|
Promise
<
string
>
Returns
Promise
<
string
>
send
Transaction
send
Transaction
(
signedTransaction
:
string
|
Promise
<
string
>
)
:
Promise
<
TransactionResponse
>
Parameters
signedTransaction:
string
|
Promise
<
string
>
Returns
Promise
<
TransactionResponse
>
wait
For
Transaction
wait
For
Transaction
(
transactionHash
:
string
, confirmations
?:
number
, timeout
?:
number
)
:
Promise
<
TransactionReceipt
>
Parameters
transactionHash:
string
Optional
confirmations:
number
Optional
timeout:
number
Returns
Promise
<
TransactionReceipt
>
Static
get
Formatter
get
Formatter
(
)
:
Formatter
Returns
Formatter
Static
get
Network
get
Network
(
network
:
Networkish
)
:
Network
Parameters
network:
Networkish
Returns
Network
Static
is
Provider
is
Provider
(
value
:
any
)
:
value
is
Provider
Parameters
value:
any
Returns
value
is
Provider
Generated using
TypeDoc