Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@H34D
H34D committed Mar 6, 2023
1 parent 82eaba1 commit 4e6da7e
Show file tree
Hide file tree
Showing 38 changed files with 209 additions and 96 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Expand Up @@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file. Dates are d

Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).

#### [v1.7.0](https://github.com/masa-finance/masa-sdk/compare/v1.6.6...v1.7.0)

> 6 March 2023
- make payment method more prominent down the line [`9a425c0`](https://github.com/masa-finance/masa-sdk/commit/9a425c091576ec359dc2847edc2a994a8d53b037)
- update docs [`4097eed`](https://github.com/masa-finance/masa-sdk/commit/4097eed8f3f72345ba4731b26094e547b5261301)

#### [v1.6.6](https://github.com/masa-finance/masa-sdk/compare/v1.6.5...v1.6.6)

> 3 March 2023
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
View file
@@ -1,5 +1,5 @@
# Masa SDK
- v1.6.6 / [Exports](modules.md)
- v1.7.0 / [Exports](modules.md)

<!-- TOC -->
* [Installation](#installation)
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/Masa.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / Masa
- v1.7.0](../README.md) / [Exports](../modules.md) / Masa

# Class: Masa

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaAccount.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / MasaAccount
- v1.7.0](../README.md) / [Exports](../modules.md) / MasaAccount

# Class: MasaAccount

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaArweave.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / MasaArweave
- v1.7.0](../README.md) / [Exports](../modules.md) / MasaArweave

# Class: MasaArweave

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaClient.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / MasaClient
- v1.7.0](../README.md) / [Exports](../modules.md) / MasaClient

# Class: MasaClient

Expand Down
4 changes: 2 additions & 2 deletions docs/classes/MasaContracts.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / MasaContracts
- v1.7.0](../README.md) / [Exports](../modules.md) / MasaContracts

# Class: MasaContracts

Expand Down Expand Up @@ -114,7 +114,7 @@ ___
| `getSoulNames` | (`address`: `string`) => `Promise`<`string`[]\> |
| `getSoulnameData` | (`soulName`: `string`) => `Promise`<{ `exists`: `boolean` ; `tokenId`: `BigNumber` }\> |
| `isAvailable` | (`soulName`: `string`) => `Promise`<`boolean`\> |
| `purchase` | (`paymentMethod`: [`PaymentMethod`](../modules.md#paymentmethod), `name`: `string`, `nameLength`: `number`, `duration`: `number`, `metadataURL`: `string`, `authorityAddress`: `string`, `signature`: `string`) => `Promise`<`ContractTransaction`\> |
| `purchase` | (`paymentMethod`: [`PaymentMethod`](../modules.md#paymentmethod), `name`: `string`, `nameLength`: `number`, `duration`: `number`, `metadataURL`: `string`, `authorityAddress`: `string`, `signature`: `string`, `receiver?`: `string`) => `Promise`<`ContractTransaction`\> |

___

Expand Down
10 changes: 8 additions & 2 deletions docs/classes/MasaCreditScore.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / MasaCreditScore
- v1.7.0](../README.md) / [Exports](../modules.md) / MasaCreditScore

# Class: MasaCreditScore

Expand Down Expand Up @@ -79,7 +79,13 @@ ___

### create

▸ **create**(): `Promise`<`undefined` \| [`GenerateCreditScoreResult`](../interfaces/GenerateCreditScoreResult.md)\>
▸ **create**(`paymentMethod?`): `Promise`<`undefined` \| [`GenerateCreditScoreResult`](../interfaces/GenerateCreditScoreResult.md)\>

#### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"eth"` |

#### Returns

Expand Down
26 changes: 14 additions & 12 deletions docs/classes/MasaGreen.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / MasaGreen
- v1.7.0](../README.md) / [Exports](../modules.md) / MasaGreen

# Class: MasaGreen

Expand Down Expand Up @@ -84,16 +84,17 @@ ___

### create

▸ **create**(`phoneNumber`, `code`): `Promise`<[`VerifyGreenResult`](../interfaces/VerifyGreenResult.md)\>
▸ **create**(`paymentMethod?`, `phoneNumber`, `code`): `Promise`<[`VerifyGreenResult`](../interfaces/VerifyGreenResult.md)\>

Does the verification and mint step in one go

#### Parameters

| Name | Type |
| :------ | :------ |
| `phoneNumber` | `string` |
| `code` | `string` |
| Name | Type | Default value |
| :------ | :------ | :------ |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"eth"` |
| `phoneNumber` | `string` | `undefined` |
| `code` | `string` | `undefined` |

#### Returns

Expand Down Expand Up @@ -157,17 +158,18 @@ ___

### mint

▸ **mint**(`authorityAddress`, `signatureDate`, `signature`): `Promise`<`undefined` \| { `tokenId`: `BigNumber` }\>
▸ **mint**(`paymentMethod?`, `authorityAddress`, `signatureDate`, `signature`): `Promise`<`undefined` \| { `tokenId`: `BigNumber` }\>

Mints a green based on the previously made verification result

#### Parameters

| Name | Type |
| :------ | :------ |
| `authorityAddress` | `string` |
| `signatureDate` | `number` |
| `signature` | `string` |
| Name | Type | Default value |
| :------ | :------ | :------ |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"eth"` |
| `authorityAddress` | `string` | `undefined` |
| `signatureDate` | `number` | `undefined` |
| `signature` | `string` | `undefined` |

#### Returns

Expand Down
6 changes: 3 additions & 3 deletions docs/classes/MasaIdentity.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / MasaIdentity
- v1.7.0](../README.md) / [Exports](../modules.md) / MasaIdentity

# Class: MasaIdentity

Expand Down Expand Up @@ -84,15 +84,15 @@ ___

### createWithSoulName

▸ **createWithSoulName**(`soulName`, `duration`, `paymentMethod`): `Promise`<`boolean`\>
▸ **createWithSoulName**(`paymentMethod`, `soulName`, `duration`): `Promise`<`boolean`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) |
| `soulName` | `string` |
| `duration` | `number` |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) |

#### Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaSession.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / MasaSession
- v1.7.0](../README.md) / [Exports](../modules.md) / MasaSession

# Class: MasaSession

Expand Down
16 changes: 8 additions & 8 deletions docs/classes/MasaSoulLinker.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / MasaSoulLinker
- v1.7.0](../README.md) / [Exports](../modules.md) / MasaSoulLinker

# Class: MasaSoulLinker

Expand Down Expand Up @@ -100,14 +100,14 @@ ___

### establish

▸ **establish**(`passport`, `paymentMethod?`): `Promise`<[`BaseResult`](../interfaces/BaseResult.md)\>
▸ **establish**(`paymentMethod?`, `passport`): `Promise`<[`BaseResult`](../interfaces/BaseResult.md)\>

#### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| `passport` | `string` | `undefined` |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"eth"` |
| `passport` | `string` | `undefined` |

#### Returns

Expand All @@ -133,14 +133,14 @@ ___

### query

▸ **query**(`passport`, `paymentMethod?`): `Promise`<[`BaseResult`](../interfaces/BaseResult.md)\>
▸ **query**(`paymentMethod`, `passport`): `Promise`<[`BaseResult`](../interfaces/BaseResult.md)\>

#### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| `passport` | `string` | `undefined` |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"eth"` |
| Name | Type |
| :------ | :------ |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) |
| `passport` | `string` |

#### Returns

Expand Down
27 changes: 14 additions & 13 deletions docs/classes/MasaSoulName.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / MasaSoulName
- v1.7.0](../README.md) / [Exports](../modules.md) / MasaSoulName

# Class: MasaSoulName

Expand Down Expand Up @@ -79,15 +79,16 @@ ___

### create

▸ **create**(`soulName`, `duration`, `paymentMethod`): `Promise`<[`CreateSoulNameResult`](../interfaces/CreateSoulNameResult.md)\>
▸ **create**(`paymentMethod?`, `soulName`, `duration`, `receiver?`): `Promise`<[`CreateSoulNameResult`](../interfaces/CreateSoulNameResult.md)\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `soulName` | `string` |
| `duration` | `number` |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) |
| Name | Type | Default value |
| :------ | :------ | :------ |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"eth"` |
| `soulName` | `string` | `undefined` |
| `duration` | `number` | `undefined` |
| `receiver?` | `string` | `undefined` |

#### Returns

Expand All @@ -97,15 +98,15 @@ ___

### getRegistrationPrice

▸ **getRegistrationPrice**(`soulName`, `duration`, `paymentMethod`): `Promise`<`BigNumber`\>
▸ **getRegistrationPrice**(`paymentMethod?`, `soulName`, `duration`): `Promise`<`BigNumber`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `soulName` | `string` |
| `duration` | `number` |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) |
| Name | Type | Default value |
| :------ | :------ | :------ |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"eth"` |
| `soulName` | `string` | `undefined` |
| `duration` | `number` | `undefined` |

#### Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/Addresses.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / Addresses
- v1.7.0](../README.md) / [Exports](../modules.md) / Addresses

# Interface: Addresses

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/Attribute.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / Attribute
- v1.7.0](../README.md) / [Exports](../modules.md) / Attribute

# Interface: Attribute

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/BaseResult.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / BaseResult
- v1.7.0](../README.md) / [Exports](../modules.md) / BaseResult

# Interface: BaseResult

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/CreateSoulNameResult.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
- v1.7.0](../README.md) / [Exports](../modules.md) / CreateSoulNameResult

# Interface: CreateSoulNameResult

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/GenerateCreditScoreResult.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / GenerateCreditScoreResult
- v1.7.0](../README.md) / [Exports](../modules.md) / GenerateCreditScoreResult

# Interface: GenerateCreditScoreResult

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/GenerateGreenResult.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / GenerateGreenResult
- v1.7.0](../README.md) / [Exports](../modules.md) / GenerateGreenResult

# Interface: GenerateGreenResult

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/GetChallengeResult.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / GetChallengeResult
- v1.7.0](../README.md) / [Exports](../modules.md) / GetChallengeResult

# Interface: GetChallengeResult

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/ICreditScore.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / ICreditScore
- v1.7.0](../README.md) / [Exports](../modules.md) / ICreditScore

# Interface: ICreditScore

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/IGreen.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / IGreen
- v1.7.0](../README.md) / [Exports](../modules.md) / IGreen

# Interface: IGreen

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/IIdentity.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / IIdentity
- v1.7.0](../README.md) / [Exports](../modules.md) / IIdentity

# Interface: IIdentity

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/IIdentityContracts.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / IIdentityContracts
- v1.7.0](../README.md) / [Exports](../modules.md) / IIdentityContracts

# Interface: IIdentityContracts

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/IPassport.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / IPassport
- v1.7.0](../README.md) / [Exports](../modules.md) / IPassport

# Interface: IPassport

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/ISession.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / ISession
- v1.7.0](../README.md) / [Exports](../modules.md) / ISession

# Interface: ISession

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/ISoulName.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / ISoulName
- v1.7.0](../README.md) / [Exports](../modules.md) / ISoulName

# Interface: ISoulName

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/LoadContractArgs.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / LoadContractArgs
- v1.7.0](../README.md) / [Exports](../modules.md) / LoadContractArgs

# Interface: LoadContractArgs

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/LogoutResult.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / LogoutResult
- v1.7.0](../README.md) / [Exports](../modules.md) / LogoutResult

# Interface: LogoutResult

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/MasaArgs.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / MasaArgs
- v1.7.0](../README.md) / [Exports](../modules.md) / MasaArgs

# Interface: MasaArgs

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/MasaConfig.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.6.6](../README.md) / [Exports](../modules.md) / MasaConfig
- v1.7.0](../README.md) / [Exports](../modules.md) / MasaConfig

# Interface: MasaConfig

Expand Down

0 comments on commit 4e6da7e

Please sign in to comment.