Documentation
Preparing search index...
@mysten/sui
graphql
SuiGraphQLClient
Class SuiGraphQLClient<Queries>
Object methods
Type Parameters
Queries
extends
Record
<
string
,
GraphQLDocument
>
=
{}
Hierarchy (
View Summary
)
BaseClient
SuiGraphQLClient
Implements
TransportMethods
Indexable
[
key
:
number
]:
boolean
Index
Constructors
constructor
Properties
base
cache
core
network
Accessors
mvr
Methods
$extend
default
Name
Service
Name
execute
execute
Transaction
get
Balance
get
Dynamic
Field
get
Move
Function
get
Object
get
Objects
get
Reference
Gas
Price
get
Transaction
list
Balances
list
Coins
list
Dynamic
Fields
list
Owned
Objects
query
resolve
Transaction
Plugin
sign
And
Execute
Transaction
simulate
Transaction
verify
Zk
Login
Signature
wait
For
Transaction
Constructors
constructor
new
SuiGraphQLClient
<
Queries
extends
Record
<
string
,
GraphQLDocument
<
Record
<
string
,
unknown
>
,
Record
<
string
,
unknown
>
>
,
>
=
{}
,
>
(
__namedParameters
:
SuiGraphQLClientOptions
<
Queries
>
,
)
:
SuiGraphQLClient
<
Queries
>
Type Parameters
Queries
extends
Record
<
string
,
GraphQLDocument
<
Record
<
string
,
unknown
>
,
Record
<
string
,
unknown
>
>
,
>
=
{}
Parameters
__namedParameters
:
SuiGraphQLClientOptions
<
Queries
>
Returns
SuiGraphQLClient
<
Queries
>
Properties
base
base
:
BaseClient
cache
cache
:
ClientCache
core
core
:
GraphQLCoreClient
network
network
:
Network
Accessors
mvr
get
mvr
()
:
MvrMethods
Returns
MvrMethods
Methods
$extend
$extend
<
const
Registrations
extends
SuiClientRegistration
<
SuiGraphQLClient
<
Queries
>
>
[]
,
>
(
...
registrations
:
Registrations
,
)
:
ClientWithExtensions
<
{
[
K
in
string
|
number
|
symbol
]
:
UnionToIntersection
<
{
[
K
in
string
|
number
|
symbol
]
:
Registrations
[
K
<
K
>
]
extends
SuiClientRegistration
<
SuiGraphQLClient
<
Queries
>
,
Name
,
Extension
,
>
?
{
[
K2
in
string
]
:
Extension
}
:
never
}
[
number
]
,
>
[
K
]
}
,
SuiGraphQLClient
<
Queries
>
,
>
Type Parameters
const
Registrations
extends
SuiClientRegistration
<
SuiGraphQLClient
<
Queries
>
>
[]
Parameters
...
registrations
:
Registrations
Returns
ClientWithExtensions
<
{
[
K
in
string
|
number
|
symbol
]
:
UnionToIntersection
<
{
[
K
in
string
|
number
|
symbol
]
:
Registrations
[
K
<
K
>
]
extends
SuiClientRegistration
<
SuiGraphQLClient
<
Queries
>
,
Name
,
Extension
,
>
?
{
[
K2
in
string
]
:
Extension
}
:
never
}
[
number
]
,
>
[
K
]
}
,
SuiGraphQLClient
<
Queries
>
,
>
default
Name
Service
Name
defaultNameServiceName
(
input
:
DefaultNameServiceNameOptions
,
)
:
Promise
<
DefaultNameServiceNameResponse
>
Parameters
input
:
DefaultNameServiceNameOptions
Returns
Promise
<
DefaultNameServiceNameResponse
>
execute
execute
<
const
Query
extends
string
,
Result
=
Queries
[
Query
]
extends
GraphQLDocument
<
R
,
unknown
>
?
R
:
Record
<
string
,
unknown
>
,
Variables
=
Queries
[
Query
]
extends
GraphQLDocument
<
unknown
,
V
>
?
V
:
Record
<
string
,
unknown
>
,
>
(
query
:
Query
,
options
:
Omit
<
GraphQLQueryOptions
<
Result
,
Variables
>
,
"query"
>
,
)
:
Promise
<
GraphQLQueryResult
<
Result
>
>
Type Parameters
const
Query
extends
string
Result
=
Queries
[
Query
]
extends
GraphQLDocument
<
R
,
unknown
>
?
R
:
Record
<
string
,
unknown
>
Variables
=
Queries
[
Query
]
extends
GraphQLDocument
<
unknown
,
V
>
?
V
:
Record
<
string
,
unknown
>
Parameters
query
:
Query
options
:
Omit
<
GraphQLQueryOptions
<
Result
,
Variables
>
,
"query"
>
Returns
Promise
<
GraphQLQueryResult
<
Result
>
>
execute
Transaction
executeTransaction
<
Include
extends
TransactionInclude
=
{}
>
(
input
:
ExecuteTransactionOptions
<
Include
>
,
)
:
Promise
<
SuiClientTypes
.
TransactionResult
<
Include
>
>
Type Parameters
Include
extends
TransactionInclude
=
{}
Parameters
input
:
ExecuteTransactionOptions
<
Include
>
Returns
Promise
<
SuiClientTypes
.
TransactionResult
<
Include
>
>
get
Balance
getBalance
(
input
:
GetBalanceOptions
)
:
Promise
<
GetBalanceResponse
>
Parameters
input
:
GetBalanceOptions
Returns
Promise
<
GetBalanceResponse
>
get
Dynamic
Field
getDynamicField
(
input
:
GetDynamicFieldOptions
)
:
Promise
<
GetDynamicFieldResponse
>
Parameters
input
:
GetDynamicFieldOptions
Returns
Promise
<
GetDynamicFieldResponse
>
get
Move
Function
getMoveFunction
(
input
:
GetMoveFunctionOptions
)
:
Promise
<
GetMoveFunctionResponse
>
Parameters
input
:
GetMoveFunctionOptions
Returns
Promise
<
GetMoveFunctionResponse
>
get
Object
getObject
<
Include
extends
ObjectInclude
=
{}
>
(
input
:
GetObjectOptions
<
Include
>
,
)
:
Promise
<
GetObjectResponse
<
Include
>
>
Type Parameters
Include
extends
ObjectInclude
=
{}
Parameters
input
:
GetObjectOptions
<
Include
>
Returns
Promise
<
GetObjectResponse
<
Include
>
>
get
Objects
getObjects
<
Include
extends
ObjectInclude
=
{}
>
(
input
:
GetObjectsOptions
<
Include
>
,
)
:
Promise
<
GetObjectsResponse
<
Include
>
>
Type Parameters
Include
extends
ObjectInclude
=
{}
Parameters
input
:
GetObjectsOptions
<
Include
>
Returns
Promise
<
GetObjectsResponse
<
Include
>
>
get
Reference
Gas
Price
getReferenceGasPrice
()
:
Promise
<
GetReferenceGasPriceResponse
>
Returns
Promise
<
GetReferenceGasPriceResponse
>
get
Transaction
getTransaction
<
Include
extends
TransactionInclude
=
{}
>
(
input
:
GetTransactionOptions
<
Include
>
,
)
:
Promise
<
SuiClientTypes
.
TransactionResult
<
Include
>
>
Type Parameters
Include
extends
TransactionInclude
=
{}
Parameters
input
:
GetTransactionOptions
<
Include
>
Returns
Promise
<
SuiClientTypes
.
TransactionResult
<
Include
>
>
list
Balances
listBalances
(
input
:
ListBalancesOptions
)
:
Promise
<
ListBalancesResponse
>
Parameters
input
:
ListBalancesOptions
Returns
Promise
<
ListBalancesResponse
>
list
Coins
listCoins
(
input
:
ListCoinsOptions
)
:
Promise
<
ListCoinsResponse
>
Parameters
input
:
ListCoinsOptions
Returns
Promise
<
ListCoinsResponse
>
list
Dynamic
Fields
listDynamicFields
(
input
:
ListDynamicFieldsOptions
,
)
:
Promise
<
ListDynamicFieldsResponse
>
Parameters
input
:
ListDynamicFieldsOptions
Returns
Promise
<
ListDynamicFieldsResponse
>
list
Owned
Objects
listOwnedObjects
<
Include
extends
ObjectInclude
=
{}
>
(
input
:
ListOwnedObjectsOptions
<
Include
>
,
)
:
Promise
<
ListOwnedObjectsResponse
<
Include
>
>
Type Parameters
Include
extends
ObjectInclude
=
{}
Parameters
input
:
ListOwnedObjectsOptions
<
Include
>
Returns
Promise
<
ListOwnedObjectsResponse
<
Include
>
>
query
query
<
Result
=
Record
<
string
,
unknown
>
,
Variables
=
Record
<
string
,
unknown
>
>
(
options
:
GraphQLQueryOptions
<
Result
,
Variables
>
,
)
:
Promise
<
GraphQLQueryResult
<
Result
>
>
Type Parameters
Result
=
Record
<
string
,
unknown
>
Variables
=
Record
<
string
,
unknown
>
Parameters
options
:
GraphQLQueryOptions
<
Result
,
Variables
>
Returns
Promise
<
GraphQLQueryResult
<
Result
>
>
resolve
Transaction
Plugin
resolveTransactionPlugin
()
:
TransactionPlugin
Returns
TransactionPlugin
sign
And
Execute
Transaction
signAndExecuteTransaction
<
Include
extends
TransactionInclude
=
{}
>
(
input
:
SignAndExecuteTransactionOptions
<
Include
>
,
)
:
Promise
<
SuiClientTypes
.
TransactionResult
<
Include
>
>
Type Parameters
Include
extends
TransactionInclude
=
{}
Parameters
input
:
SignAndExecuteTransactionOptions
<
Include
>
Returns
Promise
<
SuiClientTypes
.
TransactionResult
<
Include
>
>
simulate
Transaction
simulateTransaction
<
Include
extends
SimulateTransactionInclude
=
{}
>
(
input
:
SimulateTransactionOptions
<
Include
>
,
)
:
Promise
<
SimulateTransactionResult
<
Include
>
>
Type Parameters
Include
extends
SimulateTransactionInclude
=
{}
Parameters
input
:
SimulateTransactionOptions
<
Include
>
Returns
Promise
<
SimulateTransactionResult
<
Include
>
>
verify
Zk
Login
Signature
verifyZkLoginSignature
(
input
:
VerifyZkLoginSignatureOptions
,
)
:
Promise
<
ZkLoginVerifyResponse
>
Parameters
input
:
VerifyZkLoginSignatureOptions
Returns
Promise
<
ZkLoginVerifyResponse
>
wait
For
Transaction
waitForTransaction
<
Include
extends
TransactionInclude
=
{}
>
(
input
:
WaitForTransactionOptions
<
Include
>
,
)
:
Promise
<
SuiClientTypes
.
TransactionResult
<
Include
>
>
Type Parameters
Include
extends
TransactionInclude
=
{}
Parameters
input
:
WaitForTransactionOptions
<
Include
>
Returns
Promise
<
SuiClientTypes
.
TransactionResult
<
Include
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
base
cache
core
network
Accessors
mvr
Methods
$extend
default
Name
Service
Name
execute
execute
Transaction
get
Balance
get
Dynamic
Field
get
Move
Function
get
Object
get
Objects
get
Reference
Gas
Price
get
Transaction
list
Balances
list
Coins
list
Dynamic
Fields
list
Owned
Objects
query
resolve
Transaction
Plugin
sign
And
Execute
Transaction
simulate
Transaction
verify
Zk
Login
Signature
wait
For
Transaction
Documentation
Loading...
Object methods