MasaSoulName
[# Masa SDK
- v3.32.0](/docs/developers/sdk/) / Exports / MasaSoulName
Class: MasaSoulName
Hierarchy
MasaModuleBase↳
MasaSoulName
Table of contents
Constructors
Properties
Accessors
Methods
- burn
- create
- getSoulNameMetadataPrefix
- list
- loadSoulNameByName
- loadSoulNameByTokenId
- loadSoulNames
- loadSoulNamesWithExpired
- renew
- resolve
- send
- tail
- validate
- verify
Constructors
constructor
• new MasaSoulName(masa): MasaSoulName
Parameters
| Name | Type |
|---|---|
masa | MasaInterface |
Returns
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
| Name | Type |
|---|---|
soulName | string |
Returns
Promise\<BaseResult>
create
▸ create(paymentMethod?, soulName, duration, receiver?, style?): Promise\<CreateSoulNameResult>
Parameters
| Name | Type | Default value |
|---|---|---|
paymentMethod | PaymentMethod | "ETH" |
soulName | string | undefined |
duration | number | undefined |
receiver? | string | undefined |
style? | string | undefined |
Returns
Promise\<CreateSoulNameResult>
getSoulNameMetadataPrefix
▸ getSoulNameMetadataPrefix(): string
Returns
string
list
▸ list(address?): Promise\<SoulNameDetails[]>
Parameters
| Name | Type |
|---|---|
address? | string |
Returns
Promise\<SoulNameDetails[]>
loadSoulNameByName
▸ loadSoulNameByName(soulName): Promise\<undefined | SoulNameDetails>
Parameters
| Name | Type |
|---|---|
soulName | string |
Returns
Promise\<undefined | SoulNameDetails>
loadSoulNameByTokenId
▸ loadSoulNameByTokenId(tokenId): Promise\<undefined | SoulNameDetails>
Parameters
| Name | Type |
|---|---|
tokenId | string | BigNumber |
Returns
Promise\<undefined | SoulNameDetails>
loadSoulNames
▸ loadSoulNames(identityIdOrAddress): Promise\<string[]>
Parameters
| Name | Type |
|---|---|
identityIdOrAddress | string | BigNumber |
Returns
Promise\<string[]>
loadSoulNamesWithExpired
▸ loadSoulNamesWithExpired(identityIdOrAddress): Promise\<string[]>
Parameters
| Name | Type |
|---|---|
identityIdOrAddress | string | BigNumber |
Returns
Promise\<string[]>
renew
▸ renew(soulName, years): Promise\<BaseResult>
Parameters
| Name | Type |
|---|---|
soulName | string |
years | number |
Returns
Promise\<BaseResult>
resolve
▸ resolve(soulName): Promise\<undefined | string>
Parameters
| Name | Type |
|---|---|
soulName | string |
Returns
Promise\<undefined | string>
send
▸ send(soulName, receiver): Promise\<BaseResult>
Parameters
| Name | Type |
|---|---|
soulName | string |
receiver | string |
Returns
Promise\<BaseResult>
tail
▸ tail(limit?): Promise\<SoulNameDetails[]>
Parameters
| Name | Type |
|---|---|
limit? | number |
Returns
Promise\<SoulNameDetails[]>
validate
▸ validate(soulName): Object
Parameters
| Name | Type |
|---|---|
soulName | string |
Returns
Object
| Name | Type |
|---|---|
isValid | boolean |
length | number |
message? | string |
verify
▸ verify(soulName): Promise\<{ imageHashMatch: boolean ; imageOwnerIsMasaAccount: boolean ; imageSignatureMatch: boolean ; metadataOwnerIsMasaAccount: boolean ; metadataSignatureMatch: boolean ; nameMatch: boolean }>
Parameters
| Name | Type |
|---|---|
soulName | string |
Returns
Promise\<{ imageHashMatch: boolean ; imageOwnerIsMasaAccount: boolean ; imageSignatureMatch: boolean ; metadataOwnerIsMasaAccount: boolean ; metadataSignatureMatch: boolean ; nameMatch: boolean }>