modules.md

[# Masa React

• v1.0.29](README.md) / Exports

# Masa React

• v1.0.29

Table of contents

Interfaces

• ArweaveConfig
• MasaContextProviderProps
• MasaShape
• ModalProps
• Network
• SpinnerProps

Type Aliases

• EnvironmentNameEx

Variables

• MASA_CONTEXT
• SupportedNetworks
• queryClient

Functions

• MasaContextProvider
• MasaInterface
• MasaLoading
• MasaProvider
• ModalComponent
• Spinner
• createNewMasa
• getNetworkNameByChainId
• getWeb3Provider
• useCreditScores
• useDebounce
• useDebounceIfValue
• useGreen
• useIdentity
• useLocalStorage
• useMasa
• useMetamask
• useModal
• useNetwork
• useSession
• useSoulnames
• useWallet

Type Aliases

EnvironmentNameEx

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

Variables

MASA_CONTEXT

• Const MASA_CONTEXT: Context<MasaShape>

---

SupportedNetworks

• Const SupportedNetworks: Partial<{ [key in NetworkName]: Network }>

---

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

Returns

Element

---

MasaLoading

▸ MasaLoading(): Element

Returns

Element

---

MasaProvider

▸ MasaProvider(«destructured»): Element

Parameters

Name	Type
«destructured»	MasaContextProviderProps

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»): Promise<undefined | default>

Parameters

Name	Type
«destructured»	Object
› arweaveConfig?	ArweaveConfig
› environmentName	string
› networkName?	NetworkName
› signer	null | Signer
› verbose	boolean

Returns

Promise<undefined | default>

---

getNetworkNameByChainId

▸ getNetworkNameByChainId(chainId): NetworkName

Parameters

Name	Type
chainId	number

Returns

NetworkName

---

getWeb3Provider

▸ getWeb3Provider(): undefined | Web3Provider

Returns

undefined | Web3Provider

---

useCreditScores

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

Parameters

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

Returns

Object

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

---

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

---

useGreen

▸ useGreen(masa?, walletAddress?): Object

Parameters

Name	Type
masa?	default
walletAddress?	string

Returns

Object

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

---

useIdentity

▸ useIdentity(masa?, walletAddress?): Object

Parameters

Name	Type
masa?	default
walletAddress?	string

Returns

Object

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

---

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
openMintSoulnameModal	(mintCallback?: () => void) => void
setForcedPage?	(page: null | string) => void
setModalCallback	(callback: () => void) => void
setModalOpen	(modalOpen: boolean) => void

---

useNetwork

▸ useNetwork(provider?): Object

Parameters

Name	Type
provider?	Signer | Wallet

Returns

Object

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

---

useSession

▸ useSession(masa?, walletAddress?): Object

Parameters

Name	Type
masa?	default
walletAddress?	string

Returns

Object

Name	Type
error	unknown
handleLogin	() => void
handleLogout	(logoutCallback?: () => void) => void
isLoggedIn?	boolean
isSessionLoading	boolean
status	string

---

useSoulnames

▸ useSoulnames(masa?, walletAddress?): Object

Parameters

Name	Type
masa?	default
walletAddress?	string

Returns

Object

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

---

useWallet

▸ useWallet(masa?, provider?): Object

Parameters

Name	Type
masa?	default
provider?	Signer | Wallet

Returns

Object

Name	Type
error	unknown
hasWalletAddress	boolean
isWalletLoading	boolean
status	string
walletAddress	undefined | string