JustaName
API ReferenceSDK Reference
SDK Reference
SDK Reference
  • JustVerified Plugin
    • globals
    • functions
      • JustVerifiedDialog
      • JustVerifiedPlugin
      • JustVerifiedProvider
      • SelectCredentialItem
      • buildGenerateOtpKey
      • generateOtp
      • useClearOtp
      • useGenerateOtp
      • usePreviousState
      • useResendOtp
      • useSocialVerification
      • useVerifyOtp
    • interfaces
      • ClearOtpParams
      • DiscordCredential
      • GithubCredential
      • JustVerifiedDialogProps
      • JustVerifiedResponse
      • ResendOtpParams
      • SelectCredentialItemProps
      • SocialVerificationParams
      • TelegramCredential
      • TwitterCredential
      • UseClearOtpParams
      • UseClearOtpResult
      • UseGenerateOtpParams
      • UseGenerateOtpResult
      • UseResendOtpParams
      • UseResendOtpResult
      • UseSocialVerificationParams
      • UseSocialVerificationResult
      • UseVerifyOtpParams
      • UseVerifyOtpResult
      • VerifyOtpParams
    • type-aliases
      • CredentialMetadataKey
      • CredentialMetadataValue
      • Credentials
      • DiscordEthereumEip712Signature
      • GithubEthereumEip712Signature
      • TelegramEthereumEip712Signature
      • TwitterEthereumEip712Signature
      • VerifyOtpResponse
    • variables
      • CredentialMetadataKeyStandard
      • CredentialMetadataKeyStandardReverse
  • JustWeb3 EFP Plugin
    • globals
    • functions
      • EFPIcon
      • buildFollowStateQueryKey
      • buildFollowersQueryKey
      • buildFollowingQueryKey
      • buildStatsQueryKey
      • getFollowState
      • getFollowers
      • getFollowing
      • getStats
      • useFollowState
      • useFollowers
      • useFollowing
      • useStats
    • interfaces
      • FollowState
      • Followers
      • Following
      • Stats
      • UseFollowStateParams
      • UseFollowStateResult
      • UseFollowersParams
      • UseFollowersResult
      • UseFollowingParams
      • UseFollowingResult
      • UseStatsParams
      • UseStatsResult
    • variables
      • EFPPlugin
  • JustWeb3 UI
    • globals
    • functions
      • A
      • Avatar
      • Badge
      • Button
      • Carousel
      • ClickableItem
      • Dialog
      • DialogClose
      • DialogContent
      • DialogDescription
      • DialogFooter
      • DialogHeader
      • DialogTitle
      • DialogTrigger
      • Divider
      • DropdownMenu
      • DropdownMenuContent
      • DropdownMenuItem
      • DropdownMenuLabel
      • DropdownMenuSeparator
      • DropdownMenuTrigger
      • ExpandableText
      • Flex
      • Form
      • FormControl
      • FormDescription
      • FormField
      • FormItem
      • FormLabel
      • FormMessage
      • H2
      • Input
      • JustWeb3ThemeProvider
      • LoadingSpinner
      • OTPInput
      • OTPInputGroup
      • OTPInputSeparator
      • OTPInputSlot
      • OrLine
      • P
      • Popover
      • PopoverContent
      • PopoverTrigger
      • SPAN
      • Separator
      • Tabs
      • TabsContent
      • TabsList
      • TabsTrigger
      • convertToHSL
      • detectLightColor
      • formatText
      • generateDarkVariation
      • generateLightVariation
      • useFormField
      • useJustWeb3Theme
    • interfaces
      • ButtonProps
      • DialogContentProps
      • JustWeb3ThemeProviderConfig
      • JustWeb3ThemeProviderProps
      • LoadingSpinnerProps
      • PopoverContentProps
    • variables
      • chains
      • contentHash
      • general
      • logo
      • socials
  • JustWeb3 Widget
    • globals
    • functions
      • EnsMetadataBadge
      • JustEnsCard
      • JustWeb3Button
      • JustWeb3Provider
      • JustaNameDialog
      • JustaNameFooter
      • JustaNameLoadingDialog
      • ProfileSection
      • getChainIcon
      • getContentHashIcon
      • getTextRecordIcon
      • useDebounce
      • useJustWeb3
      • useMApp
      • useMApps
      • usePlugins
    • interfaces
      • JustWeb3ContextProps
      • JustWeb3ProviderConfig
      • JustWeb3ProviderProps
      • JustaPlugin
      • PluginApi
      • useJustWeb3
    • type-aliases
      • UpdateRecordsParams
    • variables
      • JustWeb3Context
  • JustaName Core SDK
    • globals
    • classes
      • ApiKeyRequiredException
      • InvalidConfigurationException
      • InvalidENSException
      • InvalidSignInException
      • JustaName
      • MApps
      • OffchainResolvers
      • SignIn
      • SubnameChallenge
      • Subnames
    • functions
      • createAddresses
      • createGenerals
      • createSocialsAndOthers
      • getCoinTypeDetails
      • sanitizeAddresses
      • sanitizeRecords
      • sanitizeTexts
    • interfaces
      • AddMAppPermissionRequest
      • AddMAppPermissionRoute
      • Address
      • AddressWithTypedCoins
      • ApiKeyHeaders
      • ApiKeyResponse
      • ApiKeyRoute
      • AppendMAppFieldRequest
      • AppendMAppFieldRoute
      • AppendMAppFieldsRequest
      • BaseResponse
      • Coin
      • CoinType
      • Configuration
      • ContentHash
      • EmptyHeaders
      • EnsDomainByChainId
      • Generals
      • IHeaders
      • IRequest
      • IResponse
      • IRoute
      • IsSubnameAvailableRequest
      • IsSubnameAvailableResponse
      • IsSubnameAvailableRoute
      • JustaNameConfig
      • JustaNameConfigDefaults
      • MApp
      • MAppsParams
      • Network
      • NetworkWithProvider
      • OffchainResolverGetAllRequest
      • OffchainResolverGetAllResponse
      • OffchainResolversGetAllRoute
      • OffchainResolversParams
      • PaginatedResponse
      • Pagination
      • ROUTES
      • RecordResponse
      • RequestAddMAppPermissionChallengeRequest
      • RequestAddMAppPermissionChallengeResponse
      • RequestAddMAppPermissionChallengeRoute
      • RequestAppendMAppFieldChallengeRequest
      • RequestAppendMAppFieldChallengeResponse
      • RequestAppendMAppFieldChallengeRoute
      • RequestChallengeRequest
      • RequestChallengeResponse
      • RequestChallengeRoute
      • RequestRevokeMAppPermissionChallengeRequest
      • RequestRevokeMAppPermissionChallengeResponse
      • RequestRevokeMAppPermissionChallengeRoute
      • RequestSignInParams
      • RevokeMAppPermissionRequest
      • RevokeMAppPermissionRoute
      • SIWEHeaders
      • SanitizedRecords
      • SignInFunctionParams
      • SignInParams
      • SignInResponse
      • SigninConfig
      • SiweConfig
      • Socials
      • SubnameAcceptRequest
      • SubnameAcceptRoute
      • SubnameAddRequest
      • SubnameAddRoute
      • SubnameChallengeParams
      • SubnameChallengeSiweConfig
      • SubnameGetAllByAddressRequest
      • SubnameGetAllByAddressResponse
      • SubnameGetAllByAddressRoute
      • SubnameGetAllByDomainChainIdRequest
      • SubnameGetAllByDomainChainIdResponse
      • SubnameGetAllByDomainChainIdRoute
      • SubnameGetAllByEnsDomainWithCountApiResponse
      • SubnameGetAllByEnsDomainWithCountRequest
      • SubnameGetAllByEnsDomainWithCountResponse
      • SubnameGetAllByEnsDomainWithCountRoute
      • SubnameGetBySubnameRequest
      • SubnameGetBySubnameRoute
      • SubnameGetInvitationsByAddressRequest
      • SubnameGetInvitationsByAddressResponse
      • SubnameGetInvitationsByAddressRoute
      • SubnameRecordsRequest
      • SubnameRecordsRoute
      • SubnameRejectRequest
      • SubnameRejectRoute
      • SubnameReserveRequest
      • SubnameReserveRoute
      • SubnameResponse
      • SubnameRevokeRequest
      • SubnameRevokeRoute
      • SubnameSearchRequest
      • SubnameSearchResponse
      • SubnameSearchRoute
      • SubnameUpdateRequest
      • SubnameUpdateRoute
      • SubnamesConfig
      • Text
      • TextRecord
      • VerifyChallengeRequest
      • VerifyChallengeResponse
      • VerifyMessageRoute
    • type-aliases
      • AddressType
      • ChainId
      • CoinAndDetails
      • CoinTypeKeys
      • CoinTypeMap
      • EnsDomains
      • GeneralsIdentifier
      • GeneralsName
      • MakeOptionalProps
      • Networks
      • NetworksWithProvider
      • PartialAddressJson
      • SocialDetails
      • SocialsIdentifier
      • SocialsName
      • SupportedCoins
      • SupportedGeneralsNames
      • SupportedSocialsNames
    • variables
      • GENERAL_FIELDS
      • Routes
      • SUPPORTED_SOCIALS
      • coinTypeMap
  • JustaName React SDK
    • globals
    • functions
      • JustaNameProvider
      • buildAccountInvitationsKey
      • buildAddressEnsNames
      • buildAddressSubnamesKey
      • buildAllEnsKey
      • buildCanEnableMAppsKey
      • buildEnabledMAppsKey
      • buildEnsAuthKey
      • buildEnsAvatarKey
      • buildEnsSubnamesKey
      • buildIsMAppEnabledKey
      • buildIsSubnameAvailableKey
      • buildPrimaryName
      • buildRecordsBySubnameKey
      • buildSearchSubnamesKey
      • buildSignature
      • buildSubnameBySubnameKey
      • buildUpdateChangesKey
      • getChangedAddresses
      • getChangedContentHash
      • getChangedTextRecords
      • splitDomain
      • useAcceptSubname
      • useAccountEnsNames
      • useAccountInvitations
      • useAccountSubnames
      • useAddMAppPermission
      • useAddSubname
      • useAddressEnsNames
      • useAddressSubnames
      • useAllEns
      • useCanEnableMApps
      • useEnabledMApps
      • useEnsAuth
      • useEnsAvatar
      • useEnsSignIn
      • useEnsSignOut
      • useEnsSubnames
      • useIsMAppEnabled
      • useIsSubnameAvailable
      • useJustaName
      • useMounted
      • useMountedAccount
      • useOffchainResolvers
      • usePrimaryName
      • useRecords
      • useRejectSubname
      • useRevokeMAppPermission
      • useRevokeSubname
      • useSearchSubnames
      • useSetNameHashJustaNameResolver
      • useSubname
      • useSubnameSignature
      • useUpdateChanges
      • useUpdateSubname
      • useUploadMedia
    • interfaces
      • GetEnsAvatarParams
      • GetEnsNamesForAddressParams
      • GetRecordsParams
      • GetRecordsResult
      • GetUpdateChangesParams
      • GetUpdateChangesResult
      • JustaNameContextProps
      • JustaNameProviderConfig
      • JustaNameProviderProps
      • Records
      • SanitizeImageParams
      • UseAcceptSubnameFunctionParams
      • UseAcceptSubnameResult
      • UseAccountEnsNamesParams
      • UseAccountEnsNamesResult
      • UseAddMAppPermissionFunctionParams
      • UseAddMAppPermissionParams
      • UseAddSubnameParams
      • UseAddSubnameResult
      • UseAddressEnsNamesParams
      • UseAddressEnsNamesResult
      • UseAddressSubnamesParams
      • UseAllEnsParams
      • UseCanEnableMAppsParams
      • UseCanEnableMAppsResult
      • UseConnectedWalletSubnamesOptions
      • UseEnabledMAppsParams
      • UseEnabledMAppsResult
      • UseEnsAuthParams
      • UseEnsAuthReturn
      • UseEnsAvatarParams
      • UseEnsAvatarResult
      • UseEnsSignInParams
      • UseEnsSignInResult
      • UseEnsSignOutParams
      • UseEnsSignOutResult
      • UseEnsSubnamesParams
      • UseIsMAppEnabledParams
      • UseIsMAppEnabledResult
      • UseIsSubnameAvailableParams
      • UseIsSubnameAvailableResult
      • UsePrimaryNameParams
      • UsePrimaryNameResult
      • UseRecordsParams
      • UseRecordsResult
      • UseRejectSubnameFunctionParams
      • UseRejectSubnameResult
      • UseRequestAddMAppPermission
      • UseRequestRevokeMAppPermissionResult
      • UseRevokeMAppPermissionFunctionParams
      • UseRevokeMAppPermissionParams
      • UseRevokeSubnameParams
      • UseRevokeSubnameResult
      • UseSearchSubnamesParams
      • UseSetNameHashJustaNameResolver
      • UseSubnameSignatureResult
      • UseSubnameUpdateFunctionParams
      • UseUpdateChangesParams
      • UseUpdateChangesResult
      • UseUpdateSubnameParams
      • UseUpdateSubnameResult
      • UseUploadMediaParams
      • UseUploadMediaResponse
      • UseUploadMediaResult
      • getPrimaryNameParams
    • type-aliases
      • EnsAuth
      • JustaNameConfigWithoutDefaultChainId
      • SubnameRecordResponse
      • UseAcceptSubnameParams
      • UseAccountInvitationsParams
      • UseAddSubnameFunctionParams
      • UseEnsSignInFunctionParams
      • UseRejectSubnameParams
      • UseRevokeSubnameFunctionParams
      • UseSubnameParams
    • variables
      • JustaNameContext
      • OFFCHAIN_RESOLVERS_KEY
  • siwens
    • globals
    • classes
      • InvalidConfigurationException
      • InvalidENSException
      • InvalidStatementException
      • InvalidTimeException
      • SIWENS
    • functions
      • checkDomainValid
      • checkTTL
      • constructSignInStatement
      • extractDataFromStatement
    • interfaces
      • SiwensConfig
      • SiwensParams
      • SiwensResponse
Powered by GitBook
On this page
  • @justaname.id/sdk
  • Classes
  • Interfaces
  • Type Aliases
  • Variables
  • Functions

Was this helpful?

Edit on GitHub
  1. JustaName Core SDK

globals

PreviousJustaName Core SDKNextclasses

Last updated 6 months ago

Was this helpful?

• Docs


@justaname.id/sdk

Classes

Interfaces

Type Aliases

Variables

Functions

@justaname.id/sdk
ApiKeyRequiredException
InvalidConfigurationException
InvalidENSException
InvalidSignInException
JustaName
MApps
OffchainResolvers
SignIn
SubnameChallenge
Subnames
AddMAppPermissionRequest
AddMAppPermissionRoute
Address
AddressWithTypedCoins
ApiKeyHeaders
ApiKeyResponse
ApiKeyRoute
AppendMAppFieldRequest
AppendMAppFieldRoute
AppendMAppFieldsRequest
BaseResponse
Coin
CoinType
Configuration
ContentHash
EmptyHeaders
EnsDomainByChainId
Generals
IHeaders
IRequest
IResponse
IRoute
IsSubnameAvailableRequest
IsSubnameAvailableResponse
IsSubnameAvailableRoute
JustaNameConfig
JustaNameConfigDefaults
MApp
MAppsParams
Network
NetworkWithProvider
OffchainResolverGetAllRequest
OffchainResolverGetAllResponse
OffchainResolversGetAllRoute
OffchainResolversParams
PaginatedResponse
Pagination
RecordResponse
RequestAddMAppPermissionChallengeRequest
RequestAddMAppPermissionChallengeResponse
RequestAddMAppPermissionChallengeRoute
RequestAppendMAppFieldChallengeRequest
RequestAppendMAppFieldChallengeResponse
RequestAppendMAppFieldChallengeRoute
RequestChallengeRequest
RequestChallengeResponse
RequestChallengeRoute
RequestRevokeMAppPermissionChallengeRequest
RequestRevokeMAppPermissionChallengeResponse
RequestRevokeMAppPermissionChallengeRoute
RequestSignInParams
RevokeMAppPermissionRequest
RevokeMAppPermissionRoute
ROUTES
SanitizedRecords
SigninConfig
SignInFunctionParams
SignInParams
SignInResponse
SiweConfig
SIWEHeaders
Socials
SubnameAcceptRequest
SubnameAcceptRoute
SubnameAddRequest
SubnameAddRoute
SubnameChallengeParams
SubnameChallengeSiweConfig
SubnameGetAllByAddressRequest
SubnameGetAllByAddressResponse
SubnameGetAllByAddressRoute
SubnameGetAllByDomainChainIdRequest
SubnameGetAllByDomainChainIdResponse
SubnameGetAllByDomainChainIdRoute
SubnameGetAllByEnsDomainWithCountApiResponse
SubnameGetAllByEnsDomainWithCountRequest
SubnameGetAllByEnsDomainWithCountResponse
SubnameGetAllByEnsDomainWithCountRoute
SubnameGetBySubnameRequest
SubnameGetBySubnameRoute
SubnameGetInvitationsByAddressRequest
SubnameGetInvitationsByAddressResponse
SubnameGetInvitationsByAddressRoute
SubnameRecordsRequest
SubnameRecordsRoute
SubnameRejectRequest
SubnameRejectRoute
SubnameReserveRequest
SubnameReserveRoute
SubnameResponse
SubnameRevokeRequest
SubnameRevokeRoute
SubnamesConfig
SubnameSearchRequest
SubnameSearchResponse
SubnameSearchRoute
SubnameUpdateRequest
SubnameUpdateRoute
Text
TextRecord
VerifyChallengeRequest
VerifyChallengeResponse
VerifyMessageRoute
AddressType
ChainId
CoinAndDetails
CoinTypeKeys
CoinTypeMap
EnsDomains
GeneralsIdentifier
GeneralsName
MakeOptionalProps
Networks
NetworksWithProvider
PartialAddressJson
SocialDetails
SocialsIdentifier
SocialsName
SupportedCoins
SupportedGeneralsNames
SupportedSocialsNames
coinTypeMap
GENERAL_FIELDS
Routes
SUPPORTED_SOCIALS
createAddresses
createGenerals
createSocialsAndOthers
getCoinTypeDetails
sanitizeAddresses
sanitizeRecords
sanitizeTexts