Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
228 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
[# Masa SDK | ||
- v1.2.0-alpha.1](../README.md) / [Exports](../modules.md) / MasaGreen | ||
|
||
# Class: MasaGreen | ||
|
||
## Table of contents | ||
|
||
### Constructors | ||
|
||
- [constructor](MasaGreen.md#constructor) | ||
|
||
### Properties | ||
|
||
- [links](MasaGreen.md#links) | ||
- [masa](MasaGreen.md#masa) | ||
|
||
### Methods | ||
|
||
- [burn](MasaGreen.md#burn) | ||
- [create](MasaGreen.md#create) | ||
- [generate](MasaGreen.md#generate) | ||
- [list](MasaGreen.md#list) | ||
- [load](MasaGreen.md#load) | ||
|
||
## Constructors | ||
|
||
### constructor | ||
|
||
• **new MasaGreen**(`masa`) | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `masa` | [`Masa`](Masa.md) | | ||
|
||
## Properties | ||
|
||
### links | ||
|
||
• `Readonly` **links**: [`MasaSoulLinker`](MasaSoulLinker.md) | ||
|
||
___ | ||
|
||
### masa | ||
|
||
• `Private` **masa**: [`Masa`](Masa.md) | ||
|
||
## Methods | ||
|
||
### burn | ||
|
||
▸ **burn**(`greenId`): `Promise`<`boolean`\> | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `greenId` | `number` | | ||
|
||
#### Returns | ||
|
||
`Promise`<`boolean`\> | ||
|
||
___ | ||
|
||
### create | ||
|
||
▸ **create**(`phoneNumber`, `code`): `Promise`<[`CreateGreenResult`](../interfaces/CreateGreenResult.md)\> | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `phoneNumber` | `string` | | ||
| `code` | `string` | | ||
|
||
#### Returns | ||
|
||
`Promise`<[`CreateGreenResult`](../interfaces/CreateGreenResult.md)\> | ||
|
||
___ | ||
|
||
### generate | ||
|
||
▸ **generate**(`phoneNumber`): `Promise`<`undefined` \| [`BaseResult`](../interfaces/BaseResult.md) & { `status`: `string` }\> | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `phoneNumber` | `string` | | ||
|
||
#### Returns | ||
|
||
`Promise`<`undefined` \| [`BaseResult`](../interfaces/BaseResult.md) & { `status`: `string` }\> | ||
|
||
___ | ||
|
||
### list | ||
|
||
▸ **list**(`address?`): `Promise`<{ `metadata?`: [`IGreen`](../interfaces/IGreen.md) ; `tokenId`: `BigNumber` ; `tokenUri`: `string` }[]\> | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `address?` | `string` | | ||
|
||
#### Returns | ||
|
||
`Promise`<{ `metadata?`: [`IGreen`](../interfaces/IGreen.md) ; `tokenId`: `BigNumber` ; `tokenUri`: `string` }[]\> | ||
|
||
___ | ||
|
||
### load | ||
|
||
▸ **load**(`identityId`): `Promise`<{ `metadata?`: [`IGreen`](../interfaces/IGreen.md) ; `tokenId`: `BigNumber` ; `tokenUri`: `string` }[]\> | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `identityId` | `BigNumber` | | ||
|
||
#### Returns | ||
|
||
`Promise`<{ `metadata?`: [`IGreen`](../interfaces/IGreen.md) ; `tokenId`: `BigNumber` ; `tokenUri`: `string` }[]\> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
[# Masa SDK | ||
- v1.2.0-alpha.1](../README.md) / [Exports](../modules.md) / CreateGreenResult | ||
|
||
# Interface: CreateGreenResult | ||
|
||
## Hierarchy | ||
|
||
- [`BaseResult`](BaseResult.md) | ||
|
||
↳ **`CreateGreenResult`** | ||
|
||
## Table of contents | ||
|
||
### Properties | ||
|
||
- [message](CreateGreenResult.md#message) | ||
- [status](CreateGreenResult.md#status) | ||
- [success](CreateGreenResult.md#success) | ||
- [tokenId](CreateGreenResult.md#tokenid) | ||
|
||
## Properties | ||
|
||
### message | ||
|
||
• **message**: `string` | ||
|
||
#### Inherited from | ||
|
||
[BaseResult](BaseResult.md).[message](BaseResult.md#message) | ||
|
||
___ | ||
|
||
### status | ||
|
||
• `Optional` **status**: `string` | ||
|
||
___ | ||
|
||
### success | ||
|
||
• **success**: `boolean` | ||
|
||
#### Inherited from | ||
|
||
[BaseResult](BaseResult.md).[success](BaseResult.md#success) | ||
|
||
___ | ||
|
||
### tokenId | ||
|
||
• `Optional` **tokenId**: `string` \| `BigNumber` | ||
|
||
#### Inherited from | ||
|
||
[BaseResult](BaseResult.md).[tokenId](BaseResult.md#tokenid) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
[# Masa SDK | ||
- v1.2.0-alpha.1](../README.md) / [Exports](../modules.md) / IGreen | ||
|
||
# Interface: IGreen | ||
|
||
## Table of contents | ||
|
||
### Properties | ||
|
||
- [description](IGreen.md#description) | ||
- [image](IGreen.md#image) | ||
- [name](IGreen.md#name) | ||
- [properties](IGreen.md#properties) | ||
|
||
## Properties | ||
|
||
### description | ||
|
||
• **description**: ``"A decentralized 2FA"`` | ||
|
||
___ | ||
|
||
### image | ||
|
||
• **image**: ``"https://metadata.masa.finance/v1.0/2fa/2fa.png"`` | ||
|
||
___ | ||
|
||
### name | ||
|
||
• **name**: ``"Masa Soulbound Green 2FA v1.0.0"`` | ||
|
||
___ | ||
|
||
### properties | ||
|
||
• **properties**: `Object` | ||
|
||
#### Type declaration | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `account?` | `string` | | ||
| `identityId?` | `string` | | ||
| `tokenId` | `string` | |