MasaShape.md

[# Masa React

• v3.1.4](../README.md) / Exports / MasaShape

Interface: MasaShape

Hierarchy

• MasaShape

  ↳ MasaContextProviderProps

Table of contents

Properties

• SupportedNetworks
• accountAddress
• areScopesFullfiled
• badges
• canProgramaticallySwitchNetwork
• children
• closeModal
• company
• connect
• creditScores
• currentNetwork
• currentNetworkNew
• customGallerySBT
• customSBTs
• forceNetwork
• forcedPage
• fullScreenGallery
• greens
• handleAddSBT
• handleCreateCreditScore
• handleCreateGreen
• handleGenerateGreen
• handleLogin
• handleLogout
• handlePurchaseIdentity
• handlePurchaseIdentityWithSoulname
• hasAccountAddress
• hasWalletAddress
• hideLegacyModal
• identity
• isConnected
• isCreditScoresLoading
• isDisconnected
• isGreensLoading
• isIdentityLoading
• isLoading
• isLoadingCustomSBTs
• isLoggedIn
• isModalOpen
• isSessionLoading
• isSoulnamesLoading
• isWalletLoading
• logout
• masa
• modalCallback
• modalSize
• openAccountModal
• openAuthenticateModal
• openChainModal
• openConnectModal
• openConnectedModal
• openCreateCreditScoreModal
• openCreateIdentityModal
• openCreateSoulnameModal
• openGallery
• openInterfaceMasaGreen
• openMintMasaGreen
• openMintSoulnameModal
• openSuccessCreateIdentityModal
• openSwitchChainModal
• purchaseSoulName
• refetchContracts
• reloadCreditScores
• reloadGreens
• reloadIdentity
• reloadSoulnames
• scope
• setForcedPage
• setModalOpen
• setRainbowkKitModalCallback
• setSigner
• signer
• soulNameStyle
• soulnames
• switchNetwork
• switchNetworkNew
• useModalSize
• useRainbowKit
• verbose
• walletAddress
• walletName

Properties

SupportedNetworks

• Optional SupportedNetworks: Partial<{ alfajores: Network ; base: Network ; basegoerli: Network ; bsc: Network ; bsctest: Network ; celo: Network ; ethereum: Network ; goerli: Network ; mumbai: Network ; opbnb: Network ; opbnbtest: Network ; polygon: Network ; unknown: Network }>

---

accountAddress

• Optional accountAddress: string

---

areScopesFullfiled

• Optional areScopesFullfiled: boolean

---

badges

• Optional badges: unknown[]

---

canProgramaticallySwitchNetwork

• Optional canProgramaticallySwitchNetwork: boolean

---

children

• Optional children: ReactNode

---

closeModal

• Optional closeModal: (forceCallback?: boolean) => void

Type declaration

▸ (forceCallback?): void

Parameters

Name	Type
forceCallback?	boolean

Returns

void

---

company

• Optional company: string

---

connect

• Optional connect: (options?: { callback?: () => void ; scope?: string[] }) => void

Type declaration

▸ (options?): void

Parameters

Name	Type
options?	Object
options.callback?	() => void
options.scope?	string[]

Returns

void

---

creditScores

• Optional creditScores: { metadata?: ICreditScore ; tokenId: BigNumber ; tokenUri: string }[]

---

currentNetwork

• Optional currentNetwork: Network

---

currentNetworkNew

• Optional currentNetworkNew: GetNetworkResult

---

customGallerySBT

• Optional customGallerySBT: CustomGallerySBT[]

---

customSBTs

• Optional customSBTs: CustomGallerySBT & MasaSBTWrapper<MasaSBT> & { tokens: { metadata?: { description: string ; image: string ; name: string } ; tokenId: BigNumber ; tokenUri: string }[] }[]

---

forceNetwork

• Optional forceNetwork: NetworkName

---

forcedPage

• Optional forcedPage: null | string

---

fullScreenGallery

• Optional fullScreenGallery: boolean

---

greens

• Optional greens: { metadata?: IGreen ; tokenId: BigNumber ; tokenUri: string }[]

---

handleAddSBT

• Optional handleAddSBT: (isCollection: boolean, name: string, address: string) => void

Type declaration

▸ (isCollection, name, address): void

Parameters

Name	Type
isCollection	boolean
name	string
address	string

Returns

void

---

handleCreateCreditScore

• Optional handleCreateCreditScore: () => Promise<undefined | boolean>

Type declaration

▸ (): Promise<undefined | boolean>

Returns

Promise<undefined | boolean>

---

handleCreateGreen

• Optional handleCreateGreen: (phoneNumber: string, code: string) => Promise<undefined | VerifyGreenResult>

Type declaration

▸ (phoneNumber, code): Promise<undefined | VerifyGreenResult>

Parameters

Name	Type
phoneNumber	string
code	string

Returns

Promise<undefined | VerifyGreenResult>

---

handleGenerateGreen

• Optional handleGenerateGreen: (phoneNumber: string) => Promise<undefined | GenerateGreenResult>

Type declaration

▸ (phoneNumber): Promise<undefined | GenerateGreenResult>

Parameters

Name	Type
phoneNumber	string

Returns

Promise<undefined | GenerateGreenResult>

---

handleLogin

• Optional handleLogin: () => void

Type declaration

▸ (): void

Returns

void

---

handleLogout

• Optional handleLogout: (logoutCallback?: () => void) => Promise<void>

Type declaration

▸ (logoutCallback?): Promise<void>

Parameters

Name	Type
logoutCallback?	() => void

Returns

Promise<void>

---

handlePurchaseIdentity

• Optional handlePurchaseIdentity: () => Promise<undefined | boolean | Error>

Type declaration

▸ (): Promise<undefined | boolean | Error>

Returns

Promise<undefined | boolean | Error>

---

handlePurchaseIdentityWithSoulname

• Optional handlePurchaseIdentityWithSoulname: (paymentMethod: PaymentMethod, soulname: string, registrationPeriod: number, style?: string) => Promise<undefined | Error | { identityId?: string | BigNumber } & CreateSoulNameResult>

Type declaration

▸ (paymentMethod, soulname, registrationPeriod, style?): Promise<undefined | Error | { identityId?: string | BigNumber } & CreateSoulNameResult>

Parameters

Name	Type
paymentMethod	PaymentMethod
soulname	string
registrationPeriod	number
style?	string

Returns

Promise<undefined | Error | { identityId?: string | BigNumber } & CreateSoulNameResult>

---

hasAccountAddress

• Optional hasAccountAddress: boolean

---

hasWalletAddress

• Optional hasWalletAddress: boolean

---

hideLegacyModal

• Optional hideLegacyModal: boolean

---

identity

• Optional identity: Object

Type declaration

Name	Type
address?	string
identityId?	BigNumber

---

isConnected

• Optional isConnected: boolean

---

isCreditScoresLoading

• Optional isCreditScoresLoading: boolean

---

isDisconnected

• Optional isDisconnected: boolean

---

isGreensLoading

• Optional isGreensLoading: boolean

---

isIdentityLoading

• Optional isIdentityLoading: boolean

---

isLoading

• Optional isLoading: boolean

---

isLoadingCustomSBTs

• Optional isLoadingCustomSBTs: boolean

---

isLoggedIn

• Optional isLoggedIn: boolean

---

isModalOpen

• Optional isModalOpen: boolean

---

isSessionLoading

• Optional isSessionLoading: boolean

---

isSoulnamesLoading

• Optional isSoulnamesLoading: boolean

---

isWalletLoading

• Optional isWalletLoading: boolean

---

logout

• Optional logout: () => Promise<boolean>

Type declaration

▸ (): Promise<boolean>

Returns

Promise<boolean>

---

masa

• Optional masa: Masa

---

modalCallback

• Optional modalCallback: null | () => void

---

modalSize

• Optional modalSize: null | { height: number ; width: number }

---

openAccountModal

• Optional openAccountModal: () => void

Type declaration

▸ (): void

Returns

void

---

openAuthenticateModal

• Optional openAuthenticateModal: () => void

Type declaration

▸ (): void

Returns

void

---

openChainModal

• Optional openChainModal: () => void

Type declaration

▸ (): void

Returns

void

---

openConnectModal

• Optional openConnectModal: () => void

Type declaration

▸ (): void

Returns

void

---

openConnectedModal

• Optional openConnectedModal: () => void

Type declaration

▸ (): void

Returns

void

---

openCreateCreditScoreModal

• Optional openCreateCreditScoreModal: () => void

Type declaration

▸ (): void

Returns

void

---

openCreateIdentityModal

• Optional openCreateIdentityModal: () => void

Type declaration

▸ (): void

Returns

void

---

openCreateSoulnameModal

• Optional openCreateSoulnameModal: () => void

Type declaration

▸ (): void

Returns

void

---

openGallery

• Optional openGallery: (callback?: () => void) => void

Type declaration

▸ (callback?): void

Parameters

Name	Type
callback?	() => void

Returns

void

---

openInterfaceMasaGreen

• Optional openInterfaceMasaGreen: () => void

Type declaration

▸ (): void

Returns

void

---

openMintMasaGreen

• Optional openMintMasaGreen: (callback?: () => void) => void

Type declaration

▸ (callback?): void

Parameters

Name	Type
callback?	() => void

Returns

void

---

openMintSoulnameModal

• Optional openMintSoulnameModal: (callback?: () => void) => void

Type declaration

▸ (callback?): void

Parameters

Name	Type
callback?	() => void

Returns

void

---

openSuccessCreateIdentityModal

• Optional openSuccessCreateIdentityModal: () => void

Type declaration

▸ (): void

Returns

void

---

openSwitchChainModal

• Optional openSwitchChainModal: () => void

Type declaration

▸ (): void

Returns

void

---

purchaseSoulName

• Optional purchaseSoulName: (soulname: string, registrationPeriod: number, paymentMethod: PaymentMethod, style?: string) => Promise<undefined | CreateSoulNameResult | Error & { code?: string }>

Type declaration

▸ (soulname, registrationPeriod, paymentMethod, style?): Promise<undefined | CreateSoulNameResult | Error & { code?: string }>

Parameters

Name	Type
soulname	string
registrationPeriod	number
paymentMethod	PaymentMethod
style?	string

Returns

Promise<undefined | CreateSoulNameResult | Error & { code?: string }>

---

refetchContracts

• Optional refetchContracts: () => void

Type declaration

▸ (): void

Returns

void

---

reloadCreditScores

• Optional reloadCreditScores: () => void

Type declaration

▸ (): void

Returns

void

---

reloadGreens

• Optional reloadGreens: () => void

Type declaration

▸ (): void

Returns

void

---

reloadIdentity

• Optional reloadIdentity: () => void

Type declaration

▸ (): void

Returns

void

---

reloadSoulnames

• Optional reloadSoulnames: () => void

Type declaration

▸ (): void

Returns

void

---

scope

• Optional scope: string[]

---

setForcedPage

• Optional setForcedPage: (page: null | string) => void

Type declaration

▸ (page): void

Parameters

Name	Type
page	null | string

Returns

void

---

setModalOpen

• Optional setModalOpen: (val: boolean) => void

Type declaration

▸ (val): void

Parameters

Name	Type
val	boolean

Returns

void

---

setRainbowkKitModalCallback

• Optional setRainbowkKitModalCallback: Dispatch<SetStateAction<undefined | (modalOpen?: boolean) => void>>

---

setSigner

• Optional setSigner: (signer?: Signer) => void

Type declaration

▸ (signer?): void

Parameters

Name	Type
signer?	Signer

Returns

void

---

signer

• Optional signer: Signer

---

soulNameStyle

• Optional soulNameStyle: string

---

soulnames

• Optional soulnames: SoulNameDetails[]

---

switchNetwork

• Optional switchNetwork: (networkName: NetworkName) => void

Type declaration

▸ (networkName): void

Parameters

Name	Type
networkName	NetworkName

Returns

void

---

switchNetworkNew

• Optional switchNetworkNew: (forcedNetworkParam: NetworkName) => void

Type declaration

▸ (forcedNetworkParam): void

Parameters

Name	Type
forcedNetworkParam	NetworkName

Returns

void

---

useModalSize

• Optional useModalSize: (size: { height: number ; width: number }) => void

Type declaration

▸ (size): void

Parameters

Name	Type
size	Object
size.height	number
size.width	number

Returns

void

---

useRainbowKit

• Optional useRainbowKit: boolean

---

verbose

• Optional verbose: boolean

---

walletAddress

• Optional walletAddress: string

---

walletName

• Optional walletName: string