@circle-fin/usdckit - v0.18.0
Preparing search index...
providers/smart-contract-platform
getContract
Function getContract
getContract
(
client
:
ExtendedViemClient
,
params
:
GetContractInput
,
)
:
Promise
<
{
abi
:
Abi
;
address
:
`
0x
${
string
}
`
;
createEventFilter
:
{
[
key
:
string
]:
<
strict
extends
undefined
|
boolean
=
undefined
>
(
...
parameters
:
|
[
options
?:
{
fromBlock
?:
bigint
|
BlockTag
;
toBlock
?:
bigint
|
BlockTag
;
}
&
{
strict
?:
strict
}
,
]
|
[
args
:
|
readonly
unknown
[]
|
{
abi
?:
undefined
;
address
?:
undefined
;
args
?:
undefined
;
eventName
?:
undefined
;
fromBlock
?:
undefined
;
strict
?:
undefined
;
toBlock
?:
undefined
;
[
key
:
string
]:
unknown
;
}
,
options
?:
{
fromBlock
?:
bigint
|
BlockTag
;
toBlock
?:
bigint
|
BlockTag
;
}
&
{
strict
?:
strict
}
,
]
,
)
=>
Promise
<
CreateContractEventFilterReturnType
>
;
}
;
estimateGas
:
{
[
key
:
string
]:
(
...
parameters
:
|
[
options
:
Prettify
<
UnionOmit
<
EstimateContractGasParameters
<
Abi
,
string
,
readonly
(...)
[]
,
Chain
,
>
,
"address"
|
"abi"
|
"functionName"
|
"args"
,
>
,
>
,
]
|
[
args
:
readonly
unknown
[]
,
options
:
Prettify
<
UnionOmit
<
EstimateContractGasParameters
<
Abi
,
string
,
readonly
(...)
[]
,
Chain
,
>
,
"address"
|
"abi"
|
"functionName"
|
"args"
,
>
,
>
,
]
,
)
=>
Promise
<
bigint
>
;
}
&
{
[
key
:
string
]:
(
...
parameters
:
|
[
options
?:
Prettify
<
UnionOmit
<
EstimateContractGasParameters
<
(...)
,
(...)
,
(...)
,
(...)
>
,
(...)
|
(...)
|
(...)
|
(...)
,
>
,
>
,
]
|
[
args
:
readonly
unknown
[]
,
options
?:
Prettify
<
UnionOmit
<
EstimateContractGasParameters
<
(...)
,
(...)
,
(...)
,
(...)
>
,
(...)
|
(...)
|
(...)
|
(...)
,
>
,
>
,
]
,
)
=>
Promise
<
bigint
>
;
}
;
getEvents
:
{
[
key
:
string
]:
(
...
parameters
:
|
[
options
?:
{
blockHash
?:
`
0x
${
string
}
`
;
fromBlock
?:
bigint
|
BlockTag
;
strict
?:
boolean
;
toBlock
?:
bigint
|
BlockTag
;
}
,
]
|
[
args
?:
|
readonly
unknown
[]
|
{
abi
?:
undefined
;
address
?:
undefined
;
args
?:
undefined
;
batch
?:
undefined
;
eventName
?:
undefined
;
fromBlock
?:
undefined
;
onError
?:
undefined
;
onLogs
?:
undefined
;
poll
?:
undefined
;
pollingInterval
?:
undefined
;
strict
?:
undefined
;
[
key
:
string
]:
unknown
;
}
,
options
?:
{
blockHash
?:
`
0x
${
string
}
`
;
fromBlock
?:
bigint
|
BlockTag
;
strict
?:
boolean
;
toBlock
?:
bigint
|
BlockTag
;
}
,
]
,
)
=>
Promise
<
GetContractEventsReturnType
<
Abi
,
string
>
>
;
}
;
read
:
{
[
key
:
string
]:
(
...
parameters
:
|
[
options
?:
Prettify
<
UnionOmit
<
ReadContractParameters
<
Abi
,
string
,
readonly
(...)
[]
>
,
"address"
|
"abi"
|
"functionName"
|
"args"
,
>
,
>
,
]
|
[
args
:
readonly
unknown
[]
,
options
?:
Prettify
<
UnionOmit
<
ReadContractParameters
<
Abi
,
string
,
readonly
(...)
[]
>
,
"address"
|
"abi"
|
"functionName"
|
"args"
,
>
,
>
,
]
,
)
=>
Promise
<
unknown
>
;
}
;
simulate
:
{
[
key
:
string
]:
<
chainOverride
extends
undefined
|
Chain
=
undefined
,
accountOverride
extends
undefined
|
`
0x
${
string
}
`
|
Account
=
undefined
,
>
(
...
parameters
:
|
[
options
?:
Omit
<
SimulateContractParameters
<
Abi
,
string
,
readonly
unknown
[]
,
Chain
,
chainOverride
,
accountOverride
,
>
,
"address"
|
"abi"
|
"functionName"
|
"args"
,
>
,
]
|
[
args
:
readonly
unknown
[]
,
options
?:
Omit
<
SimulateContractParameters
<
Abi
,
string
,
readonly
unknown
[]
,
Chain
,
chainOverride
,
accountOverride
,
>
,
"address"
|
"abi"
|
"functionName"
|
"args"
,
>
,
]
,
)
=>
Promise
<
SimulateContractReturnType
>
;
}
;
watchEvent
:
{
[
key
:
string
]:
(
...
parameters
:
|
[
options
?:
{
batch
?:
boolean
;
fromBlock
?:
bigint
;
onError
?:
(
error
:
Error
)
=>
void
;
onLogs
:
WatchContractEventOnLogsFn
<
Abi
,
string
,
undefined
>
;
poll
?:
true
;
pollingInterval
?:
number
;
strict
?:
boolean
;
}
,
]
|
[
args
:
|
readonly
unknown
[]
|
{
abi
?:
undefined
;
address
?:
undefined
;
args
?:
undefined
;
batch
?:
undefined
;
eventName
?:
undefined
;
fromBlock
?:
undefined
;
onError
?:
undefined
;
onLogs
?:
undefined
;
poll
?:
undefined
;
pollingInterval
?:
undefined
;
strict
?:
undefined
;
[
key
:
string
]:
unknown
;
}
,
options
?:
{
batch
?:
boolean
;
fromBlock
?:
bigint
;
onError
?:
(
error
:
Error
)
=>
void
;
onLogs
:
WatchContractEventOnLogsFn
<
Abi
,
string
,
undefined
>
;
poll
?:
true
;
pollingInterval
?:
number
;
strict
?:
boolean
;
}
,
]
,
)
=>
WatchContractEventReturnType
;
}
;
write
:
{
[
key
:
string
]:
<
chainOverride
extends
undefined
|
Chain
,
options
extends
{
[
K
in
string
|
number
|
symbol
]
:
UnionOmit
<
WriteContractParameters
<
Abi
,
string
,
readonly
unknown
[]
,
Chain
,
Account
,
chainOverride
,
>
,
"address"
|
"abi"
|
"functionName"
|
"args"
,
>
[
K
]
}
,
Rest
extends
unknown
[]
=
[
options
?:
options
]
,
>
(
...
parameters
:
|
Rest
|
[
args
:
readonly
unknown
[]
,
...
parameters
:
Rest
[]
]
,
)
=>
Promise
<
`
0x
${
string
}
`
>
;
}
;
}
,
>
Parameters
client
:
ExtendedViemClient
params
:
GetContractInput
Returns
Promise
<
{
abi
:
Abi
;
address
:
`
0x
${
string
}
`
;
createEventFilter
:
{
[
key
:
string
]:
<
strict
extends
undefined
|
boolean
=
undefined
>
(
...
parameters
:
|
[
options
?:
{
fromBlock
?:
bigint
|
BlockTag
;
toBlock
?:
bigint
|
BlockTag
;
}
&
{
strict
?:
strict
}
,
]
|
[
args
:
|
readonly
unknown
[]
|
{
abi
?:
undefined
;
address
?:
undefined
;
args
?:
undefined
;
eventName
?:
undefined
;
fromBlock
?:
undefined
;
strict
?:
undefined
;
toBlock
?:
undefined
;
[
key
:
string
]:
unknown
;
}
,
options
?:
{
fromBlock
?:
bigint
|
BlockTag
;
toBlock
?:
bigint
|
BlockTag
;
}
&
{
strict
?:
strict
}
,
]
,
)
=>
Promise
<
CreateContractEventFilterReturnType
>
;
}
;
estimateGas
:
{
[
key
:
string
]:
(
...
parameters
:
|
[
options
:
Prettify
<
UnionOmit
<
EstimateContractGasParameters
<
Abi
,
string
,
readonly
(...)
[]
,
Chain
,
>
,
"address"
|
"abi"
|
"functionName"
|
"args"
,
>
,
>
,
]
|
[
args
:
readonly
unknown
[]
,
options
:
Prettify
<
UnionOmit
<
EstimateContractGasParameters
<
Abi
,
string
,
readonly
(...)
[]
,
Chain
,
>
,
"address"
|
"abi"
|
"functionName"
|
"args"
,
>
,
>
,
]
,
)
=>
Promise
<
bigint
>
;
}
&
{
[
key
:
string
]:
(
...
parameters
:
|
[
options
?:
Prettify
<
UnionOmit
<
EstimateContractGasParameters
<
(...)
,
(...)
,
(...)
,
(...)
>
,
(...)
|
(...)
|
(...)
|
(...)
,
>
,
>
,
]
|
[
args
:
readonly
unknown
[]
,
options
?:
Prettify
<
UnionOmit
<
EstimateContractGasParameters
<
(...)
,
(...)
,
(...)
,
(...)
>
,
(...)
|
(...)
|
(...)
|
(...)
,
>
,
>
,
]
,
)
=>
Promise
<
bigint
>
;
}
;
getEvents
:
{
[
key
:
string
]:
(
...
parameters
:
|
[
options
?:
{
blockHash
?:
`
0x
${
string
}
`
;
fromBlock
?:
bigint
|
BlockTag
;
strict
?:
boolean
;
toBlock
?:
bigint
|
BlockTag
;
}
,
]
|
[
args
?:
|
readonly
unknown
[]
|
{
abi
?:
undefined
;
address
?:
undefined
;
args
?:
undefined
;
batch
?:
undefined
;
eventName
?:
undefined
;
fromBlock
?:
undefined
;
onError
?:
undefined
;
onLogs
?:
undefined
;
poll
?:
undefined
;
pollingInterval
?:
undefined
;
strict
?:
undefined
;
[
key
:
string
]:
unknown
;
}
,
options
?:
{
blockHash
?:
`
0x
${
string
}
`
;
fromBlock
?:
bigint
|
BlockTag
;
strict
?:
boolean
;
toBlock
?:
bigint
|
BlockTag
;
}
,
]
,
)
=>
Promise
<
GetContractEventsReturnType
<
Abi
,
string
>
>
;
}
;
read
:
{
[
key
:
string
]:
(
...
parameters
:
|
[
options
?:
Prettify
<
UnionOmit
<
ReadContractParameters
<
Abi
,
string
,
readonly
(...)
[]
>
,
"address"
|
"abi"
|
"functionName"
|
"args"
,
>
,
>
,
]
|
[
args
:
readonly
unknown
[]
,
options
?:
Prettify
<
UnionOmit
<
ReadContractParameters
<
Abi
,
string
,
readonly
(...)
[]
>
,
"address"
|
"abi"
|
"functionName"
|
"args"
,
>
,
>
,
]
,
)
=>
Promise
<
unknown
>
;
}
;
simulate
:
{
[
key
:
string
]:
<
chainOverride
extends
undefined
|
Chain
=
undefined
,
accountOverride
extends
undefined
|
`
0x
${
string
}
`
|
Account
=
undefined
,
>
(
...
parameters
:
|
[
options
?:
Omit
<
SimulateContractParameters
<
Abi
,
string
,
readonly
unknown
[]
,
Chain
,
chainOverride
,
accountOverride
,
>
,
"address"
|
"abi"
|
"functionName"
|
"args"
,
>
,
]
|
[
args
:
readonly
unknown
[]
,
options
?:
Omit
<
SimulateContractParameters
<
Abi
,
string
,
readonly
unknown
[]
,
Chain
,
chainOverride
,
accountOverride
,
>
,
"address"
|
"abi"
|
"functionName"
|
"args"
,
>
,
]
,
)
=>
Promise
<
SimulateContractReturnType
>
;
}
;
watchEvent
:
{
[
key
:
string
]:
(
...
parameters
:
|
[
options
?:
{
batch
?:
boolean
;
fromBlock
?:
bigint
;
onError
?:
(
error
:
Error
)
=>
void
;
onLogs
:
WatchContractEventOnLogsFn
<
Abi
,
string
,
undefined
>
;
poll
?:
true
;
pollingInterval
?:
number
;
strict
?:
boolean
;
}
,
]
|
[
args
:
|
readonly
unknown
[]
|
{
abi
?:
undefined
;
address
?:
undefined
;
args
?:
undefined
;
batch
?:
undefined
;
eventName
?:
undefined
;
fromBlock
?:
undefined
;
onError
?:
undefined
;
onLogs
?:
undefined
;
poll
?:
undefined
;
pollingInterval
?:
undefined
;
strict
?:
undefined
;
[
key
:
string
]:
unknown
;
}
,
options
?:
{
batch
?:
boolean
;
fromBlock
?:
bigint
;
onError
?:
(
error
:
Error
)
=>
void
;
onLogs
:
WatchContractEventOnLogsFn
<
Abi
,
string
,
undefined
>
;
poll
?:
true
;
pollingInterval
?:
number
;
strict
?:
boolean
;
}
,
]
,
)
=>
WatchContractEventReturnType
;
}
;
write
:
{
[
key
:
string
]:
<
chainOverride
extends
undefined
|
Chain
,
options
extends
{
[
K
in
string
|
number
|
symbol
]
:
UnionOmit
<
WriteContractParameters
<
Abi
,
string
,
readonly
unknown
[]
,
Chain
,
Account
,
chainOverride
,
>
,
"address"
|
"abi"
|
"functionName"
|
"args"
,
>
[
K
]
}
,
Rest
extends
unknown
[]
=
[
options
?:
options
]
,
>
(
...
parameters
:
|
Rest
|
[
args
:
readonly
unknown
[]
,
...
parameters
:
Rest
[]
]
,
)
=>
Promise
<
`
0x
${
string
}
`
>
;
}
;
}
,
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
@circle-fin/usdckit - v0.18.0
Loading...