MasaGreen

[# Masa SDK

• v3.30.3](/docs/developers/sdk/) / Exports / MasaGreen

Class: MasaGreen

Hierarchy

• MasaLinkable\<SoulboundGreen>

  ↳ MasaGreen

Table of contents

Constructors

• constructor

Properties

• contract
• links
• masa

Accessors

• isContractAvailable

Methods

• burn
• create
• generate
• list
• load
• mint
• verify

Constructors

constructor

• new MasaGreen(masa): MasaGreen

Parameters

Name	Type
masa	MasaInterface

Returns

MasaGreen

Overrides

MasaLinkable\<SoulboundGreen\>.constructor

Properties

contract

• Readonly contract: SoulboundGreen

Inherited from

MasaLinkable.contract

---

links

• Readonly links: MasaSoulLinker

Inherited from

MasaLinkable.links

---

masa

• Protected Readonly masa: MasaInterface

Inherited from

MasaLinkable.masa

Accessors

isContractAvailable

• get isContractAvailable(): boolean

Returns

boolean

Inherited from

MasaLinkable.isContractAvailable

Methods

burn

▸ burn(greenId): Promise\<BaseResult>

Burns a green

Parameters

Name	Type
greenId	BigNumber

Returns

Promise\<BaseResult>

---

create

▸ create(paymentMethod?, phoneNumber, code): Promise\<GreenBaseResult>

Does the verification and mint step in one go

Parameters

Name	Type	Default value
paymentMethod	PaymentMethod	"ETH"
phoneNumber	string	undefined
code	string	undefined

Returns

Promise\<GreenBaseResult>

---

generate

▸ generate(phoneNumber): Promise\<GenerateGreenResult>

Generates a new verification attempt

Parameters

Name	Type
phoneNumber	string

Returns

Promise\<GenerateGreenResult>

---

list

▸ list(address?): Promise\<GreenDetails[]>

Lits all greens on the current network

Parameters

Name	Type
address?	string

Returns

Promise\<GreenDetails[]>

---

load

▸ load(identityIdOrAddress): Promise\<GreenDetails[]>

Loads all greens for an identity on the current network

Parameters

Name	Type
identityIdOrAddress	string | BigNumber

Returns

Promise\<GreenDetails[]>

---

mint

▸ mint(paymentMethod?, authorityAddress, signatureDate, signature): Promise\<BaseResultWithTokenId>

Mints a green based on the previously made verification result

Parameters

Name	Type	Default value
paymentMethod	PaymentMethod	"ETH"
authorityAddress	string	undefined
signatureDate	number	undefined
signature	string	undefined

Returns

Promise\<BaseResultWithTokenId>

---

verify

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

Tries to verify the current verification attempt

Parameters

Name	Type
phoneNumber	string
code	string

Returns

Promise\<undefined | VerifyGreenResult>