@circle-fin/usdckit - v0.21.0
Preparing search index...
providers/circle-wallets
Provider
Class Provider
Hierarchy
Provider
Provider
Index
Constructors
constructor
Methods
circle_
create
Contract
Execution
Transaction
circle_
create
Transaction
circle_
create
Wallets
circle_
create
Wallet
Set
circle_
derive
Wallet
circle_
estimate
Contract
Execution
Fee
circle_
estimate
Transfer
Fee
circle_
get
Notification
Signature
circle_
get
Transaction
circle_
get
Wallet
circle_
get
Wallets
With
Balances
circle_
get
Wallet
Token
Balance
circle_
import
Contract
circle_
list
Transactions
circle_
list
Wallets
circle_
request
Testnet
Tokens
circle_
sign
Transaction
circle_
sign
Typed
Data
request
Constructors
constructor
new
Provider
(
__namedParameters
:
{
apiKey
:
string
;
baseUrl
?:
string
;
entitySecret
:
string
;
}
,
)
:
Provider
Parameters
__namedParameters
:
{
apiKey
:
string
;
baseUrl
?:
string
;
entitySecret
:
string
}
Returns
Provider
Methods
circle_
create
Contract
Execution
Transaction
circle_createContractExecutionTransaction
(
params
:
CreateContractExecutionTransactionInput
,
)
:
Promise
<
Transaction
>
Parameters
params
:
CreateContractExecutionTransactionInput
Returns
Promise
<
Transaction
>
circle_
create
Transaction
circle_createTransaction
(
params
:
CreateTransactionInput
)
:
Promise
<
Transaction
>
Parameters
params
:
CreateTransactionInput
Returns
Promise
<
Transaction
>
circle_
create
Wallets
circle_createWallets
(
params
:
CreateWalletsInput
)
:
Promise
<
[
Wallet
,
...
Wallet
[]
]
>
Parameters
params
:
CreateWalletsInput
Returns
Promise
<
[
Wallet
,
...
Wallet
[]
]
>
circle_
create
Wallet
Set
circle_createWalletSet
(
params
:
CreateWalletSetInput
)
:
Promise
<
WalletSet
>
Parameters
params
:
CreateWalletSetInput
Returns
Promise
<
WalletSet
>
circle_
derive
Wallet
circle_deriveWallet
(
params
:
DeriveWalletInput
)
:
Promise
<
Wallet
>
Parameters
params
:
DeriveWalletInput
Returns
Promise
<
Wallet
>
circle_
estimate
Contract
Execution
Fee
circle_estimateContractExecutionFee
(
params
:
EstimateContractExecutionFeeInput
,
)
:
Promise
<
{
callGasLimit
?:
string
;
high
:
|
undefined
|
{
baseFee
?:
string
;
gasLimit
:
undefined
|
`
${
number
}
`
|
""
;
gasPrice
?:
string
;
maxFee
:
undefined
|
`
${
number
}
`
|
""
;
networkFee
?:
string
;
priorityFee
:
undefined
|
`
${
number
}
`
|
""
;
}
;
low
:
|
undefined
|
{
baseFee
?:
string
;
gasLimit
:
undefined
|
`
${
number
}
`
|
""
;
gasPrice
?:
string
;
maxFee
:
undefined
|
`
${
number
}
`
|
""
;
networkFee
?:
string
;
priorityFee
:
undefined
|
`
${
number
}
`
|
""
;
}
;
medium
:
|
undefined
|
{
baseFee
?:
string
;
gasLimit
:
undefined
|
`
${
number
}
`
|
""
;
gasPrice
?:
string
;
maxFee
:
undefined
|
`
${
number
}
`
|
""
;
networkFee
?:
string
;
priorityFee
:
undefined
|
`
${
number
}
`
|
""
;
}
;
preVerificationGas
?:
string
;
verificationGasLimit
?:
string
;
}
,
>
Parameters
params
:
EstimateContractExecutionFeeInput
Returns
Promise
<
{
callGasLimit
?:
string
;
high
:
|
undefined
|
{
baseFee
?:
string
;
gasLimit
:
undefined
|
`
${
number
}
`
|
""
;
gasPrice
?:
string
;
maxFee
:
undefined
|
`
${
number
}
`
|
""
;
networkFee
?:
string
;
priorityFee
:
undefined
|
`
${
number
}
`
|
""
;
}
;
low
:
|
undefined
|
{
baseFee
?:
string
;
gasLimit
:
undefined
|
`
${
number
}
`
|
""
;
gasPrice
?:
string
;
maxFee
:
undefined
|
`
${
number
}
`
|
""
;
networkFee
?:
string
;
priorityFee
:
undefined
|
`
${
number
}
`
|
""
;
}
;
medium
:
|
undefined
|
{
baseFee
?:
string
;
gasLimit
:
undefined
|
`
${
number
}
`
|
""
;
gasPrice
?:
string
;
maxFee
:
undefined
|
`
${
number
}
`
|
""
;
networkFee
?:
string
;
priorityFee
:
undefined
|
`
${
number
}
`
|
""
;
}
;
preVerificationGas
?:
string
;
verificationGasLimit
?:
string
;
}
,
>
circle_
estimate
Transfer
Fee
circle_estimateTransferFee
(
params
:
EstimateTransferFeeInput
,
)
:
Promise
<
{
callGasLimit
?:
string
;
high
:
|
undefined
|
{
baseFee
?:
string
;
gasLimit
:
undefined
|
`
${
number
}
`
|
""
;
gasPrice
?:
string
;
maxFee
:
undefined
|
`
${
number
}
`
|
""
;
networkFee
?:
string
;
priorityFee
:
undefined
|
`
${
number
}
`
|
""
;
}
;
low
:
|
undefined
|
{
baseFee
?:
string
;
gasLimit
:
undefined
|
`
${
number
}
`
|
""
;
gasPrice
?:
string
;
maxFee
:
undefined
|
`
${
number
}
`
|
""
;
networkFee
?:
string
;
priorityFee
:
undefined
|
`
${
number
}
`
|
""
;
}
;
medium
:
|
undefined
|
{
baseFee
?:
string
;
gasLimit
:
undefined
|
`
${
number
}
`
|
""
;
gasPrice
?:
string
;
maxFee
:
undefined
|
`
${
number
}
`
|
""
;
networkFee
?:
string
;
priorityFee
:
undefined
|
`
${
number
}
`
|
""
;
}
;
preVerificationGas
?:
string
;
verificationGasLimit
?:
string
;
}
,
>
Parameters
params
:
EstimateTransferFeeInput
Returns
Promise
<
{
callGasLimit
?:
string
;
high
:
|
undefined
|
{
baseFee
?:
string
;
gasLimit
:
undefined
|
`
${
number
}
`
|
""
;
gasPrice
?:
string
;
maxFee
:
undefined
|
`
${
number
}
`
|
""
;
networkFee
?:
string
;
priorityFee
:
undefined
|
`
${
number
}
`
|
""
;
}
;
low
:
|
undefined
|
{
baseFee
?:
string
;
gasLimit
:
undefined
|
`
${
number
}
`
|
""
;
gasPrice
?:
string
;
maxFee
:
undefined
|
`
${
number
}
`
|
""
;
networkFee
?:
string
;
priorityFee
:
undefined
|
`
${
number
}
`
|
""
;
}
;
medium
:
|
undefined
|
{
baseFee
?:
string
;
gasLimit
:
undefined
|
`
${
number
}
`
|
""
;
gasPrice
?:
string
;
maxFee
:
undefined
|
`
${
number
}
`
|
""
;
networkFee
?:
string
;
priorityFee
:
undefined
|
`
${
number
}
`
|
""
;
}
;
preVerificationGas
?:
string
;
verificationGasLimit
?:
string
;
}
,
>
circle_
get
Notification
Signature
circle_getNotificationSignature
(
params
:
GetNotificationSignatureInput
,
)
:
Promise
<
NotificationSignature
>
Parameters
params
:
GetNotificationSignatureInput
Returns
Promise
<
NotificationSignature
>
circle_
get
Transaction
circle_getTransaction
(
params
:
GetTransactionInput
)
:
Promise
<
Transaction
>
Parameters
params
:
GetTransactionInput
Returns
Promise
<
Transaction
>
circle_
get
Wallet
circle_getWallet
(
params
:
GetWalletInput
)
:
Promise
<
Wallet
>
Parameters
params
:
GetWalletInput
Returns
Promise
<
Wallet
>
circle_
get
Wallets
With
Balances
circle_getWalletsWithBalances
(
params
:
GetWalletsWithBalancesInput
,
)
:
Promise
<
Wallet
[]
>
Parameters
params
:
GetWalletsWithBalancesInput
Returns
Promise
<
Wallet
[]
>
circle_
get
Wallet
Token
Balance
circle_getWalletTokenBalance
(
params
:
GetWalletTokenBalanceInput
,
)
:
Promise
<
Balance
[]
>
Parameters
params
:
GetWalletTokenBalanceInput
Returns
Promise
<
Balance
[]
>
circle_
import
Contract
circle_importContract
(
params
:
ImportContractInput
)
:
Promise
<
Contract
>
Parameters
params
:
ImportContractInput
Returns
Promise
<
Contract
>
circle_
list
Transactions
circle_listTransactions
(
params
:
ListTransactionsInput
)
:
Promise
<
Transaction
[]
>
Parameters
params
:
ListTransactionsInput
Returns
Promise
<
Transaction
[]
>
circle_
list
Wallets
circle_listWallets
(
params
:
ListWalletsInput
)
:
Promise
<
Wallet
[]
>
Parameters
params
:
ListWalletsInput
Returns
Promise
<
Wallet
[]
>
circle_
request
Testnet
Tokens
circle_requestTestnetTokens
(
params
:
RequestTestnetTokensInput
)
:
Promise
<
void
>
Parameters
params
:
RequestTestnetTokensInput
Returns
Promise
<
void
>
circle_
sign
Transaction
circle_signTransaction
(
params
:
SignTransactionInput
)
:
Promise
<
SignedTransaction
>
Parameters
params
:
SignTransactionInput
Returns
Promise
<
SignedTransaction
>
circle_
sign
Typed
Data
circle_signTypedData
(
params
:
SignTypedDataInput
)
:
Promise
<
SignedTypedData
>
Parameters
params
:
SignTypedDataInput
Returns
Promise
<
SignedTypedData
>
request
request
(
__namedParameters
:
{
method
:
string
;
params
?:
unknown
[]
}
,
)
:
Promise
<
unknown
>
Parameters
__namedParameters
:
{
method
:
string
;
params
?:
unknown
[]
}
Returns
Promise
<
unknown
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
circle_
create
Contract
Execution
Transaction
circle_
create
Transaction
circle_
create
Wallets
circle_
create
Wallet
Set
circle_
derive
Wallet
circle_
estimate
Contract
Execution
Fee
circle_
estimate
Transfer
Fee
circle_
get
Notification
Signature
circle_
get
Transaction
circle_
get
Wallet
circle_
get
Wallets
With
Balances
circle_
get
Wallet
Token
Balance
circle_
import
Contract
circle_
list
Transactions
circle_
list
Wallets
circle_
request
Testnet
Tokens
circle_
sign
Transaction
circle_
sign
Typed
Data
request
@circle-fin/usdckit - v0.21.0
Loading...