Class CoreClient`Abstract`

Object methods

Hierarchy (View Summary)

BaseClient
- CoreClient

Implements

TransportMethods

Constructors

constructor

new CoreClient(options: CoreClientOptions): CoreClient
Parameters
- options: CoreClientOptions
Returns CoreClient
Overrides BaseClient.constructor
- Defined in packages/sui/src/client/core.ts:31

Properties

base

base: BaseClient

cache

cache: ClientCache

core

core: CoreClient = ...

mvr

mvr: MvrMethods

network

network: Network

Methods

$extend

$extend<const Registrations extends SuiClientRegistration<CoreClient>[]>(
    ...registrations: Registrations,
): ClientWithExtensions<
    {
        [K in string
        | number
        | symbol]: UnionToIntersection<
            {
                [K in string
                | number
                | symbol]: Registrations[K<K>] extends SuiClientRegistration<
                    CoreClient,
                    Name,
                    Extension,
                >
                    ? { [K2 in string]: Extension }
                    : never
            }[number],
        >[K]
    },
    CoreClient,
>
Type Parameters
- const Registrations extends SuiClientRegistration<CoreClient>[]
Parameters
- ...registrations: Registrations
Returns ClientWithExtensions<
    {
        [K in string
        | number
        | symbol]: UnionToIntersection<
            {
                [K in string
                | number
                | symbol]: Registrations[K<K>] extends SuiClientRegistration<
                    CoreClient,
                    Name,
                    Extension,
                >
                    ? { [K2 in string]: Extension }
                    : never
            }[number],
        >[K]
    },
    CoreClient,
>
Inherited from BaseClient.$extend
- Defined in packages/sui/src/client/client.ts:26

`Abstract`defaultNameServiceName

defaultNameServiceName(
options: DefaultNameServiceNameOptions,
): Promise<DefaultNameServiceNameResponse>
Parameters
- options: DefaultNameServiceNameOptions
Returns Promise<DefaultNameServiceNameResponse>
Implementation of TransportMethods.defaultNameServiceName
- Defined in packages/sui/src/client/core.ts:121

`Abstract`executeTransaction

executeTransaction<Include extends TransactionInclude = object>(
options: ExecuteTransactionOptions<Include>,
): Promise<SuiClientTypes.TransactionResult<Include>>
Type Parameters
- Include extends TransactionInclude = object
Parameters
- options: ExecuteTransactionOptions<Include>
Returns Promise<SuiClientTypes.TransactionResult<Include>>
Implementation of TransportMethods.executeTransaction
- Defined in packages/sui/src/client/core.ts:87

`Abstract`getBalance

getBalance(options: GetBalanceOptions): Promise<GetBalanceResponse>
Parameters
- options: GetBalanceOptions
Returns Promise<GetBalanceResponse>
Implementation of TransportMethods.getBalance
- Defined in packages/sui/src/client/core.ts:71

`Abstract`getChainIdentifier

getChainIdentifier(
options?: GetChainIdentifierOptions,
): Promise<GetChainIdentifierResponse>
Parameters
- Optionaloptions: GetChainIdentifierOptions
Returns Promise<GetChainIdentifierResponse>
Implementation of TransportMethods.getChainIdentifier
- Defined in packages/sui/src/client/core.ts:103

`Abstract`getCoinMetadata

getCoinMetadata(
options: GetCoinMetadataOptions,
): Promise<GetCoinMetadataResponse>
Parameters
- options: GetCoinMetadataOptions
Returns Promise<GetCoinMetadataResponse>
Implementation of TransportMethods.getCoinMetadata
- Defined in packages/sui/src/client/core.ts:79

`Abstract`getCurrentSystemState

getCurrentSystemState(
options?: GetCurrentSystemStateOptions,
): Promise<GetCurrentSystemStateResponse>
Parameters
- Optionaloptions: GetCurrentSystemStateOptions
Returns Promise<GetCurrentSystemStateResponse>
Implementation of TransportMethods.getCurrentSystemState
- Defined in packages/sui/src/client/core.ts:99

getDynamicField

getDynamicField(
options: GetDynamicFieldOptions,
): Promise<GetDynamicFieldResponse>
Parameters
- options: GetDynamicFieldOptions
Returns Promise<GetDynamicFieldResponse>
Implementation of TransportMethods.getDynamicField
- Defined in packages/sui/src/client/core.ts:125

getDynamicObjectField

getDynamicObjectField<Include extends ObjectInclude = object>(
options: GetDynamicObjectFieldOptions<Include>,
): Promise<GetDynamicObjectFieldResponse<Include>>
Type Parameters
- Include extends ObjectInclude = object
Parameters
- options: GetDynamicObjectFieldOptions<Include>
Returns Promise<GetDynamicObjectFieldResponse<Include>>
- Defined in packages/sui/src/client/core.ts:179

`Abstract`getMoveFunction

getMoveFunction(
options: GetMoveFunctionOptions,
): Promise<GetMoveFunctionResponse>
Parameters
- options: GetMoveFunctionOptions
Returns Promise<GetMoveFunctionResponse>
Implementation of TransportMethods.getMoveFunction
- Defined in packages/sui/src/client/core.ts:117

getObject

getObject<Include extends ObjectInclude = object>(
options: GetObjectOptions<Include>,
): Promise<GetObjectResponse<Include>>
Type Parameters
- Include extends ObjectInclude = object
Parameters
- options: GetObjectOptions<Include>
Returns Promise<GetObjectResponse<Include>>
- Defined in packages/sui/src/client/core.ts:46

`Abstract`getObjects

getObjects<Include extends ObjectInclude = object>(
options: GetObjectsOptions<Include>,
): Promise<GetObjectsResponse<Include>>
Type Parameters
- Include extends ObjectInclude = object
Parameters
- options: GetObjectsOptions<Include>
Returns Promise<GetObjectsResponse<Include>>
Implementation of TransportMethods.getObjects
- Defined in packages/sui/src/client/core.ts:42

`Abstract`getReferenceGasPrice

getReferenceGasPrice(
options?: GetReferenceGasPriceOptions,
): Promise<GetReferenceGasPriceResponse>
Parameters
- Optionaloptions: GetReferenceGasPriceOptions
Returns Promise<GetReferenceGasPriceResponse>
Implementation of TransportMethods.getReferenceGasPrice
- Defined in packages/sui/src/client/core.ts:95

`Abstract`getTransaction

getTransaction<Include extends TransactionInclude = object>(
options: GetTransactionOptions<Include>,
): Promise<SuiClientTypes.TransactionResult<Include>>
Type Parameters
- Include extends TransactionInclude = object
Parameters
- options: GetTransactionOptions<Include>
Returns Promise<SuiClientTypes.TransactionResult<Include>>
Implementation of TransportMethods.getTransaction
- Defined in packages/sui/src/client/core.ts:83

`Abstract`listBalances

listBalances(options: ListBalancesOptions): Promise<ListBalancesResponse>
Parameters
- options: ListBalancesOptions
Returns Promise<ListBalancesResponse>
Implementation of TransportMethods.listBalances
- Defined in packages/sui/src/client/core.ts:75

`Abstract`listCoins

listCoins(options: ListCoinsOptions): Promise<ListCoinsResponse>
Parameters
- options: ListCoinsOptions
Returns Promise<ListCoinsResponse>
Implementation of TransportMethods.listCoins
- Defined in packages/sui/src/client/core.ts:63

`Abstract`listDynamicFields

listDynamicFields(
options: ListDynamicFieldsOptions,
): Promise<ListDynamicFieldsResponse>
Parameters
- options: ListDynamicFieldsOptions
Returns Promise<ListDynamicFieldsResponse>
Implementation of TransportMethods.listDynamicFields
- Defined in packages/sui/src/client/core.ts:107

`Abstract`listOwnedObjects

listOwnedObjects<Include extends ObjectInclude = object>(
options: ListOwnedObjectsOptions<Include>,
): Promise<ListOwnedObjectsResponse<Include>>
Type Parameters
- Include extends ObjectInclude = object
Parameters
- options: ListOwnedObjectsOptions<Include>
Returns Promise<ListOwnedObjectsResponse<Include>>
Implementation of TransportMethods.listOwnedObjects
- Defined in packages/sui/src/client/core.ts:67

`Abstract`resolveTransactionPlugin

resolveTransactionPlugin(): TransactionPlugin
Returns TransactionPlugin
Implementation of TransportMethods.resolveTransactionPlugin
- Defined in packages/sui/src/client/core.ts:111

signAndExecuteTransaction

signAndExecuteTransaction<Include extends TransactionInclude = {}>(
__namedParameters: SignAndExecuteTransactionOptions<Include>,
): Promise<SuiClientTypes.TransactionResult<Include>>
Type Parameters
- Include extends TransactionInclude = {}
Parameters
- __namedParameters: SignAndExecuteTransactionOptions<Include>
Returns Promise<SuiClientTypes.TransactionResult<Include>>
- Defined in packages/sui/src/client/core.ts:243

`Abstract`simulateTransaction

simulateTransaction<Include extends SimulateTransactionInclude = object>(
options: SimulateTransactionOptions<Include>,
): Promise<SimulateTransactionResult<Include>>
Type Parameters
- Include extends SimulateTransactionInclude = object
Parameters
- options: SimulateTransactionOptions<Include>
Returns Promise<SimulateTransactionResult<Include>>
Implementation of TransportMethods.simulateTransaction
- Defined in packages/sui/src/client/core.ts:91

`Abstract`verifyZkLoginSignature

verifyZkLoginSignature(
options: VerifyZkLoginSignatureOptions,
): Promise<ZkLoginVerifyResponse>
Parameters
- options: VerifyZkLoginSignatureOptions
Returns Promise<ZkLoginVerifyResponse>
Implementation of TransportMethods.verifyZkLoginSignature
- Defined in packages/sui/src/client/core.ts:113

waitForTransaction

waitForTransaction<Include extends TransactionInclude = object>(
options: WaitForTransactionOptions<Include>,
): Promise<SuiClientTypes.TransactionResult<Include>>
Type Parameters
- Include extends TransactionInclude = object
Parameters
- options: WaitForTransactionOptions<Include>
Returns Promise<SuiClientTypes.TransactionResult<Include>>
- Defined in packages/sui/src/client/core.ts:207

Class CoreClientAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CoreClient

Properties

base

cache

core

mvr

network

Methods

$extend

Type Parameters

Parameters

Returns ClientWithExtensions< { [K in string | number | symbol]: UnionToIntersection< { [K in string | number | symbol]: Registrations[K<K>] extends SuiClientRegistration< CoreClient, Name, Extension, > ? { [K2 in string]: Extension } : never }[number], >[K] }, CoreClient,>

AbstractdefaultNameServiceName

Parameters

Returns Promise<DefaultNameServiceNameResponse>

AbstractexecuteTransaction

Type Parameters

Parameters

Returns Promise<SuiClientTypes.TransactionResult<Include>>

AbstractgetBalance

Parameters

Returns Promise<GetBalanceResponse>

AbstractgetChainIdentifier

Parameters

Returns Promise<GetChainIdentifierResponse>

AbstractgetCoinMetadata

Parameters

Returns Promise<GetCoinMetadataResponse>

AbstractgetCurrentSystemState

Parameters

Returns Promise<GetCurrentSystemStateResponse>

getDynamicField

Parameters

Returns Promise<GetDynamicFieldResponse>

getDynamicObjectField

Type Parameters

Parameters

Returns Promise<GetDynamicObjectFieldResponse<Include>>

AbstractgetMoveFunction

Parameters

Returns Promise<GetMoveFunctionResponse>

getObject

Type Parameters

Parameters

Returns Promise<GetObjectResponse<Include>>

AbstractgetObjects

Type Parameters

Parameters

Returns Promise<GetObjectsResponse<Include>>

AbstractgetReferenceGasPrice

Parameters

Returns Promise<GetReferenceGasPriceResponse>

AbstractgetTransaction

Type Parameters

Parameters

Returns Promise<SuiClientTypes.TransactionResult<Include>>

AbstractlistBalances

Parameters

Returns Promise<ListBalancesResponse>

AbstractlistCoins

Parameters

Returns Promise<ListCoinsResponse>

AbstractlistDynamicFields

Parameters

Returns Promise<ListDynamicFieldsResponse>

AbstractlistOwnedObjects

Type Parameters

Parameters

Returns Promise<ListOwnedObjectsResponse<Include>>

AbstractresolveTransactionPlugin

Class CoreClient`Abstract`

Returns ClientWithExtensions<
{
[K in string
| number
| symbol]: UnionToIntersection<
{
[K in string
| number
| symbol]: Registrations[K<K>] extends SuiClientRegistration<
CoreClient,
Name,
Extension,
>
? { [K2 in string]: Extension }
: never
}[number],
>[K]
},
CoreClient,
>

`Abstract`defaultNameServiceName

`Abstract`executeTransaction

`Abstract`getBalance

`Abstract`getChainIdentifier

`Abstract`getCoinMetadata

`Abstract`getCurrentSystemState

`Abstract`getMoveFunction

`Abstract`getObjects

`Abstract`getReferenceGasPrice

`Abstract`getTransaction

`Abstract`listBalances

`Abstract`listCoins

`Abstract`listDynamicFields

`Abstract`listOwnedObjects

`Abstract`resolveTransactionPlugin

`Abstract`simulateTransaction

`Abstract`verifyZkLoginSignature