Vana SDK - v4.1.0
    Preparing search index...

    Module index.browser

    Exposes the platform adapter, ECIES crypto, storage providers, smart-contract helpers, ABIs, addresses, chain configurations, and shared types — without Node-only dependencies.

    Classes - Storage

    StorageManager
    CallbackStorage
    DropboxStorage
    GoogleDriveStorage
    IpfsStorage
    PinataStorage
    R2Storage
    VanaStorage

    Classes - Reference

    MissingAuthError
    InvalidSignatureError
    ExpiredTokenError
    InMemoryTokenStore
    BrowserECIESProvider
    JobEnvelopeError
    EscrowWithdrawalLifecycleError
    EscrowWithdrawalRejectionError
    InvalidScopeEntryError
    PSError

    Classes - Auth

    OAuthClient

    Classes - Contracts

    ContractFactory

    Classes - Error Handling

    VanaError
    RelayerError
    UserRejectedRequestError
    InvalidConfigurationError
    ContractNotFoundError
    BlockchainError
    SerializationError
    SignatureError
    NetworkError
    NonceError
    PersonalServerError
    ServerUrlMismatchError
    PermissionError
    ReadOnlyError
    TransactionPendingError
    PersonalServerWriteError
    WriteRequestError
    WriteTransportError
    WriteSessionError
    WriteSessionExpiredError
    WriteUnauthorizedError
    WriteForbiddenError
    WriteConflictError
    WriteLineageError
    WriteRejectedError
    JobsClientError
    BuilderUnknownError
    GrantInvalidError
    OwnerNotReadyError
    JobIdTakenError
    JobNotFoundError
    JobRequestTooLargeError
    JobTimeoutError
    JobResultIntegrityError
    JobRejectedError
    JobTransportError
    LineageReadError
    DerivativeQuestionRejectedError
    DerivativeQuestionInvalidError
    DerivativeQuestionNotFoundError
    DerivativeDerivedScopeRequiredError
    DerivativeSourceNotGrantedError
    DerivativeCycleError
    DerivativeComputeUnavailableError
    DerivativeQuestionTimeoutError
    DerivativeQuestionFailedError
    DataPointDeletedError
    DataPointNotFoundError
    DataPointVersionConflictError

    Classes - Errors

    ECIESError

    Classes - Platform

    BrowserPlatformAdapter

    Interfaces - Storage

    R2Config
    VanaStorageSigner
    VanaStorageConfig
    VanaStorageScopeDeleteResult
    StorageProvider

    Interfaces - Configuration

    StorageCallbacks
    StorageDownloadOptions
    StorageListResult

    Interfaces - Reference

    OAuthClientConfig
    AuthorizationUrlResult
    TokenRecord
    TokenStore
    ServiceEndpoints
    ECIESEncrypted
    ECIESOptions
    SealedJobResultStream
    OpenedJobResultStream
    JobResultExpectation
    DataPointBlobDeleteResult
    DataPointBlobStore
    DataPointDeletedResult
    DataPointDeletionPartialResult
    DerivativeQuestionAuthParams
    AskPersonalServerResult
    GetDerivativeStatusParams
    WaitForDerivativeStatusParams
    WithdrawAuthorizationMessage
    GenericPaymentMessage
    EscrowBalanceEntry
    EscrowBalanceResult
    EscrowBalanceSyncResult
    DepositSubmissionResult
    PaymentBreakdown
    EscrowPayResult
    EscrowWithdrawalSubmittedWithoutTransaction
    EscrowWithdrawalSubmittedWithTransaction
    EscrowWithdrawalSettledResult
    EscrowWithdrawalFailureResult
    EscrowWithdrawalRejectedResult
    SubmitDepositParams
    PayForOpParams
    WithdrawFromEscrowParams
    WithdrawNonceResponse
    EscrowGatewayClient
    OpFee
    EnclaveIdentityEvidence
    ExpectedIdentity
    IdentityRequest
    IdentityResponse
    IdentityRegistrationResponse
    MasterSignatureDelivery
    SealedSecretSubmission
    SealedSecretResponse
    AesGcmBox
    SealedEnvelope
    EnclaveTrustAnchors
    JobPaymentAuthorization
    JobQuote
    JobAccessRecord
    JobRequest
    JobRequestEnvelope
    JobSubmission
    ResultHandle
    JobStatus
    ClaimRequest
    ClaimResponse
    HeartbeatRequest
    CompleteRequest
    FailRequest
    FencedResponse
    JobResult
    TeeNodeRegistration
    TeeNodeHeartbeat
    TeeNode
    LineageReadResult
    PersonalServerLineageParams
    GatewayLineageParams
    WriteSession
    WriteBinaryPayload
    WriteJsonDataParams
    WriteBinaryDataParams
    WritePersonalServerDataResult
    ParsedScopeEntry
    GrantPermission
    WriteSigner
    ViemWriteAccount
    ViemWriteWalletClient

    Interfaces - Contracts

    ContractInfo
    ContractDeployment

    Interfaces - Cryptography

    ECIESProvider

    Interfaces - Platform

    VanaPlatformAdapter

    Interfaces - Protocol

    WriteTransportRetryOptions

    Type Aliases - Reference

    Web3SignedSignFn
    JobResultMetadata
    JobGatewayErrorCode
    DerivativeErrorCode
    QuestionStatus
    QuestionRegisteredBy
    DerivativeQuestion
    QuestionRecomputeResult
    QuestionDeleteResult
    DerivativeStatus
    EscrowWithdrawalSubmittedResult
    EscrowWithdrawalResult
    EscrowPaymentClient
    UserPsId
    IdentityState
    IdentityRegistrationRequest
    PaymentState
    TeeNodeState
    LineageNode
    RedactedLineageNode
    LineageEntry
    LineageGraph
    LineageSource
    WriteDataResult
    ScopeAction
    WriteSignerSource
    PSErrorCode

    Type Aliases - Blockchain

    VanaChainId
    VanaChain

    Type Aliases - Contracts

    VanaContractAddress
    VanaContractName
    VanaContractInstance
    ContractAddresses

    Type Aliases - Error Handling

    PersonalServerWriteErrorCode

    Type Aliases - Protocol

    ProtocolNetwork

    Variables - Configuration

    CONTRACTS

    Variables - Reference

    vanaMainnet
    moksha
    mainnetServices
    mokshaServices
    JOB_RESULT_FORMAT_VERSION
    JOB_RESULT_CHUNK_BYTES
    MASTER_KEY_MESSAGE
    TOMBSTONE_DATA_HASH_PREIMAGE
    TOMBSTONE_METADATA_HASH_PREIMAGE
    TOMBSTONE_DATA_HASH
    TOMBSTONE_METADATA_HASH
    DERIVATIVE_QUESTIONS_PATH
    MAX_QUESTION_SOURCE_SCOPES
    MAX_QUESTION_CHARS
    MAX_QUESTION_MODEL_CHARS
    DEFAULT_QUESTION_TIMEOUT_MS
    DEFAULT_QUESTION_POLL_INTERVAL_MS
    QUESTION_STATUSES
    DERIVATIVE_ERROR_CODES
    DerivativeErrorCodeSchema
    QuestionRegisteredBySchema
    DerivativeQuestionSchema
    QuestionRecomputeResultSchema
    QuestionDeleteResultSchema
    DERIVATIVE_STATUS_PATH
    DEFAULT_DERIVATIVE_STATUS_TIMEOUT_MS
    DEFAULT_DERIVATIVE_STATUS_POLL_INTERVAL_MS
    DerivativeStatusSchema
    WITHDRAW_AUTHORIZATION_TYPES
    GENERIC_PAYMENT_TYPES
    ESCROW_DEPOSIT_ABI
    NATIVE_ASSET_ADDRESS
    REGISTRATION_KIND_FOR_OP
    MASTER_SIGNATURE_DELIVERY_MAX_AGE_SECONDS
    ENCLAVE_TRUST_ANCHORS
    RedactedLineageNodeSchema
    WRITE_SESSION_PATH
    WRITE_SIGNATURE_HEADER
    WRITE_METADATA_HEADER
    LINEAGE_FIELD
    MAX_LINEAGE_SOURCES
    WRITE_FILENAME_HEADER
    WRITE_CONTENT_DISPOSITION_HEADER
    WRITER_ATTRIBUTION_KEY
    LINEAGE_KEY
    RESERVED_WRITE_KEYS
    SCOPE_ACTIONS

    Variables - Auth

    PKCE_VERIFIER_PATTERN
    PKCE_CHALLENGE_PATTERN

    Variables - Blockchain

    chains

    Functions - Reference

    generatePkceVerifier
    computePkceChallenge
    verifyPkceChallenge
    computeBodyHash
    buildWeb3SignedHeader
    parseWeb3SignedHeader
    verifyWeb3Signed
    getChainConfig
    getAllChains
    getServiceEndpoints
    clearContractCache
    isECIESEncrypted
    serializeECIES
    deserializeECIES
    canonicalJobRequestBytes
    sealJobRequest
    openJobRequest
    sealJobResultStream
    sealJobResult
    openJobResultStream
    openJobResult
    encryptWithPassword
    decryptWithPassword
    deriveMasterKey
    recoverServerOwner
    deriveScopeKey
    getContractAddress
    createBrowserPlatformAdapter
    createPlatformAdapterSafe
    detectPlatform
    isPlatformSupported
    getPlatformCapabilities
    computeTombstoneHash
    isTombstoneHashes
    isDataPointTombstone
    tombstoneDeletedAt
    createViemDataPointDeletionSigner
    buildDataPointDeletionTypedData
    buildDataPointDeletionSignature
    deleteDataPoint
    registerQuestion
    getQuestion
    listQuestions
    recomputeQuestion
    deleteQuestion
    waitForQuestion
    askPersonalServer
    derivativeStatusTarget
    isDerivativeStatusSettled
    getDerivativeStatus
    waitForDerivativeStatus
    withdrawAuthorizationDomain
    buildWithdrawAuthorizationTypedData
    genericPaymentDomain
    createEscrowGatewayClient
    getFee
    getOpFee
    userPsId
    appRootPreimage
    kmsIssuedPreimage
    verifyEnclaveIdentityEvidence
    buildMasterSignatureDelivery
    encryptMasterSignatureDelivery
    isDataPointId
    deriveDataPointId
    scopeNamespace
    derivedScopeViolatesNaming
    assertDerivedScopeNaming
    isRedactedLineageNode
    personalServerLineagePath
    gatewayLineagePath
    getPersonalServerLineage
    getGatewayLineage
    getLineage
    openWriteSession
    sessionCoversScope
    normalizeBinaryMimeType
    parseWriteMetadataHeader
    encodeWriteMetadataHeader
    binaryWriteSignedBytes
    writeData
    writePersonalServerData
    parseScopeEntry
    formatScopeEntry
    grantPermissions
    permissionsToScopes
    hasAction
    tryGrantPermissions
    resolveWriteSigner
    parsePSError

    Functions - Auth

    assertValidPkceVerifier

    Functions - Blockchain

    isVanaChainId
    isVanaChain

    Functions - Contracts

    getContractController
    getContractInfo

    Settings

    Member Visibility

    On This Page

    Classes - Storage
    Classes - Reference
    Classes - Auth
    Classes - Contracts
    Classes - Error Handling
    VanaErrorRelayerErrorUserRejectedRequestErrorInvalidConfigurationErrorContractNotFoundErrorBlockchainErrorSerializationErrorSignatureErrorNetworkErrorNonceErrorPersonalServerErrorServerUrlMismatchErrorPermissionErrorReadOnlyErrorTransactionPendingErrorPersonalServerWriteErrorWriteRequestErrorWriteTransportErrorWriteSessionErrorWriteSessionExpiredErrorWriteUnauthorizedErrorWriteForbiddenErrorWriteConflictErrorWriteLineageErrorWriteRejectedErrorJobsClientErrorBuilderUnknownErrorGrantInvalidErrorOwnerNotReadyErrorJobIdTakenErrorJobNotFoundErrorJobRequestTooLargeErrorJobTimeoutErrorJobResultIntegrityErrorJobRejectedErrorJobTransportErrorLineageReadErrorDerivativeQuestionRejectedErrorDerivativeQuestionInvalidErrorDerivativeQuestionNotFoundErrorDerivativeDerivedScopeRequiredErrorDerivativeSourceNotGrantedErrorDerivativeCycleErrorDerivativeComputeUnavailableErrorDerivativeQuestionTimeoutErrorDerivativeQuestionFailedErrorDataPointDeletedErrorDataPointNotFoundErrorDataPointVersionConflictError
    Classes - Errors
    Classes - Platform
    Interfaces - Storage
    Interfaces - Configuration
    Interfaces - Reference
    OAuthClientConfigAuthorizationUrlResultTokenRecordTokenStoreServiceEndpointsECIESEncryptedECIESOptionsSealedJobResultStreamOpenedJobResultStreamJobResultExpectationDataPointBlobDeleteResultDataPointBlobStoreDataPointDeletedResultDataPointDeletionPartialResultDerivativeQuestionAuthParamsAskPersonalServerResultGetDerivativeStatusParamsWaitForDerivativeStatusParamsWithdrawAuthorizationMessageGenericPaymentMessageEscrowBalanceEntryEscrowBalanceResultEscrowBalanceSyncResultDepositSubmissionResultPaymentBreakdownEscrowPayResultEscrowWithdrawalSubmittedWithoutTransactionEscrowWithdrawalSubmittedWithTransactionEscrowWithdrawalSettledResultEscrowWithdrawalFailureResultEscrowWithdrawalRejectedResultSubmitDepositParamsPayForOpParamsWithdrawFromEscrowParamsWithdrawNonceResponseEscrowGatewayClientOpFeeEnclaveIdentityEvidenceExpectedIdentityIdentityRequestIdentityResponseIdentityRegistrationResponseMasterSignatureDeliverySealedSecretSubmissionSealedSecretResponseAesGcmBoxSealedEnvelopeEnclaveTrustAnchorsJobPaymentAuthorizationJobQuoteJobAccessRecordJobRequestJobRequestEnvelopeJobSubmissionResultHandleJobStatusClaimRequestClaimResponseHeartbeatRequestCompleteRequestFailRequestFencedResponseJobResultTeeNodeRegistrationTeeNodeHeartbeatTeeNodeLineageReadResultPersonalServerLineageParamsGatewayLineageParamsWriteSessionWriteBinaryPayloadWriteJsonDataParamsWriteBinaryDataParamsWritePersonalServerDataResultParsedScopeEntryGrantPermissionWriteSignerViemWriteAccountViemWriteWalletClient
    Interfaces - Contracts
    Interfaces - Cryptography
    Interfaces - Platform
    Interfaces - Protocol
    Type Aliases - Reference
    Type Aliases - Blockchain
    Type Aliases - Contracts
    Type Aliases - Error Handling
    Type Aliases - Protocol
    Variables - Configuration
    Variables - Reference
    vanaMainnetmokshamainnetServicesmokshaServicesJOB_RESULT_FORMAT_VERSIONJOB_RESULT_CHUNK_BYTESMASTER_KEY_MESSAGETOMBSTONE_DATA_HASH_PREIMAGETOMBSTONE_METADATA_HASH_PREIMAGETOMBSTONE_DATA_HASHTOMBSTONE_METADATA_HASHDERIVATIVE_QUESTIONS_PATHMAX_QUESTION_SOURCE_SCOPESMAX_QUESTION_CHARSMAX_QUESTION_MODEL_CHARSDEFAULT_QUESTION_TIMEOUT_MSDEFAULT_QUESTION_POLL_INTERVAL_MSQUESTION_STATUSESDERIVATIVE_ERROR_CODESDerivativeErrorCodeSchemaQuestionRegisteredBySchemaDerivativeQuestionSchemaQuestionRecomputeResultSchemaQuestionDeleteResultSchemaDERIVATIVE_STATUS_PATHDEFAULT_DERIVATIVE_STATUS_TIMEOUT_MSDEFAULT_DERIVATIVE_STATUS_POLL_INTERVAL_MSDerivativeStatusSchemaWITHDRAW_AUTHORIZATION_TYPESGENERIC_PAYMENT_TYPESESCROW_DEPOSIT_ABINATIVE_ASSET_ADDRESSREGISTRATION_KIND_FOR_OPMASTER_SIGNATURE_DELIVERY_MAX_AGE_SECONDSENCLAVE_TRUST_ANCHORSRedactedLineageNodeSchemaWRITE_SESSION_PATHWRITE_SIGNATURE_HEADERWRITE_METADATA_HEADERLINEAGE_FIELDMAX_LINEAGE_SOURCESWRITE_FILENAME_HEADERWRITE_CONTENT_DISPOSITION_HEADERWRITER_ATTRIBUTION_KEYLINEAGE_KEYRESERVED_WRITE_KEYSSCOPE_ACTIONS
    Variables - Auth
    Variables - Blockchain
    Functions - Reference
    generatePkceVerifiercomputePkceChallengeverifyPkceChallengecomputeBodyHashbuildWeb3SignedHeaderparseWeb3SignedHeaderverifyWeb3SignedgetChainConfiggetAllChainsgetServiceEndpointsclearContractCacheisECIESEncryptedserializeECIESdeserializeECIEScanonicalJobRequestBytessealJobRequestopenJobRequestsealJobResultStreamsealJobResultopenJobResultStreamopenJobResultencryptWithPassworddecryptWithPasswordderiveMasterKeyrecoverServerOwnerderiveScopeKeygetContractAddresscreateBrowserPlatformAdaptercreatePlatformAdapterSafedetectPlatformisPlatformSupportedgetPlatformCapabilitiescomputeTombstoneHashisTombstoneHashesisDataPointTombstonetombstoneDeletedAtcreateViemDataPointDeletionSignerbuildDataPointDeletionTypedDatabuildDataPointDeletionSignaturedeleteDataPointregisterQuestiongetQuestionlistQuestionsrecomputeQuestiondeleteQuestionwaitForQuestionaskPersonalServerderivativeStatusTargetisDerivativeStatusSettledgetDerivativeStatuswaitForDerivativeStatuswithdrawAuthorizationDomainbuildWithdrawAuthorizationTypedDatagenericPaymentDomaincreateEscrowGatewayClientgetFeegetOpFeeuserPsIdappRootPreimagekmsIssuedPreimageverifyEnclaveIdentityEvidencebuildMasterSignatureDeliveryencryptMasterSignatureDeliveryisDataPointIdderiveDataPointIdscopeNamespacederivedScopeViolatesNamingassertDerivedScopeNamingisRedactedLineageNodepersonalServerLineagePathgatewayLineagePathgetPersonalServerLineagegetGatewayLineagegetLineageopenWriteSessionsessionCoversScopenormalizeBinaryMimeTypeparseWriteMetadataHeaderencodeWriteMetadataHeaderbinaryWriteSignedByteswriteDatawritePersonalServerDataparseScopeEntryformatScopeEntrygrantPermissionspermissionsToScopeshasActiontryGrantPermissionsresolveWriteSignerparsePSError
    Functions - Auth
    Functions - Blockchain
    Functions - Contracts