modules

[# Masa React

• v3.2.0](/docs/developers/masa-react/) / Exports

# Masa React

• v3.2.0

Table of contents

Enumerations

• SoulNameErrorCodes

Interfaces

• ArweaveConfig
• MasaContextProviderProps
• MasaShape
• ModalProps
• SpinnerProps

Type Aliases

• EnvironmentNameEx
• OnSuccessInput
• UseCreditScoresReturnType
• UseGreenReturnValue
• UseNetworkInputValue
• UseNetworkReturnValue
• UseWalletReturnType

Variables

• MasaContext
• queryClient

Functions

• MasaContextProvider
• MasaInterface
• MasaLoading
• MasaProvider
• MasaRefactorProvider
• ModalComponent
• Spinner
• createNewMasa
• getCreditScoresQueryKey
• getGreenQueryKey
• getIdentityQueryKey
• getSessionDataQueryKey
• getSessionQueryKey
• getSoulnamesQueryKey
• getWalletQueryKey
• getWeb3Provider
• openAuthenticateModal
• openCreateSoulnameModal
• useCreditScores
• useCreditScoresQuery
• useDebounce
• useDebounceIfValue
• useErrors
• useGreen
• useGreenQuery
• useIdentity
• useIdentityQuery
• useLocalStorage
• useMasa
• useMetamask
• useModal
• useNetwork
• useNetworkSwitch
• useSBT
• useSession
• useSessionDataQuery
• useSessionQuery
• useSoulnames
• useSoulnamesQuery
• useWallet
• useWalletQuery

Type Aliases

EnvironmentNameEx

Ƭ EnvironmentNameEx: EnvironmentName & "local" | "stage"

---

OnSuccessInput

Ƭ OnSuccessInput: Object

Type declaration

Name	Type
creditScores?	{ metadata?: ICreditScore ; tokenId: BigNumber ; tokenUri: string }[]

---

UseCreditScoresReturnType

Ƭ UseCreditScoresReturnType: Object

Type declaration

Name	Type
creditScores?	{ metadata?: ICreditScore ; tokenId: BigNumber ; tokenUri: string }[]
error	unknown
handleCreateCreditScore	() => Promise<boolean | undefined>
invalidateCreditScores	() => void
isCreditScoresLoading	boolean
reloadCreditScores	() => void
status	string

---

UseGreenReturnValue

Ƭ UseGreenReturnValue: Object

Type declaration

Name	Type
error	unknown
greens?	{ metadata?: IGreen ; tokenId: BigNumber ; tokenUri: string }[]
handleCreateGreen	(phoneNumber: string, code: string) => Promise<VerifyGreenResult | undefined>
handleGenerateGreen	(phoneNumber: string) => Promise<GenerateGreenResult | undefined>
invalidateGreen	() => void
isGreensLoading	boolean
reloadGreens	() => void
status	string

---

UseNetworkInputValue

Ƭ UseNetworkInputValue: Object

Type declaration

Name	Type
provider?	Signer
useRainbowKitWalletConnect?	boolean

---

UseNetworkReturnValue

Ƭ UseNetworkReturnValue: Object

Type declaration

Name	Type
addNetwork	(networkDetails: Network) => void
currentNetwork?	Network
switchNetwork	(networkName: NetworkName) => void

---

UseWalletReturnType

Ƭ UseWalletReturnType: Object

Type declaration

Name	Type
error	unknown
hasWalletAddress	boolean
isWalletLoading	boolean
reloadWallet	() => Promise<unknown>
status	string
walletAddress?	string

Variables

MasaContext

• Const MasaContext: Context<MasaShape>

---

queryClient

• Const queryClient: QueryClient

Functions

MasaContextProvider

▸ MasaContextProvider(«destructured»): Element

Parameters

Name	Type
«destructured»	MasaContextProviderProps

Returns

Element

---

MasaInterface

▸ MasaInterface(«destructured»): Element

Parameters

Name	Type
«destructured»	Object
› disableMetamask?	boolean
› hideLegacyModal?	boolean

Returns

Element

---

MasaLoading

▸ MasaLoading(): Element

Returns

Element

---

MasaProvider

▸ MasaProvider(«destructured»): Element

Parameters

Name	Type
«destructured»	MasaContextProviderProps & { chainsToUse?: ("goerli" | "ethereum" | "alfajores" | "celo" | "mumbai" | "polygon" | "bsctest" | "bsc" | "basegoerli" | "unknown")[] ; contractAddressOverrides?: { SoulNameAddress: string ; SoulStoreAddress: string } ; rainbowKitModalSize?: "compact" | "wide" ; walletsToUse?: ("metamask" | "valora" | "walletconnect")[] }

Returns

Element

---

MasaRefactorProvider

▸ MasaRefactorProvider(«destructured»): Element

Parameters

Name	Type
«destructured»	Object
› children	ReactNode
› config	MasaReactConfig
› verbose?	boolean

Returns

Element

---

ModalComponent

▸ ModalComponent(«destructured»): Element

Parameters

Name	Type
«destructured»	ModalProps

Returns

Element

---

Spinner

▸ Spinner(«destructured»): Element

Parameters

Name	Type
«destructured»	SpinnerProps

Returns

Element

---

createNewMasa

▸ createNewMasa(«destructured»): undefined | Masa

Parameters

Name	Type
«destructured»	Object
› apiUrl?	string
› arweaveConfig?	ArweaveConfig
› contractAddressOverrides?	Object
› contractAddressOverrides.SoulNameAddress	string
› contractAddressOverrides.SoulStoreAddress	string
› environmentName	string
› networkName?	NetworkName
› signer	Signer
› verbose	boolean

Returns

undefined | Masa

---

getCreditScoresQueryKey

▸ getCreditScoresQueryKey(«destructured»): (undefined | string)[]

Parameters

Name	Type
«destructured»	Object
› masa?	Masa
› signer?	Signer
› walletAddress?	string

Returns

(undefined | string)[]

---

getGreenQueryKey

▸ getGreenQueryKey(«destructured»): (undefined | string)[]

Parameters

Name	Type
«destructured»	Object
› masa?	Masa
› signer?	Signer
› walletAddress?	string

Returns

(undefined | string)[]

---

getIdentityQueryKey

▸ getIdentityQueryKey(«destructured»): (undefined | string)[]

Parameters

Name	Type
«destructured»	Object
› masa?	Masa
› signer?	Signer
› walletAddress?	string

Returns

(undefined | string)[]

---

getSessionDataQueryKey

▸ getSessionDataQueryKey(«destructured»): (undefined | string)[]

Parameters

Name	Type
«destructured»	Object
› masa?	Masa
› signer?	Signer
› walletAddress?	string

Returns

(undefined | string)[]

---

getSessionQueryKey

▸ getSessionQueryKey(«destructured»): (undefined | string)[]

Parameters

Name	Type
«destructured»	Object
› masa?	Masa
› signer?	Signer
› walletAddress?	string

Returns

(undefined | string)[]

---

getSoulnamesQueryKey

▸ getSoulnamesQueryKey(«destructured»): (undefined | string)[]

Parameters

Name	Type
«destructured»	Object
› masa?	Masa
› signer?	Signer
› walletAddress?	string

Returns

(undefined | string)[]

---

getWalletQueryKey

▸ getWalletQueryKey(«destructured»): (undefined | string)[]

Parameters

Name	Type
«destructured»	Object
› masa?	Masa
› signer?	Signer
› walletAddress?	string

Returns

(undefined | string)[]

---

getWeb3Provider

▸ getWeb3Provider(): undefined | Web3Provider

Returns

undefined | Web3Provider

---

openAuthenticateModal

▸ openAuthenticateModal(«destructured»): Promise<unknown>

Parameters

Name	Type
«destructured»	AuthenticateProps

Returns

Promise<unknown>

---

openCreateSoulnameModal

▸ openCreateSoulnameModal(«destructured»): Promise<unknown>

Parameters

Name	Type
«destructured»	Object
› closeOnSuccess?	boolean
› onError?	() => void
› onMintError?	() => void
› onMintSuccess?	(result: CreateSoulNameResult) => void
› onRegisterFinish?	() => void
› onSuccess?	() => void

Returns

Promise<unknown>

---

useCreditScores

▸ useCreditScores(masa?, walletAddress?, identity?): UseCreditScoresReturnType

Parameters

Name	Type
masa?	Masa
walletAddress?	string
identity?	Object
identity.address?	string
identity.identityId?	BigNumber

Returns

UseCreditScoresReturnType

---

useCreditScoresQuery

▸ useCreditScoresQuery(«destructured»): Object

Parameters

Name	Type
«destructured»	Object
› identity?	Object
› identity.address?	string
› identity.identityId?	BigNumber
› masa?	Masa
› walletAddress?	string

Returns

Object

Name	Type
creditScores	undefined | { metadata?: ICreditScore ; tokenId: BigNumber ; tokenUri: string }[]
error	unknown
invalidateCreditScores	() => Promise<void>
isFetching	boolean
isLoading	boolean
reloadCreditScores	<TPageData>(options?: RefetchOptions & RefetchQueryFilters<TPageData>) => Promise<QueryObserverResult<undefined | { metadata?: ICreditScore ; tokenId: BigNumber ; tokenUri: string }[], unknown>>
status	"error" | "idle" | "loading" | "success"

---

useDebounce

▸ useDebounce(value, delay): string | number

Parameters

Name	Type
value	string | number
delay	number

Returns

string | number

---

useDebounceIfValue

▸ useDebounceIfValue(value, target, delay): string | number

Parameters

Name	Type
value	string | number
target	string | number
delay	number

Returns

string | number

---

useErrors

▸ useErrors(): Object

Returns

Object

Name	Type
SoulNameErrorCodes	typeof SoulNameErrorCodes
error	null | ErrorType
handleErrors	(errorCode: SoulNameErrorCodes) => void

---

useGreen

▸ useGreen(masa?, walletAddress?): UseGreenReturnValue

Parameters

Name	Type
masa?	Masa
walletAddress?	string

Returns

UseGreenReturnValue

---

useGreenQuery

▸ useGreenQuery(«destructured»): Object

Parameters

Name	Type
«destructured»	Object
› masa?	Masa
› walletAddress?	string

Returns

Object

Name	Type
error	unknown
greens	undefined | { metadata?: IGreen ; tokenId: BigNumber ; tokenUri: string }[]
invalidateGreen	() => Promise<void>
isFetching	boolean
isLoading	boolean
reloadGreens	<TPageData>(options?: RefetchOptions & RefetchQueryFilters<TPageData>) => Promise<QueryObserverResult<undefined | { metadata?: IGreen ; tokenId: BigNumber ; tokenUri: string }[], unknown>>
status	"error" | "idle" | "loading" | "success"

---

useIdentity

▸ useIdentity(masa?, walletAddress?): Object

Parameters

Name	Type
masa?	Masa
walletAddress?	string

Returns

Object

Name	Type
error	unknown
handlePurchaseIdentity	() => Promise<boolean>
handlePurchaseIdentityWithSoulname	(paymentMethod: PaymentMethod, soulname: string, registrationPeriod: number, style?: string) => Promise<boolean>
identity?	{ address?: string ; identityId?: BigNumber }
identity.address?	string
identity.identityId?	BigNumber
isIdentityLoading	boolean
reloadIdentity	() => Promise<unknown>
status	string

---

useIdentityQuery

▸ useIdentityQuery(«destructured»): Object

Parameters

Name	Type
«destructured»	Object
› masa?	Masa
› walletAddress?	string

Returns

Object

Name	Type
error	unknown
identity	undefined | { address?: string ; identityId?: BigNumber }
invalidateIdentity	() => Promise<void>
invalidateSoulnames	() => Promise<void>
isFetching	boolean
isLoading	boolean
reloadIdentity	<TPageData>(options?: RefetchOptions & RefetchQueryFilters<TPageData>) => Promise<QueryObserverResult<undefined | { address?: string ; identityId?: BigNumber }, unknown>>
status	"error" | "idle" | "loading" | "success"

---

useLocalStorage

▸ useLocalStorage(): Object

Returns

Object

Name	Type
localStorageGet	<T>(key: string) => undefined | T
localStorageSet	<T>(key: string, value: T) => void

---

useMasa

▸ useMasa(): MasaShape

Returns

MasaShape

---

useMetamask

▸ useMetamask(«destructured»): Object

Parameters

Name	Type
«destructured»	Object
› disabled?	boolean

Returns

Object

Name	Type
connectMetamask	() => void

---

useModal

▸ useModal(isLoggedIn?, isConnected?, areScopesFullfiled?): Object

Parameters

Name	Type
isLoggedIn?	boolean
isConnected?	boolean
areScopesFullfiled?	boolean

Returns

Object

Name	Type
closeModal	(forceCallback?: boolean) => void
forcedPage	null | string
isModalOpen	boolean
modalCallback	null | () => void
modalSize	null | { height: number ; width: number }
openGallery	(callback?: () => void) => void
openMintMasaGreen	(mintCallback?: () => void) => void
openMintSoulnameModal	(mintCallback?: () => void) => void
setForcedPage?	(page: null | string) => void
setModalCallback	(callback: () => void) => void
setModalOpen	(modalOpen: boolean) => void
setModalSize	(size: { height: number ; width: number }) => void
useModalSize	(size: { height: number ; width: number }) => void

---

useNetwork

▸ useNetwork(«destructured»): UseNetworkReturnValue

Parameters

Name	Type
«destructured»	UseNetworkInputValue

Returns

UseNetworkReturnValue

---

useNetworkSwitch

▸ useNetworkSwitch(): Object

Returns

Object

Name	Type
canProgramaticallySwitchNetwork	boolean
currentNetwork	GetNetworkResult
switchNetwork	(forcedNetworkParam: NetworkName) => void

---

useSBT

▸ useSBT(«destructured»): Object

Parameters

Name	Type
«destructured»	Object
› masa?	Masa
› tokenAddress	string
› walletAddress?	string

Returns

Object

Name	Type
SBTs?	{ tokenId: BigNumber ; tokenUri: string }[]
error	unknown
isSBTLoading	boolean
reloadSBTs	() => void
status	string

---

useSession

▸ useSession(masa?, walletAddress?): Object

Parameters

Name	Type
masa?	Masa
walletAddress?	string

Returns

Object

Name	Type
error	unknown
handleLogin	() => Promise<void>
handleLogout	(logoutCallback?: () => void) => Promise<void>
isLoggedIn	undefined | boolean
isSessionLoading	boolean
reloadSession	<TPageData>(options?: RefetchOptions & RefetchQueryFilters<TPageData>) => Promise<QueryObserverResult<undefined | boolean, unknown>>
reloadSessionData	<TPageData>(options?: RefetchOptions & RefetchQueryFilters<TPageData>) => Promise<QueryObserverResult<undefined | ISession, unknown>>
status	"error" | "idle" | "loading" | "success"

---

useSessionDataQuery

▸ useSessionDataQuery(«destructured»): Object

Parameters

Name	Type
«destructured»	Object
› masa?	Masa
› walletAddress?	string

Returns

Object

Name	Type
isSessionDataFetching	boolean
isSessionDataLoading	boolean
reloadSessionData	<TPageData>(options?: RefetchOptions & RefetchQueryFilters<TPageData>) => Promise<QueryObserverResult<undefined | ISession, unknown>>
sessionData	undefined | ISession

---

useSessionQuery

▸ useSessionQuery(«destructured»): Object

Parameters

Name	Type
«destructured»	Object
› masa?	Masa
› walletAddress?	string

Returns

Object

Name	Type
error	unknown
isLoggedIn	undefined | boolean
isSessionCheckFetching	boolean
isSessionCheckLoading	boolean
reloadSession	<TPageData>(options?: RefetchOptions & RefetchQueryFilters<TPageData>) => Promise<QueryObserverResult<undefined | boolean, unknown>>
status	"error" | "idle" | "loading" | "success"

---

useSoulnames

▸ useSoulnames(masa?, walletAddress?): Object

Parameters

Name	Type
masa?	Masa
walletAddress?	string

Returns

Object

Name	Type
error	unknown
handlePurchaseSoulname	(soulname: string, registrationPeriod: number, paymentMethod: PaymentMethod, style?: string) => Promise<boolean>
isSoulnamesLoading	boolean
reloadSoulnames	() => void
soulnames?	string[]
status	string

---

useSoulnamesQuery

▸ useSoulnamesQuery(«destructured»): Object

Parameters

Name	Type
«destructured»	Object
› masa?	Masa
› walletAddress?	string

Returns

Object

Name	Type
error	unknown
isFetching	boolean
isLoading	boolean
reloadSoulnames	<TPageData>(options?: RefetchOptions & RefetchQueryFilters<TPageData>) => Promise<QueryObserverResult<undefined | string[], unknown>>
soulnames	undefined | string[]
status	"error" | "idle" | "loading" | "success"

---

useWallet

▸ useWallet(masa?, signer?): UseWalletReturnType

Parameters

Name	Type
masa?	Masa
signer?	Signer

Returns

UseWalletReturnType

---

useWalletQuery

▸ useWalletQuery(«destructured»): Object

Parameters

Name	Type
«destructured»	Object
› masa?	Masa
› signer?	Signer
› walletAddress?	string

Returns

Object

Name	Type
error	unknown
invalidateIdentity	() => Promise<void>
isFetching	boolean
isLoading	boolean
refetch	<TPageData>(options?: RefetchOptions & RefetchQueryFilters<TPageData>) => Promise<QueryObserverResult<undefined | string, unknown>>
status	"error" | "idle" | "loading" | "success"
walletAddress	undefined | string