MasaSoulName.md

Masa SDK v4.2.0 • Docs

---

Masa SDK v4.2.0 / MasaSoulName

Class: MasaSoulName

Extends

• MasaModuleBase

Constructors

new MasaSoulName()

new MasaSoulName(masa): MasaSoulName

Parameters

• masa: MasaInterface

Returns

MasaSoulName

Overrides

MasaModuleBase.constructor

Properties

contract

readonly contract: Contract & ContractInfo

Inherited from

MasaModuleBase.contract

---

masa

protected readonly masa: MasaInterface

Inherited from

MasaModuleBase.masa

Accessors

isContractAvailable

get isContractAvailable(): boolean

Returns

boolean

Inherited from

MasaModuleBase.isContractAvailable

Methods

burn()

burn(soulName): Promise<BaseResult>

Parameters

• soulName: string

Returns

Promise<BaseResult>

---

getSoulNameMetadataPrefix()

getSoulNameMetadataPrefix(): string

Returns

string

---

list()

list(address?): Promise<SoulNameDetails[]>

Parameters

• address?: string

Returns

Promise<SoulNameDetails[]>

---

loadSoulNameByName()

loadSoulNameByName(soulName): Promise<undefined | SoulNameDetails>

Parameters

• soulName: string

Returns

Promise<undefined | SoulNameDetails>

---

loadSoulNameByTokenId()

loadSoulNameByTokenId(tokenId): Promise<undefined | SoulNameDetails>

Parameters

• tokenId: string | BigNumber

Returns

Promise<undefined | SoulNameDetails>

---

loadSoulNames()

loadSoulNames(identityIdOrAddress): Promise<string[]>

Parameters

• identityIdOrAddress: string | BigNumber

Returns

Promise<string[]>

---

loadSoulNamesWithExpired()

loadSoulNamesWithExpired(identityIdOrAddress): Promise<string[]>

Parameters

• identityIdOrAddress: string | BigNumber

Returns

Promise<string[]>

---

renew()

renew(soulName, years): Promise<BaseResult>

Parameters

• soulName: string

• years: number

Returns

Promise<BaseResult>

---

resolve()

resolve(soulName): Promise<undefined | string>

Parameters

• soulName: string

Returns

Promise<undefined | string>

---

send()

send(soulName, receiver): Promise<BaseResult>

Parameters

• soulName: string

• receiver: string

Returns

Promise<BaseResult>

---

tail()

tail(limit?): Promise<SoulNameDetails[]>

Parameters

• limit?: number

Returns

Promise<SoulNameDetails[]>

---

validate()

validate(soulName): object

Parameters

• soulName: string

Returns

object

isValid

isValid: boolean

length

length: number

message?

optional message: string

---

verify()

verify(soulName): Promise<object>

Parameters

• soulName: string

Returns

Promise<object>

imageHashMatch

imageHashMatch: boolean

imageOwnerIsMasaAccount

imageOwnerIsMasaAccount: boolean

imageSignatureMatch

imageSignatureMatch: boolean

metadataOwnerIsMasaAccount

metadataOwnerIsMasaAccount: boolean

metadataSignatureMatch

metadataSignatureMatch: boolean

nameMatch

nameMatch: boolean