modules

[# Masa SDK

• v3.34.1](/docs/developers/sdk/) / Exports

# Masa SDK

• v3.34.1

Table of contents

Enumerations

• SoulNameErrorCodes

Classes

• ASBTContract
• ASBTContractWrapper
• ContractFactory
• CreditScore
• ERC20__factory
• Green
• Identity
• Marketplace
• Masa
• MasaASBT
• MasaASBTWrapper
• MasaAccount
• MasaArweave
• MasaClient
• MasaContracts
• MasaCreditScore
• MasaDynamicSBTBase
• MasaDynamicSBTWrapper
• MasaDynamicSSSBT
• MasaDynamicSSSBTWrapper
• MasaGreen
• MasaIdentity
• MasaMarketplace
• MasaSBTBase
• MasaSBTModuleBase
• MasaSBTWrapper
• MasaSSSBT
• MasaSSSBTWrapper
• MasaSession
• MasaSoulLinker
• MasaSoulName
• MasaToken
• SBTContract
• SBTContractWrapper
• SSSBTContract
• SSSBTContractWrapper
• SoulLinker
• SoulName
• StaticJsonRpcProvider

Interfaces

• Addresses
• ApprovalEventObject
• Attribute
• BaseResult
• BaseResultWithTokenId
• ChallengeResult
• ChallengeResultWithCookie
• ContractInfo
• CreateSoulNameResult
• CreditScoreDetails
• DeployResult
• ERC20
• ERC20Interface
• GenerateCreditScoreResult
• GenerateGreenResult
• GreenBaseResult
• GreenDetails
• ICreditScore
• IGreen
• IIdentity
• IIdentityContracts
• IMarketplaceContracts
• IPassport
• ISession
• ISoulName
• IdentityDetails
• LoginResult
• LogoutResult
• MasaArgs
• MasaConfig
• MasaInterface
• Network
• PriceInformation
• QuoteResult
• SessionUser
• SoulNameDetails
• SoulNameMetadataStoreResult
• SoulNameResultBase
• SwapResult
• TransferEventObject
• UpdateCreditScoreResult
• User
• VerifyGreenResult

Type Aliases

• ApprovalEvent
• ApprovalEventFilter
• BalanceTypes
• Balances
• BreakLinkResult
• CreateLinkResult
• ERC20Currencies
• Environment
• EnvironmentName
• EstablishLinkResult
• Link
• ListLinksResult
• NativeCurrencies
• NetworkName
• PaymentMethod
• QueryLinkResult
• SBTContractNames
• Tokens
• TransferEvent
• TransferEventFilter
• VerifyLinkResult

Variables

• Messages
• SupportedNetworks
• Templates
• addresses
• alfajores
• amoy
• base
• basegoerli
• basesepolia
• bsc
• bsctest
• celo
• environments
• erc20Currencies
• ethereum
• goerli
• mumbai
• nativeCurrencies
• polygon
• sepolia

Functions

• burnIdentity
• burnSoulName
• calculateSoulNameLength
• checkExists
• checkLogin
• claimAllRewards
• createCreditScore
• createGreen
• createIdentity
• createIdentityWithSoulName
• createLink
• createSoulName
• deployASBT
• deploySSSBT
• deposit
• establishLink
• establishLinkFromPassport
• generateGreen
• generateSignatureDomain
• getBalances
• getNetworkNameByChainId
• getSession
• getSoulNameMetadataPrefix
• getSwapParameters
• getSwapQuote
• isBigNumber
• isERC20Currency
• isNativeCurrency
• isSession
• isSoulNameMetadataStoreResult
• listCreditScores
• listCreditScoresAndPrint
• listGreens
• listGreensAndPrint
• listLinks
• listSoulNames
• listSoulNamesAndPrint
• loadCreditScoreDetails
• loadCreditScores
• loadGreenDetails
• loadGreens
• loadIdentity
• loadIdentityByAddress
• loadIdentityContracts
• loadIdentityDetails
• loadLinks
• loadMarketplaceContracts
• loadOFTContract
• loadSoulNameByName
• loadSoulNameByTokenId
• loadSoulNameDetailsByAddress
• loadSoulNames
• loadSoulNamesByNames
• loadSoulNamesWithExpired
• login
• logout
• mintGreen
• parsePassport
• patchMetadataUrl
• printSoulName
• purchaseIdentity
• purchaseIdentityWithSoulName
• queryLink
• queryLinkFromPassport
• recoverAddress
• renewSoulName
• resolveIdentity
• resolveReverseIdentity
• resolveSoulName
• sendSoulName
• showIdentity
• signMessage
• signTypedData
• stakeAll
• swap
• tailSoulNames
• tailSoulNamesAndPrint
• unpackSessionId
• validateSoulName
• verifyByName
• verifyGreen
• verifyLink
• version
• withdraw

Type Aliases

ApprovalEvent

Ƭ ApprovalEvent: TypedEvent\<[string, string, BigNumber], ApprovalEventObject>

---

ApprovalEventFilter

Ƭ ApprovalEventFilter: TypedEventFilter\<ApprovalEvent>

---

BalanceTypes

Ƭ BalanceTypes: "Native" | PaymentMethod | SBTContractNames

---

Balances

Ƭ Balances: Partial\<{ [index in BalanceTypes]: number | undefined }>

---

BreakLinkResult

Ƭ BreakLinkResult: BaseResult

---

CreateLinkResult

Ƭ CreateLinkResult: BaseResult & { passport?: string }

---

ERC20Currencies

Ƭ ERC20Currencies: typeof erc20Currencies[number]

---

Environment

Ƭ Environment: { wallet?: Signer } & MasaArgs

---

EnvironmentName

Ƭ EnvironmentName: "local" | "dev" | "stage" | "production"

---

EstablishLinkResult

Ƭ EstablishLinkResult: BaseResult

---

Link

Ƭ Link: Object

Type declaration

Name	Type
exists	boolean
expirationDate	BigNumber
isRevoked	boolean
ownerIdentityId	BigNumber
readerIdentityId	BigNumber
signatureDate	BigNumber

---

ListLinksResult

Ƭ ListLinksResult: BaseResult & { links: Link[] }

---

NativeCurrencies

Ƭ NativeCurrencies: typeof nativeCurrencies[number]

---

NetworkName

Ƭ NetworkName: "masatest" | "masa" | "goerli" | "sepolia" | "ethereum" | "alfajores" | "celo" | "mumbai" | "amoy" | "polygon" | "bsctest" | "bsc" | "opbnbtest" | "opbnb" | "basegoerli" | "basesepolia" | "base" | "scrollsepolia" | "scroll" | "unknown"

---

PaymentMethod

Ƭ PaymentMethod: NativeCurrencies | ERC20Currencies

---

QueryLinkResult

Ƭ QueryLinkResult: BaseResult

---

SBTContractNames

Ƭ SBTContractNames: "Identity" | "SoulName" | "Green" | "CreditScore"

---

Tokens

Ƭ Tokens: Partial\<{ [key in PaymentMethod]: string }>

---

TransferEvent

Ƭ TransferEvent: TypedEvent\<[string, string, BigNumber], TransferEventObject>

---

TransferEventFilter

Ƭ TransferEventFilter: TypedEventFilter\<TransferEvent>

---

VerifyLinkResult

Ƭ VerifyLinkResult: BaseResult & { verified?: boolean }

Variables

Messages

• Const Messages: Object

Type declaration

Name	Type
ContractNotDeployed	(networkName: NetworkName) => string
NoIdentity	(address?: string) => string
NotLoggedIn	() => string
WaitingToFinalize	(txHash: string, explorerUrl?: string) => string

---

SupportedNetworks

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

---

Templates

• Const Templates: Object

Type declaration

Name	Type	Description
loginTemplate	(challenge: string, expires: string) => string	-

---

addresses

• Const addresses: Partial\<{ [key in NetworkName]: Addresses }>

---

alfajores

• Const alfajores: Addresses

---

amoy

• Const amoy: Addresses

---

base

• Const base: Addresses

---

basegoerli

• Const basegoerli: Addresses

---

basesepolia

• Const basesepolia: Addresses

---

bsc

• Const bsc: Addresses

---

bsctest

• Const bsctest: Addresses

---

celo

• Const celo: Addresses

---

environments

• Const environments: Environment[]

---

erc20Currencies

• Const erc20Currencies: readonly ["MASA", "WETH", "G$", "USDC", "cUSD"]

---

ethereum

• Const ethereum: Addresses

---

goerli

• Const goerli: Addresses

---

mumbai

• Const mumbai: Addresses

---

nativeCurrencies

• Const nativeCurrencies: readonly ["ETH", "CELO", "MATIC", "BNB"]

---

polygon

• Const polygon: Addresses

---

sepolia

• Const sepolia: Addresses

Functions

burnIdentity

▸ burnIdentity(masa): Promise\<BaseResult>

Parameters

Name	Type
masa	MasaInterface

Returns

Promise\<BaseResult>

---

burnSoulName

▸ burnSoulName(masa, soulName): Promise\<BaseResult>

Parameters

Name	Type
masa	MasaInterface
soulName	string

Returns

Promise\<BaseResult>

---

calculateSoulNameLength

▸ calculateSoulNameLength(soulName): number

Parameters

Name	Type
soulName	string

Returns

number

---

checkExists

▸ checkExists(address, signer): Promise\<boolean>

Parameters

Name	Type
address	string
signer	Signer

Returns

Promise\<boolean>

---

checkLogin

▸ checkLogin(masa): Promise\<boolean>

Parameters

Name	Type
masa	MasaInterface

Returns

Promise\<boolean>

---

claimAllRewards

▸ claimAllRewards(masa): Promise\<BaseResult>

Parameters

Name	Type
masa	MasaInterface

Returns

Promise\<BaseResult>

---

createCreditScore

▸ createCreditScore(masa, paymentMethod): Promise\<GenerateCreditScoreResult>

Parameters

Name	Type
masa	MasaInterface
paymentMethod	PaymentMethod

Returns

Promise\<GenerateCreditScoreResult>

---

createGreen

▸ createGreen(masa, paymentMethod, phoneNumber, code): Promise\<GreenBaseResult>

Parameters

Name	Type
masa	MasaInterface
paymentMethod	PaymentMethod
phoneNumber	string
code	string

Returns

Promise\<GreenBaseResult>

---

createIdentity

▸ createIdentity(masa): Promise\<BaseResultWithTokenId>

Parameters

Name	Type
masa	MasaInterface

Returns

Promise\<BaseResultWithTokenId>

---

createIdentityWithSoulName

▸ createIdentityWithSoulName(masa, paymentMethod, soulName, duration, style?): Promise\<{ identityId?: string | BigNumber } & CreateSoulNameResult>

Parameters

Name	Type
masa	MasaInterface
paymentMethod	PaymentMethod
soulName	string
duration	number
style?	string

Returns

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

---

createLink

▸ createLink(masa, contract, tokenId, readerIdentityId): Promise\<CreateLinkResult>

Parameters

Name	Type
masa	MasaInterface
contract	Contract
tokenId	BigNumber
readerIdentityId	BigNumber

Returns

Promise\<CreateLinkResult>

---

createSoulName

▸ createSoulName(masa, paymentMethod, soulName, duration, receiver?, style?): Promise\<CreateSoulNameResult>

Parameters

Name	Type
masa	MasaInterface
paymentMethod	PaymentMethod
soulName	string
duration	number
receiver?	string
style?	string

Returns

Promise\<CreateSoulNameResult>

---

deployASBT

▸ deployASBT(«destructured»): Promise\<undefined | DeployResult\<PaymentParamsStruct>>

Parameters

Name	Type	Default value
«destructured»	Object	undefined
› adminAddress?	string	undefined
› baseTokenUri	string	undefined
› limit?	number	1
› masa	MasaInterface	undefined
› name	string	undefined
› paymentOptions?	Object	undefined
› paymentOptions.projectFeeReceiver	string	undefined
› symbol	string	undefined

Returns

Promise\<undefined | DeployResult\<PaymentParamsStruct>>

---

deploySSSBT

▸ deploySSSBT(«destructured»): Promise\<undefined | DeployResult\<PaymentParamsStruct>>

Parameters

Name	Type	Default value
«destructured»	Object	undefined
› adminAddress?	string	undefined
› authorityAddress?	string	undefined
› baseTokenUri	string	undefined
› limit	number	1
› masa	MasaInterface	undefined
› name	string	undefined
› paymentOptions?	Object	undefined
› paymentOptions.projectFeeReceiver	string	undefined
› symbol	string	undefined

Returns

Promise\<undefined | DeployResult\<PaymentParamsStruct>>

---

deposit

▸ deposit(masa, amount): Promise\<BaseResult>

Parameters

Name	Type
masa	MasaInterface
amount	string

Returns

Promise\<BaseResult>

---

establishLink

▸ establishLink(masa, paymentMethod, contract, tokenId, readerIdentityId, signature, signatureDate, expirationDate): Promise\<BaseResult>

Parameters

Name	Type
masa	MasaInterface
paymentMethod	PaymentMethod
contract	Contract
tokenId	BigNumber
readerIdentityId	BigNumber
signature	string
signatureDate	number
expirationDate	number

Returns

Promise\<BaseResult>

---

establishLinkFromPassport

▸ establishLinkFromPassport(masa, paymentMethod, contract, passport): Promise\<BaseResult>

Parameters

Name	Type
masa	MasaInterface
paymentMethod	PaymentMethod
contract	Contract
passport	string

Returns

Promise\<BaseResult>

---

generateGreen

▸ generateGreen(masa, phoneNumber): Promise\<GenerateGreenResult>

Parameters

Name	Type
masa	MasaInterface
phoneNumber	string

Returns

Promise\<GenerateGreenResult>

---

generateSignatureDomain

▸ generateSignatureDomain(signer, name, verifyingContract, version?): Promise\<TypedDataDomain>

Parameters

Name	Type	Default value
signer	Signer	undefined
name	string	undefined
verifyingContract	string	undefined
version	string	"1.0.0"

Returns

Promise\<TypedDataDomain>

---

getBalances

▸ getBalances(masa, address?): Promise\<Partial\<{ BNB: undefined | number ; CELO: undefined | number ; CreditScore: undefined | number ; ETH: undefined | number ; G$: undefined | number ; Green: undefined | number ; Identity: undefined | number ; MASA: undefined | number ; MATIC: undefined | number ; Native: undefined | number ; SoulName: undefined | number ; USDC: undefined | number ; WETH: undefined | number ; cUSD: undefined | number }>>

Parameters

Name	Type
masa	MasaInterface
address?	string

Returns

Promise\<Partial\<{ BNB: undefined | number ; CELO: undefined | number ; CreditScore: undefined | number ; ETH: undefined | number ; G$: undefined | number ; Green: undefined | number ; Identity: undefined | number ; MASA: undefined | number ; MATIC: undefined | number ; Native: undefined | number ; SoulName: undefined | number ; USDC: undefined | number ; WETH: undefined | number ; cUSD: undefined | number }>>

---

getNetworkNameByChainId

▸ getNetworkNameByChainId(chainId): NetworkName

Parameters

Name	Type
chainId	number

Returns

NetworkName

---

getSession

▸ getSession(masa): Promise\<undefined | ISession>

Parameters

Name	Type
masa	MasaInterface

Returns

Promise\<undefined | ISession>

---

getSoulNameMetadataPrefix

▸ getSoulNameMetadataPrefix(masa): string

try to evaluate the right prefix

Parameters

Name	Type
masa	MasaInterface

Returns

string

---

getSwapParameters

▸ getSwapParameters(eid, receiverAddress, tokenAmount, slippage?): Object

Parameters

Name	Type	Default value
eid	EndpointId	undefined
receiverAddress	string	undefined
tokenAmount	BigNumber	undefined
slippage	number	250

Returns

Object

Name	Type
sendParameters	SendParamStruct | SendParamStruct | SendParamStruct
slippage	number

---

getSwapQuote

▸ getSwapQuote(masa, sendParameters): Promise\<BaseResult | QuoteResult>

Parameters

Name	Type
masa	MasaInterface
sendParameters	SendParamStruct | SendParamStruct | SendParamStruct

Returns

Promise\<BaseResult | QuoteResult>

---

isBigNumber

▸ isBigNumber(item): item is BigNumber

Parameters

Name	Type
item	string | BigNumber

Returns

item is BigNumber

---

isERC20Currency

▸ isERC20Currency(paymentMethod): paymentMethod is "MASA" | "WETH" | "G$" | "USDC" | "cUSD"

Parameters

Name	Type
paymentMethod	unknown

Returns

paymentMethod is "MASA" | "WETH" | "G$" | "USDC" | "cUSD"

---

isNativeCurrency

▸ isNativeCurrency(paymentMethod): paymentMethod is "ETH" | "CELO" | "MATIC" | "BNB"

Parameters

Name	Type
paymentMethod	unknown

Returns

paymentMethod is "ETH" | "CELO" | "MATIC" | "BNB"

---

isSession

▸ isSession(session): session is ISession

Parameters

Name	Type
session	unknown

Returns

session is ISession

---

isSoulNameMetadataStoreResult

▸ isSoulNameMetadataStoreResult(result): result is SoulNameMetadataStoreResult

Parameters

Name	Type
result	SoulNameResultBase

Returns

result is SoulNameMetadataStoreResult

---

listCreditScores

▸ listCreditScores(masa, address?): Promise\<CreditScoreDetails[]>

Parameters

Name	Type
masa	MasaInterface
address?	string

Returns

Promise\<CreditScoreDetails[]>

---

listCreditScoresAndPrint

▸ listCreditScoresAndPrint(masa, address?): Promise\<CreditScoreDetails[]>

Parameters

Name	Type
masa	MasaInterface
address?	string

Returns

Promise\<CreditScoreDetails[]>

---

listGreens

▸ listGreens(masa, address?): Promise\<GreenDetails[]>

Parameters

Name	Type
masa	MasaInterface
address?	string

Returns

Promise\<GreenDetails[]>

---

listGreensAndPrint

▸ listGreensAndPrint(masa, address?): Promise\<GreenDetails[]>

Parameters

Name	Type
masa	MasaInterface
address?	string

Returns

Promise\<GreenDetails[]>

---

listLinks

▸ listLinks(masa, contract, tokenId): Promise\<ListLinksResult>

Parameters

Name	Type
masa	MasaInterface
contract	Contract
tokenId	BigNumber

Returns

Promise\<ListLinksResult>

---

listSoulNames

▸ listSoulNames(masa, address?): Promise\<SoulNameDetails[]>

list soul names

Parameters

Name	Type
masa	MasaInterface
address?	string

Returns

Promise\<SoulNameDetails[]>

---

listSoulNamesAndPrint

▸ listSoulNamesAndPrint(masa, address?): Promise\<SoulNameDetails[]>

list soul names and print them

Parameters

Name	Type
masa	MasaInterface
address?	string

Returns

Promise\<SoulNameDetails[]>

---

loadCreditScoreDetails

▸ loadCreditScoreDetails(masa, creditScoreIds): Promise\<CreditScoreDetails[]>

Parameters

Name	Type
masa	MasaInterface
creditScoreIds	BigNumber[]

Returns

Promise\<CreditScoreDetails[]>

---

loadCreditScores

▸ loadCreditScores(masa, identityIdOrAddress): Promise\<CreditScoreDetails[]>

Parameters

Name	Type
masa	MasaInterface
identityIdOrAddress	string | BigNumber

Returns

Promise\<CreditScoreDetails[]>

---

loadGreenDetails

▸ loadGreenDetails(masa, greenIds): Promise\<GreenDetails[]>

Parameters

Name	Type
masa	MasaInterface
greenIds	BigNumber[]

Returns

Promise\<GreenDetails[]>

---

loadGreens

▸ loadGreens(masa, identityIdOrAddress): Promise\<GreenDetails[]>

Parameters

Name	Type
masa	MasaInterface
identityIdOrAddress	string | BigNumber

Returns

Promise\<GreenDetails[]>

---

loadIdentity

▸ loadIdentity(masa, address?): Promise\<undefined | IdentityDetails>

Parameters

Name	Type
masa	MasaInterface
address?	string

Returns

Promise\<undefined | IdentityDetails>

---

loadIdentityByAddress

▸ loadIdentityByAddress(masa, address?): Promise\<{ address: string ; identityId?: BigNumber }>

Parameters

Name	Type
masa	MasaInterface
address?	string

Returns

Promise\<{ address: string ; identityId?: BigNumber }>

---

loadIdentityContracts

▸ loadIdentityContracts(«destructured»): IIdentityContracts

Parameters

Name	Type	Default value
«destructured»	Object	undefined
› networkName?	NetworkName	"ethereum"
› signer	Signer	undefined

Returns

IIdentityContracts

---

loadIdentityDetails

▸ loadIdentityDetails(masa, identityIdOrAddress): Promise\<IdentityDetails>

Parameters

Name	Type
masa	MasaInterface
identityIdOrAddress	string | BigNumber

Returns

Promise\<IdentityDetails>

---

loadLinks

▸ loadLinks(masa, contract, tokenId): Promise\<Link[]>

Parameters

Name	Type
masa	MasaInterface
contract	Contract
tokenId	BigNumber

Returns

Promise\<Link[]>

---

loadMarketplaceContracts

▸ loadMarketplaceContracts(«destructured»): IMarketplaceContracts

Parameters

Name	Type	Default value
«destructured»	Object	undefined
› networkName?	NetworkName	"ethereum"
› signer	Signer	undefined

Returns

IMarketplaceContracts

---

loadOFTContract

▸ loadOFTContract(masa): undefined | MasaTokenNativeOFT | MasaToken | MasaTokenOFT

Parameters

Name	Type
masa	MasaInterface

Returns

undefined | MasaTokenNativeOFT | MasaToken | MasaTokenOFT

---

loadSoulNameByName

▸ loadSoulNameByName(masa, soulName): Promise\<undefined | SoulNameDetails>

Parameters

Name	Type
masa	MasaInterface
soulName	string

Returns

Promise\<undefined | SoulNameDetails>

---

loadSoulNameByTokenId

▸ loadSoulNameByTokenId(masa, tokenId): Promise\<undefined | SoulNameDetails>

Parameters

Name	Type
masa	MasaInterface
tokenId	string | BigNumber

Returns

Promise\<undefined | SoulNameDetails>

---

loadSoulNameDetailsByAddress

▸ loadSoulNameDetailsByAddress(masa, address): Promise\<SoulNameDetails[]>

Parameters

Name	Type
masa	MasaInterface
address	string

Returns

Promise\<SoulNameDetails[]>

---

loadSoulNames

▸ loadSoulNames(masa, identityIdOrAddress): Promise\<string[]>

loads active soul names

Parameters

Name	Type
masa	MasaInterface
identityIdOrAddress	string | BigNumber

Returns

Promise\<string[]>

---

loadSoulNamesByNames

▸ loadSoulNamesByNames(masa, soulNames): Promise\<SoulNameDetails[]>

Parameters

Name	Type
masa	MasaInterface
soulNames	string[]

Returns

Promise\<SoulNameDetails[]>

---

loadSoulNamesWithExpired

▸ loadSoulNamesWithExpired(masa, identityIdOrAddress): Promise\<string[]>

loads all soul names even expired ones

Parameters

Name	Type
masa	MasaInterface
identityIdOrAddress	string | BigNumber

Returns

Promise\<string[]>

---

login

▸ login(masa): Promise\<LoginResult>

Parameters

Name	Type
masa	MasaInterface

Returns

Promise\<LoginResult>

---

logout

▸ logout(masa): Promise\<undefined | { status: string }>

Parameters

Name	Type
masa	MasaInterface

Returns

Promise\<undefined | { status: string }>

---

mintGreen

▸ mintGreen(masa, paymentMethod, authorityAddress, signatureDate, signature): Promise\<BaseResultWithTokenId>

Parameters

Name	Type
masa	MasaInterface
paymentMethod	PaymentMethod
authorityAddress	string
signatureDate	number
signature	string

Returns

Promise\<BaseResultWithTokenId>

---

parsePassport

▸ parsePassport(passportEncoded): IPassport

Parameters

Name	Type
passportEncoded	string

Returns

IPassport

---

patchMetadataUrl

▸ patchMetadataUrl(masa, metadataUrl): string

todo: fix this thing, its not good

Parameters

Name	Type
masa	MasaInterface
metadataUrl	string

Returns

string

---

printSoulName

▸ printSoulName(soulName, index?, verbose?): void

Parameters

Name	Type	Default value
soulName	SoulNameDetails	undefined
index?	number	undefined
verbose	boolean	false

Returns

void

---

purchaseIdentity

▸ purchaseIdentity(masa): Promise\<BaseResultWithTokenId>

Identity only

Parameters

Name	Type
masa	MasaInterface

Returns

Promise\<BaseResultWithTokenId>

---

purchaseIdentityWithSoulName

▸ purchaseIdentityWithSoulName(masa, soulName, soulNameLength, duration, paymentMethod, style?): Promise\<{ identityId?: string | BigNumber } & CreateSoulNameResult>

Identity with soul name

Parameters

Name	Type
masa	MasaInterface
soulName	string
soulNameLength	number
duration	number
paymentMethod	PaymentMethod
style?	string

Returns

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

---

queryLink

▸ queryLink(masa, contract, paymentMethod, tokenId, readerIdentityId, signature, signatureDate, expirationDate): Promise\<BaseResult>

Parameters

Name	Type
masa	MasaInterface
contract	Contract
paymentMethod	PaymentMethod
tokenId	BigNumber
readerIdentityId	BigNumber
signature	string
signatureDate	number
expirationDate	number

Returns

Promise\<BaseResult>

---

queryLinkFromPassport

▸ queryLinkFromPassport(masa, paymentMethod, contract, passport): Promise\<BaseResult>

Parameters

Name	Type
masa	MasaInterface
paymentMethod	PaymentMethod
contract	Contract
passport	string

Returns

Promise\<BaseResult>

---

recoverAddress

▸ recoverAddress(msg, signature, doHash?): undefined | string

Parameters

Name	Type	Default value
msg	string	undefined
signature	string	undefined
doHash	boolean	false

Returns

undefined | string

---

renewSoulName

▸ renewSoulName(masa, soulName, years): Promise\<BaseResult>

Parameters

Name	Type
masa	MasaInterface
soulName	string
years	number

Returns

Promise\<BaseResult>

---

resolveIdentity

▸ resolveIdentity(masa, identityId): Promise\<undefined | string>

Resolves identity id into address

Parameters

Name	Type
masa	MasaInterface
identityId	BigNumber

Returns

Promise\<undefined | string>

---

resolveReverseIdentity

▸ resolveReverseIdentity(masa, address): Promise\<undefined | BigNumber>

Parameters

Name	Type
masa	MasaInterface
address	string

Returns

Promise\<undefined | BigNumber>

---

resolveSoulName

▸ resolveSoulName(masa, soulName): Promise\<undefined | string>

Parameters

Name	Type
masa	MasaInterface
soulName	string

Returns

Promise\<undefined | string>

---

sendSoulName

▸ sendSoulName(masa, soulName, receiver): Promise\<BaseResult>

Parameters

Name	Type
masa	MasaInterface
soulName	string
receiver	string

Returns

Promise\<BaseResult>

---

showIdentity

▸ showIdentity(masa, address?): Promise\<undefined | IdentityDetails>

Parameters

Name	Type
masa	MasaInterface
address?	string

Returns

Promise\<undefined | IdentityDetails>

---

signMessage

▸ signMessage(msg, signer, doHash?): Promise\<undefined | string>

Parameters

Name	Type	Default value
msg	string	undefined
signer	Signer	undefined
doHash	boolean	false

Returns

Promise\<undefined | string>

---

signTypedData

▸ signTypedData(«destructured»): Promise\<{ domain: TypedDataDomain ; signature: string }>

Parameters

Name	Type
«destructured»	Object
› contract	BaseContract | EIP712
› name?	string
› signer	Signer
› types	Record\<string, TypedDataField[]>
› value	Record\<string, string | number | boolean | BigNumber>

Returns

Promise\<{ domain: TypedDataDomain ; signature: string }>

---

stakeAll

▸ stakeAll(masa): Promise\<BaseResult>

Parameters

Name	Type
masa	MasaInterface

Returns

Promise\<BaseResult>

---

swap

▸ swap(masa, to, amount, slippage?): Promise\<SwapResult>

Parameters

Name	Type
masa	MasaInterface
to	NetworkName
amount	string
slippage?	number

Returns

Promise\<SwapResult>

---

tailSoulNames

▸ tailSoulNames(masa, limit?): Promise\<SoulNameDetails[]>

Parameters

Name	Type	Default value
masa	MasaInterface	undefined
limit	number	5

Returns

Promise\<SoulNameDetails[]>

---

tailSoulNamesAndPrint

▸ tailSoulNamesAndPrint(masa, limit?): Promise\<SoulNameDetails[]>

Parameters

Name	Type	Default value
masa	MasaInterface	undefined
limit	number	5

Returns

Promise\<SoulNameDetails[]>

---

unpackSessionId

▸ unpackSessionId(cookie?): undefined | string

Parameters

Name	Type
cookie?	string

Returns

undefined | string

---

validateSoulName

▸ validateSoulName(masa, soulName, verbose?): Object

Parameters

Name	Type
masa	MasaInterface
soulName	string
verbose?	boolean

Returns

Object

Name	Type
isValid	boolean
length	number
message?	string

---

verifyByName

▸ verifyByName(masa, soulName): Promise\<{ imageHashMatch: boolean ; imageOwnerIsMasaAccount: boolean ; imageSignatureMatch: boolean ; metadataOwnerIsMasaAccount: boolean ; metadataSignatureMatch: boolean ; nameMatch: boolean }>

Parameters

Name	Type
masa	MasaInterface
soulName	string

Returns

Promise\<{ imageHashMatch: boolean ; imageOwnerIsMasaAccount: boolean ; imageSignatureMatch: boolean ; metadataOwnerIsMasaAccount: boolean ; metadataSignatureMatch: boolean ; nameMatch: boolean }>

---

verifyGreen

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

Parameters

Name	Type
masa	MasaInterface
phoneNumber	string
code	string

Returns

Promise\<undefined | VerifyGreenResult>

---

verifyLink

▸ verifyLink(masa, contract, tokenId, readerIdentityId?): Promise\<VerifyLinkResult>

Parameters

Name	Type
masa	MasaInterface
contract	Contract
tokenId	BigNumber
readerIdentityId?	BigNumber

Returns

Promise\<VerifyLinkResult>

---

version

▸ version(): Object

Returns

Object

Name	Type
contractsVersion	string
sdkVersion	string

---

withdraw

▸ withdraw(masa, amount): Promise\<BaseResult>

Parameters

Name	Type
masa	MasaInterface
amount	string

Returns

Promise\<BaseResult>