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
  • Class: Subnames
  • Constructors
  • Methods

Was this helpful?

Edit on GitHub
  1. JustaName Core SDK
  2. classes

Subnames

PreviousSubnameChallengeNextfunctions

Last updated 6 months ago

Was this helpful?

• Docs


/ Subnames

Class: Subnames

Constructors

new Subnames()

new Subnames(params):

Parameters

• params:

Returns

Defined in

Methods

acceptSubname()

Parameters

Returns

Defined in


addSubname()

Parameters

Returns

Defined in


getInvitationsByAddress()

Parameters

Returns

Defined in


getPrimaryNameByAddress()

getPrimaryNameByAddress(params): Promise<PrimaryNameGetByAddressResponse>

Parameters

Returns

Promise<PrimaryNameGetByAddressResponse>

Defined in


getRecords()

Parameters

Returns

Defined in


getSubname()

Parameters

Returns

Defined in


getSubnamesByAddress()

Parameters

Returns

Defined in


getSubnamesByEnsDomain()

Parameters

Returns

Defined in


getSubnamesByEnsDomainWithCount()

Parameters

Returns

Defined in


isSubnameAvailable()

Parameters

Returns

Defined in


rejectSubname()

Parameters

Returns

Defined in


reserveSubname()

Parameters

Returns

Defined in


revokeSubname()

Parameters

Returns

Defined in


searchSubnames()

Parameters

Returns

Defined in


updateSubname()

Parameters

Returns

Defined in

acceptSubname(params, headers): Promise<>

• params: Omit<<, "chainId" | "ensDomain">, "addresses" | "text"> & object

• headers: &

Promise<>

addSubname(params, headers): Promise<>

• params: Omit<<, "chainId" | "ensDomain">, "addresses" | "text"> & object

• headers: &

Promise<>

getInvitationsByAddress(params): Promise<>

• params: Omit<<, "coinType" | "chainId">, "isClaimed">

Promise<>

• params: Omit<<PrimaryNameGetByAddressRequest, "chainId">, never>

getRecords(params): Promise<>

• params: Omit<<, "providerUrl">, never> & object

Promise<>

getSubname(params): Promise<>

• params: Omit<<, "chainId">, never>

Promise<>

getSubnamesByAddress(params): Promise<>

• params: Omit<<, "coinType" | "chainId" | "isClaimed">, never>

Promise<>

getSubnamesByEnsDomain(params): Promise<>

• params: Omit<<, "chainId" | "ensDomain">, never>

Promise<>

getSubnamesByEnsDomainWithCount(params): Promise<>

• params: Omit<<, "chainId">, never>

Promise<>

isSubnameAvailable(params): Promise<>

• params: Omit<<, "chainId">, never>

Promise<>

rejectSubname(params, headers): Promise<>

• params: Omit<<, "chainId" | "ensDomain">, never>

• headers:

Promise<>

reserveSubname(params): Promise<>

• params: Omit<<, "chainId" | "ensDomain">, never> & object

Promise<>

revokeSubname(params, headers): Promise<>

• params: Omit<<, "chainId" | "ensDomain">, never> & object

• headers: &

Promise<>

searchSubnames(params): Promise<>

• params: Omit<<, "chainId">, never>

Promise<>

updateSubname(params, headers): Promise<>

• params: Omit<<, "chainId" | "ensDomain">, "addresses" | "text"> & object

• headers:

Promise<>

@justaname.id/sdk
@justaname.id/sdk
Subnames
SubnamesConfig
Subnames
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:58
SubnameResponse
MakeOptionalProps
SubnameAcceptRequest
ApiKeyHeaders
SIWEHeaders
SubnameResponse
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:65
SubnameResponse
MakeOptionalProps
SubnameAddRequest
ApiKeyHeaders
SIWEHeaders
SubnameResponse
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:137
SubnameGetInvitationsByAddressResponse
MakeOptionalProps
SubnameGetInvitationsByAddressRequest
SubnameGetInvitationsByAddressResponse
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:340
MakeOptionalProps
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:439
SubnameResponse
MakeOptionalProps
SubnameRecordsRequest
SubnameResponse
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:419
SubnameResponse
MakeOptionalProps
SubnameGetBySubnameRequest
SubnameResponse
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:302
SubnameGetAllByAddressResponse
MakeOptionalProps
SubnameGetAllByAddressRequest
SubnameGetAllByAddressResponse
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:320
SubnameGetAllByDomainChainIdResponse
MakeOptionalProps
SubnameGetAllByDomainChainIdRequest
SubnameGetAllByDomainChainIdResponse
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:360
SubnameGetAllByEnsDomainWithCountResponse
MakeOptionalProps
SubnameGetAllByEnsDomainWithCountRequest
SubnameGetAllByEnsDomainWithCountResponse
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:283
IsSubnameAvailableResponse
MakeOptionalProps
IsSubnameAvailableRequest
IsSubnameAvailableResponse
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:401
SubnameResponse
MakeOptionalProps
SubnameRejectRequest
SIWEHeaders
SubnameResponse
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:254
SubnameResponse
MakeOptionalProps
SubnameReserveRequest
SubnameResponse
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:108
SubnameResponse
MakeOptionalProps
SubnameRevokeRequest
ApiKeyHeaders
SIWEHeaders
SubnameResponse
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:219
SubnameSearchResponse
MakeOptionalProps
SubnameSearchRequest
SubnameSearchResponse
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:383
SubnameResponse
MakeOptionalProps
SubnameUpdateRequest
SIWEHeaders
SubnameResponse
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:188