Documentation
Preparing search index...
@mysten/sui
client
SuiClientTypes
TransportMethods
Interface TransportMethods
Object methods
interface
TransportMethods
{
defaultNameServiceName
:
(
options
:
DefaultNameServiceNameOptions
,
)
=>
Promise
<
DefaultNameServiceNameResponse
>
;
executeTransaction
:
<
Include
extends
TransactionInclude
=
{}
>
(
options
:
ExecuteTransactionOptions
<
Include
>
,
)
=>
Promise
<
SuiClientTypes
.
TransactionResult
<
Include
>
>
;
getBalance
:
(
options
:
GetBalanceOptions
)
=>
Promise
<
GetBalanceResponse
>
;
getChainIdentifier
?:
(
options
?:
GetChainIdentifierOptions
,
)
=>
Promise
<
GetChainIdentifierResponse
>
;
getCurrentSystemState
?:
(
options
?:
GetCurrentSystemStateOptions
,
)
=>
Promise
<
GetCurrentSystemStateResponse
>
;
getDynamicField
:
(
options
:
GetDynamicFieldOptions
,
)
=>
Promise
<
GetDynamicFieldResponse
>
;
getMoveFunction
:
(
options
:
GetMoveFunctionOptions
,
)
=>
Promise
<
GetMoveFunctionResponse
>
;
getObjects
:
<
Include
extends
ObjectInclude
=
{}
>
(
options
:
GetObjectsOptions
<
Include
>
,
)
=>
Promise
<
GetObjectsResponse
<
Include
>
>
;
getReferenceGasPrice
?:
(
options
?:
GetReferenceGasPriceOptions
,
)
=>
Promise
<
GetReferenceGasPriceResponse
>
;
getTransaction
:
<
Include
extends
TransactionInclude
=
{}
>
(
options
:
GetTransactionOptions
<
Include
>
,
)
=>
Promise
<
SuiClientTypes
.
TransactionResult
<
Include
>
>
;
listBalances
:
(
options
:
ListBalancesOptions
,
)
=>
Promise
<
ListBalancesResponse
>
;
listCoins
:
(
options
:
ListCoinsOptions
)
=>
Promise
<
ListCoinsResponse
>
;
listDynamicFields
:
(
options
:
ListDynamicFieldsOptions
,
)
=>
Promise
<
ListDynamicFieldsResponse
>
;
listOwnedObjects
:
<
Include
extends
ObjectInclude
=
{}
>
(
options
:
ListOwnedObjectsOptions
<
Include
>
,
)
=>
Promise
<
ListOwnedObjectsResponse
<
Include
>
>
;
mvr
:
MvrMethods
;
resolveTransactionPlugin
:
()
=>
TransactionPlugin
;
simulateTransaction
:
<
Include
extends
SimulateTransactionInclude
=
{}
>
(
options
:
SimulateTransactionOptions
<
Include
>
,
)
=>
Promise
<
SimulateTransactionResult
<
Include
>
>
;
verifyZkLoginSignature
:
(
options
:
VerifyZkLoginSignatureOptions
,
)
=>
Promise
<
ZkLoginVerifyResponse
>
;
}
Implemented by
CoreClient
SuiGraphQLClient
Index
Properties
default
Name
Service
Name
execute
Transaction
get
Balance
get
Chain
Identifier?
get
Current
System
State?
get
Dynamic
Field
get
Move
Function
get
Objects
get
Reference
Gas
Price?
get
Transaction
list
Balances
list
Coins
list
Dynamic
Fields
list
Owned
Objects
mvr
resolve
Transaction
Plugin
simulate
Transaction
verify
Zk
Login
Signature
Properties
default
Name
Service
Name
defaultNameServiceName
:
(
options
:
DefaultNameServiceNameOptions
,
)
=>
Promise
<
DefaultNameServiceNameResponse
>
execute
Transaction
executeTransaction
:
<
Include
extends
TransactionInclude
=
{}
>
(
options
:
ExecuteTransactionOptions
<
Include
>
,
)
=>
Promise
<
SuiClientTypes
.
TransactionResult
<
Include
>
>
get
Balance
getBalance
:
(
options
:
GetBalanceOptions
)
=>
Promise
<
GetBalanceResponse
>
Optional
get
Chain
Identifier
getChainIdentifier
?:
(
options
?:
GetChainIdentifierOptions
,
)
=>
Promise
<
GetChainIdentifierResponse
>
Optional
get
Current
System
State
getCurrentSystemState
?:
(
options
?:
GetCurrentSystemStateOptions
,
)
=>
Promise
<
GetCurrentSystemStateResponse
>
get
Dynamic
Field
getDynamicField
:
(
options
:
GetDynamicFieldOptions
,
)
=>
Promise
<
GetDynamicFieldResponse
>
get
Move
Function
getMoveFunction
:
(
options
:
GetMoveFunctionOptions
,
)
=>
Promise
<
GetMoveFunctionResponse
>
get
Objects
getObjects
:
<
Include
extends
ObjectInclude
=
{}
>
(
options
:
GetObjectsOptions
<
Include
>
,
)
=>
Promise
<
GetObjectsResponse
<
Include
>
>
Optional
get
Reference
Gas
Price
getReferenceGasPrice
?:
(
options
?:
GetReferenceGasPriceOptions
,
)
=>
Promise
<
GetReferenceGasPriceResponse
>
get
Transaction
getTransaction
:
<
Include
extends
TransactionInclude
=
{}
>
(
options
:
GetTransactionOptions
<
Include
>
,
)
=>
Promise
<
SuiClientTypes
.
TransactionResult
<
Include
>
>
list
Balances
listBalances
:
(
options
:
ListBalancesOptions
)
=>
Promise
<
ListBalancesResponse
>
list
Coins
listCoins
:
(
options
:
ListCoinsOptions
)
=>
Promise
<
ListCoinsResponse
>
list
Dynamic
Fields
listDynamicFields
:
(
options
:
ListDynamicFieldsOptions
,
)
=>
Promise
<
ListDynamicFieldsResponse
>
list
Owned
Objects
listOwnedObjects
:
<
Include
extends
ObjectInclude
=
{}
>
(
options
:
ListOwnedObjectsOptions
<
Include
>
,
)
=>
Promise
<
ListOwnedObjectsResponse
<
Include
>
>
mvr
mvr
:
MvrMethods
resolve
Transaction
Plugin
resolveTransactionPlugin
:
()
=>
TransactionPlugin
simulate
Transaction
simulateTransaction
:
<
Include
extends
SimulateTransactionInclude
=
{}
>
(
options
:
SimulateTransactionOptions
<
Include
>
,
)
=>
Promise
<
SimulateTransactionResult
<
Include
>
>
verify
Zk
Login
Signature
verifyZkLoginSignature
:
(
options
:
VerifyZkLoginSignatureOptions
,
)
=>
Promise
<
ZkLoginVerifyResponse
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
default
Name
Service
Name
execute
Transaction
get
Balance
get
Chain
Identifier
get
Current
System
State
get
Dynamic
Field
get
Move
Function
get
Objects
get
Reference
Gas
Price
get
Transaction
list
Balances
list
Coins
list
Dynamic
Fields
list
Owned
Objects
mvr
resolve
Transaction
Plugin
simulate
Transaction
verify
Zk
Login
Signature
Documentation
Loading...
Object methods