Skip to main content

IotaClientGraphQLTransportOptions

@iota/graphql-transport


@iota/graphql-transport / IotaClientGraphQLTransportOptions

Interface: IotaClientGraphQLTransportOptions

Defined in: sdk/graphql-transport/src/transport.ts:40

Properties​

fallbackMethods?​

optional fallbackMethods?: ("getRpcApiVersion" | "getCoins" | "getAllCoins" | "getBalance" | "getAllBalances" | "getCoinMetadata" | "getTotalSupply" | "getCirculatingSupply" | "call" | "getMoveFunctionArgTypes" | "getNormalizedMoveModulesByPackage" | "getNormalizedMoveModule" | "getNormalizedMoveFunction" | "getNormalizedMoveStruct" | "getOwnedObjects" | "getObject" | "tryGetPastObject" | "multiGetObjects" | "queryTransactionBlocks" | "getTransactionBlock" | "multiGetTransactionBlocks" | "executeTransactionBlock" | "signAndExecuteTransaction" | "getTotalTransactionBlocks" | "getReferenceGasPrice" | "getStakes" | "getTimelockedStakes" | "getStakesByIds" | "getTimelockedStakesByIds" | "getLatestIotaSystemStateV1" | "getLatestIotaSystemStateV2" | "getLatestIotaSystemState" | "queryEvents" | "subscribeEvent" | "subscribeTransaction" | "devInspectTransactionBlock" | "dryRunTransactionBlock" | "getDynamicFields" | "getDynamicFieldObject" | "getDynamicFieldObjectV1" | "getDynamicFieldObjectV2" | "getLatestCheckpointSequenceNumber" | "getCheckpoint" | "getCheckpoints" | "getCommitteeInfo" | "getNetworkMetrics" | "getAddressMetrics" | "getEpochMetrics" | "getAllEpochAddressMetrics" | "getCheckpointAddressMetrics" | "getEpochs" | "getMoveCallMetrics" | "getCurrentEpoch" | "getTotalTransactions" | "getValidatorsApy" | "getChainIdentifier" | "getProtocolConfig" | "getParticipationMetrics" | "waitForTransaction" | "iotaNamesLookup" | "iotaNamesReverseLookup" | "iotaNamesFindAllRegistrationNFTs" | "isTransactionIndexedOnNode" | "view")[]

Defined in: sdk/graphql-transport/src/transport.ts:46


fallbackTransportUrl?​

optional fallbackTransportUrl?: string

Defined in: sdk/graphql-transport/src/transport.ts:45


inspector?​

optional inspector?: RequestInspector

Defined in: sdk/graphql-transport/src/transport.ts:49

Optional inspector function for monitoring and tracing requests


unsupportedMethods?​

optional unsupportedMethods?: ("getRpcApiVersion" | "getCoins" | "getAllCoins" | "getBalance" | "getAllBalances" | "getCoinMetadata" | "getTotalSupply" | "getCirculatingSupply" | "call" | "getMoveFunctionArgTypes" | "getNormalizedMoveModulesByPackage" | "getNormalizedMoveModule" | "getNormalizedMoveFunction" | "getNormalizedMoveStruct" | "getOwnedObjects" | "getObject" | "tryGetPastObject" | "multiGetObjects" | "queryTransactionBlocks" | "getTransactionBlock" | "multiGetTransactionBlocks" | "executeTransactionBlock" | "signAndExecuteTransaction" | "getTotalTransactionBlocks" | "getReferenceGasPrice" | "getStakes" | "getTimelockedStakes" | "getStakesByIds" | "getTimelockedStakesByIds" | "getLatestIotaSystemStateV1" | "getLatestIotaSystemStateV2" | "getLatestIotaSystemState" | "queryEvents" | "subscribeEvent" | "subscribeTransaction" | "devInspectTransactionBlock" | "dryRunTransactionBlock" | "getDynamicFields" | "getDynamicFieldObject" | "getDynamicFieldObjectV1" | "getDynamicFieldObjectV2" | "getLatestCheckpointSequenceNumber" | "getCheckpoint" | "getCheckpoints" | "getCommitteeInfo" | "getNetworkMetrics" | "getAddressMetrics" | "getEpochMetrics" | "getAllEpochAddressMetrics" | "getCheckpointAddressMetrics" | "getEpochs" | "getMoveCallMetrics" | "getCurrentEpoch" | "getTotalTransactions" | "getValidatorsApy" | "getChainIdentifier" | "getProtocolConfig" | "getParticipationMetrics" | "waitForTransaction" | "iotaNamesLookup" | "iotaNamesReverseLookup" | "iotaNamesFindAllRegistrationNFTs" | "isTransactionIndexedOnNode" | "view")[]

Defined in: sdk/graphql-transport/src/transport.ts:47


url​

url: string

Defined in: sdk/graphql-transport/src/transport.ts:41


WebSocketConstructor?​

optional WebSocketConstructor?: {(url, protocols?): WebSocket; CLOSED: 3; CLOSING: 2; CONNECTING: 0; OPEN: 1; prototype: WebSocket; }

Defined in: sdk/graphql-transport/src/transport.ts:44

Parameters​

url​

string | URL

protocols?​

string | string[]

Returns​

WebSocket

CLOSED​

readonly CLOSED: 3

CLOSING​

readonly CLOSING: 2

CONNECTING​

readonly CONNECTING: 0

OPEN​

readonly OPEN: 1

prototype​

prototype: WebSocket


wsOptions?​

optional wsOptions?: Omit<GraphQLWebSocketClientOptions, "WebSocketConstructor">

Defined in: sdk/graphql-transport/src/transport.ts:43


wsUrl?​

optional wsUrl?: string

Defined in: sdk/graphql-transport/src/transport.ts:42