Skip to main content
This page is generated from the @gol/sdk type declarations by pnpm sdk:reference. It reads the built dist/index.d.ts and dist/server.d.ts of the sdk repository. Do not edit it directly. This version matches current availability and the published package.

How to read this page

Signatures are the declarations the package exports, not a rewritten summary. Address, Hex, and PublicClient are viem types that the package does not re-export, so install viem alongside the SDK. A client parameter is narrowed to the read methods the SDK calls, which a viem PublicClient satisfies.
  • Classes list the constructor options and every method a caller can use, including inherited methods.
  • Functions are module-level helpers.
  • Values are exported constants.
  • Types are interfaces and aliases. Ones generated from the platform contract are listed with the API operation that defines their shape.

@gol/sdk

Browser-safe policy encoding, owner wallet payloads, owner operations, and verification. Safe to import from a web page, a mobile bundle, or a server.

Classes

ApprovalSessionClient

Capability-only public transport. API keys are deliberately not accepted.

GolApiError

Extends GolError.

GolError

Extends Error.

GolTransportError

Extends Error.

GolYieldSafeQuoteError

Extends GolError.

Functions

Values

API request and response types

These aliases are generated from the platform OpenAPI contract, so their shape is exactly the one in the API reference. Operation is the OpenAPI operationId that defines the type.

Types

AccountFamily

AccountProfileCandidate

AccountProfileInstallation

AccountProfileLane

AccountProfileOwnerDialect

AccountProfileReader

AccountProfileStatus

AccountReader

AgentSigner

ApiKeyScope

ApprovalLaunch

ApprovalResult

CallbackOwnerSigner

CallbackOwnerSignerOptions

CombinedGasApproval

CompatibilityResult

DeveloperRelayerTransaction

Eip7702AuthorizationSigner

GasActionAuthorizationMessage

GasExecutionSummary

GasMandateTerms

GasPolicyInput

GolAccount

GolAccountClient

GolAccountClientOptions

GolAccountCreateInput

GolAccountDeployIntent

GolAccountImportTokenInput

GolAccountRequestOptions

GolAccountRules

GolAccountView

GolActivityEvent

GolActivityPage

GolActivityQuery

GolAddDeviceInput

GolAgentAuthClient

GolAgentPairingProof

GolAgentPairingStatus

GolAgentPairInput

GolAgentRecord

GolAgentRequest

GolAgentRequestCall

GolAgentRequestEvent

GolAgentRequestsClient

GolAgentRequestsClientOptions

GolAgentsClientOptions

GolAgentSession

GolAgentSessionInput

GolAgentsRequestOptions

GolAgUiAnswerValue

GolAgUiBaseEvent

GolAgUiCardsValue

GolAgUiClarifyValue

GolAgUiContentPart

GolAgUiContext

GolAgUiCustomEvent

GolAgUiEvent

GolAgUiMessage

GolAgUiMessageContent

GolAgUiMetadata

GolAgUiNoticeValue

GolAgUiRunAgentInput

GolAgUiRunErrorEvent

GolAgUiRunFinishedEvent

GolAgUiRunStartedEvent

GolAgUiStateSnapshotEvent

GolAgUiStepFinishedEvent

GolAgUiStepStartedEvent

GolAgUiTextMessageContentEvent

GolAgUiTextMessageEndEvent

GolAgUiTextMessageStartEvent

GolAgUiThinkingEndEvent

GolAgUiThinkingStartEvent

GolAgUiThinkingTextMessageContentEvent

GolAgUiTool

GolAgUiToolCallArgsEvent

GolAgUiToolCallEndEvent

GolAgUiToolCallResultEvent

GolAgUiToolCallStartEvent

GolApiOwnerClient

GolApiOwnerClientOptions

GolApiQuery

GolApiSelection

GolBalanceHistoryQuery

GolBalanceQuery

GolBaseChainRef

GolBrowserSession

GolBrowserSessionClient

GolBrowserSessionOptions

GolBrowserSessionRequestOptions

GolChainId

GolChainsClient

GolChainsClientOptions

GolClient

GolClientOptions

GolCreateMandate

GolDelegation

GolDevice

GolDeviceBuild

GolDeviceLoginClient

GolDeviceLoginClientOptions

GolDeviceLoginConsent

GolDeviceLoginPoll

GolDeviceLoginRequestOptions

GolDeviceLoginStart

GolDevicesClient

GolDevicesClientOptions

GolDeviceSet

GolDeviceThresholdInput

GolDeviceUserOp

GolEnabledChain

GolEnvironment

GolExpectedGrantAccount

GolExpectedOperationAccount

GolFaucetClient

GolFaucetRequest

GolFaucetState

GolFaucetView

GolGrantBuild

GolGrantIntent

GolGrantOperationBuild

GolGrantReceipt

GolHomeClient

GolHomeClientOptions

GolHostedAgentClient

GolImportedToken

GolMandate

GolMandateBounds

GolMandateCapability

GolMandatesOptions

GolMandatesRequestOptions

GolMandateVersion

GolMoneyBuild

GolMoneyClient

GolMoneyClientOptions

GolMoneyGasMethod

GolMoneyRequestOptions

GolMoneyRouteStep

GolMoneySendIntent

GolMoneySwapIntent

GolMoneySwapQuote

GolMoneySwapStatus

GolMoneySwapToken

GolMoneyTokenRef

GolMoneyTransfer

GolMoneyUnsignedUserOp

GolOnrampClient

GolOnrampMethod

GolOnrampSession

GolOnrampSessionInput

GolOwnerAgentRequestsClient

GolOwnerAgentRequestsClientOptions

GolOwnerAgentsClient

GolOwnerAgentsClientOptions

GolOwnerDelegationsClient

GolOwnerDeviceLoginClient

GolOwnerDeviceLoginClientOptions

GolOwnerHostedAgentClient

GolOwnerMandatesClient

GolOwnerPayload

GolOwnerRouteOptions

GolPortfolioHistory

GolPortfolioStatus

GolPriceRange

GolRequestOptions

GolResponse

GolRulesAddressEntry

GolRulesAllowlist

GolRulesBuild

GolRulesClient

GolRulesClientOptions

GolRulesInput

GolRulesPeriod

GolRulesTokenRef

GolRulesUserOp

GolSignedGrantEnable

GolSignRequest

GolSignRequestIntent

GolSignRequestKind

GolSignRequestKindInfo

GolSignRequestListRow

GolSignRequestOp

GolSignRequestOptions

GolSignRequestParked

GolSignRequestPreparation

GolSignRequestsClient

GolSignRequestsClientOptions

GolSignRequestStatus

GolTelegramChallenge

GolTelegramChallengeInput

GolTelegramClient

GolTelegramScope

GolTelegramView

GolTokenBalance

GolTradingAgent

GolTradingBacktest

GolTradingCompileQuestion

GolTradingCompileResult

GolTradingFill

GolTradingFilter

GolTradingIssue

GolTradingPosition

GolTradingSignal

GolTradingSkip

GolTradingStrategy

GolTradingTemplate

GolTradingTrigger

GolTradingValidation

GolTradingWallets

GolUnifiedBalance

GolUserOpsClient

GolUserOpsClientOptions

GolUserOpsRequestOptions

GolValuedHolding

GolYieldAgentAllocation

GolYieldAgentAllocationView

GolYieldAgentAskEvent

GolYieldAgentAskInput

GolYieldAgentAuthAction

GolYieldAgentAuthEnvelope

GolYieldAgentAuthMessageInput

GolYieldAgentAutoConfig

GolYieldAgentAutoEnableInput

GolYieldAgentAutoGrant

GolYieldAgentAutoRun

GolYieldAgentAutoStatus

GolYieldAgentBacktestResult

GolYieldAgentCandidate

GolYieldAgentChain

GolYieldAgentChainInfo

GolYieldAgentChainsResponse

GolYieldAgentCheck

GolYieldAgentCompileInput

GolYieldAgentCompileResult

GolYieldAgentCopyInput

GolYieldAgentCreateInput

GolYieldAgentDecision

GolYieldAgentDecisionKind

GolYieldAgentDetail

GolYieldAgentEvent

GolYieldAgentExclusion

GolYieldAgentExecutionOp

GolYieldAgentExecutionStatus

GolYieldAgentExecutionStatusResponse

GolYieldAgentFeedResponse

GolYieldAgentFilterField

GolYieldAgentHistoryPoint

GolYieldAgentListing

GolYieldAgentListingInput

GolYieldAgentListResponse

GolYieldAgentMarketResponse

GolYieldAgentMode

GolYieldAgentPlanExecutionResponse

GolYieldAgentPreparedPlan

GolYieldAgentPreparedTx

GolYieldAgentPrepareExecutionInput

GolYieldAgentPrepareExecutionResponse

GolYieldAgentPreviewResponse

GolYieldAgentResponse

GolYieldAgentsClient

GolYieldAgentSendExecutionInput

GolYieldAgentSendExecutionResponse

GolYieldAgentsRequestOptions

GolYieldAgentStats

GolYieldAgentStatus

GolYieldAgentsTradingClient

GolYieldAgentStrategy

GolYieldAgentStrategyIssue

GolYieldAgentSummary

GolYieldAgentTemplate

GolYieldAgentTemplatesResponse

GolYieldAgentTickResponse

GolYieldAgentTxRecord

GolYieldAgentValidationResult

GolYieldAgentVenue

GolYieldAgentVenueHistoryResponse

GolYieldAgentVenuesResponse

GolYieldAgentWalletView

GolYieldComparison

GolYieldCompatibility

GolYieldDecisionRecord

GolYieldMandateDraft

GolYieldOnboardingState

GolYieldOwnerDepositReceipt

GolYieldPositionSnapshot

GolYieldPreparedOwnerOperation

GolYieldProfileCandidate

GolYieldSafeCodeIdentityV1

GolYieldSafeCodeReaderV1

GolYieldSafeCodeReaderV2

GolYieldSafeFundingProofV1

GolYieldSafeFundingProofV2

GolYieldSafeFundingTransactionV1

GolYieldSafeManifestV1

GolYieldSafeManifestV2

GolYieldSafeOnboardingClientOptionsV1

GolYieldSafeOnboardingClientOptionsV2

GolYieldSafeOnboardingClientV1

GolYieldSafeOnboardingClientV2

GolYieldSafeQuoteErrorCode

GolYieldSafeQuoteExpectationV1

GolYieldSafeQuoteExpectationV2

GolYieldSafeQuoteResultV1

GolYieldSafeQuoteResultV2

GolYieldSafeQuoteV1

GolYieldSafeQuoteV2

GolYieldSafeReadinessReasonV1

GolYieldSafeStatusStateV1

GolYieldSafeStatusV1

GolYieldSafeStatusV2

GolYieldSafeWireCallV1

GolYieldScan

GolYieldSepoliaAccountPreflight

GolYieldSepoliaReadiness

GolYieldVaultAccountEvidence

GolYieldVaultAccountKind

GolYieldVaultCreationDraft

GolYieldVaultCreationReceipt

GolYieldVaultDepositDraft

GolYieldVaultDepositInput

GolYieldVaultIdentity

HostedOwnerAction

HostedOwnerActionInput

HostedOwnerActionName

HostedOwnerConfiguration

InclusionWebhookEventData

InclusionWebhookEventType

KernelCall

KernelExecutionCall

MandateTermsInput

OperationHandle

OperationStatus

OperationStorage

OwnerAccountCall

OwnerActionLaunch

OwnerActionSession

OwnerGasPolicy

OwnerOperation

OwnerOperationOptions

OwnerSigner

OwnerSignerIdentity

PackedUserOperation

PreparedChildMandateExpectations

PreparedGasExecutionExpectations

PreparedGasPolicyExpectations

PreparedGasRevocation

RawHashSigner

RouteReview

SafetyActionCode

SafetyActionName

SignatureFormat

SignedOwnerOp

SignedOwnerUserOperation

TransferPolicyInput

TypedDataPayload

UnsignedUserOperation

UserOpReceipt

UserOpState

WaitResult

WalletBinding

WalletSigningInput

WalletSigningPayload

WebhookEventType

@gol/sdk/server

Typed API clients, polling helpers, and webhook verification. Server-only, because these calls carry your API key or developer session token.

Classes

GolApiClient

Extends ProjectResources, an internal base class the package does not export.

GolApiError

Extends GolError, an internal base class the package does not export.

GolManagementClient

Extends ProjectResources, an internal base class the package does not export.

GolTransportError

Extends Error.

GolWebhookVerificationError

new GolWebhookVerificationError(message: string) Extends Error.

Functions

API request and response types

These aliases are generated from the platform OpenAPI contract, so their shape is exactly the one in the API reference. Operation is the OpenAPI operationId that defines the type.

Types

GolAgentDelegationsClient

GolAgentDelegationsOptions

GolApiClientOptions

GolClientOptions

GolDelegatedTransfer

GolDeviceLoginClient

GolDeviceLoginClientOptions

GolDeviceLoginPoll

GolDeviceLoginStart

GolExpectedOperationAccount

GolManagementClientOptions

GolWebhookEvent

InclusionWebhookEventData

InclusionWebhookEventType

PageOptions

WaitOptions

WebhookEventType

X402DomainReader

X402PaymentReview