Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
H34D committed Feb 21, 2023
1 parent bf2f6cd commit 9d05ea9
Show file tree
Hide file tree
Showing 37 changed files with 47 additions and 40 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
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.5.2](https://github.com/masa-finance/masa-sdk/compare/v1.5.1...v1.5.2)

> 21 February 2023
- update docs [`92c7dbd`](https://github.com/masa-finance/masa-sdk/commit/92c7dbdcdc17ac82e7a4e273f49e9c4bad1a318f)
- move to own gas estimation for minting greens and credit scores like we do for soul names [`d6c7b80`](https://github.com/masa-finance/masa-sdk/commit/d6c7b80dfc413da21f826269185d8aeade0f4e80)

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

> 17 February 2023
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
@@ -1,5 +1,5 @@
# Masa SDK
- v1.5.1 / [Exports](modules.md)
- v1.5.2 / [Exports](modules.md)

---

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

# Class: Masa

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

# Class: MasaAccount

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

# Class: MasaArweave

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

# Class: MasaClient

Expand Down
8 changes: 4 additions & 4 deletions docs/classes/MasaContracts.md
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.5.1](../README.md) / [Exports](../modules.md) / MasaContracts
- v1.5.2](../README.md) / [Exports](../modules.md) / MasaContracts

# Class: MasaContracts

Expand Down Expand Up @@ -42,8 +42,8 @@

| Name | Type |
| :------ | :------ |
| `mint` | (`wallet`: `Wallet`, `paymentMethod`: [`PaymentMethod`](../modules.md#paymentmethod), `identityId`: `BigNumber`, `authorityAddress`: `string`, `signatureDate`: `number`, `signature`: `string`, `slippage`: `undefined` \| `number`) => `Promise`<`ContractTransaction`\> |
| `sign` | (`wallet`: `Wallet`, `identityId`: `BigNumber`) => `Promise`<`undefined` \| { `authorityAddress`: `string` ; `signature`: `string` ; `signatureDate`: `number` }\> |
| `mint` | (`paymentMethod`: [`PaymentMethod`](../modules.md#paymentmethod), `identityId`: `BigNumber`, `authorityAddress`: `string`, `signatureDate`: `number`, `signature`: `string`, `slippage`: `undefined` \| `number`) => `Promise`<`ContractTransaction`\> |
| `sign` | (`identityId`: `BigNumber`) => `Promise`<`undefined` \| { `authorityAddress`: `string` ; `signature`: `string` ; `signatureDate`: `number` }\> |
| `types` | { `MintCreditScore`: { `name`: `string` = "identityId"; `type`: `string` = "uint256" }[] } |
| `types.MintCreditScore` | { `name`: `string` = "identityId"; `type`: `string` = "uint256" }[] |

Expand All @@ -58,7 +58,7 @@ ___
| Name | Type |
| :------ | :------ |
| `getPrice` | (`paymentMethod`: [`PaymentMethod`](../modules.md#paymentmethod), `slippage`: `undefined` \| `number`) => `Promise`<{ `formattedMintTransactionFee`: `string` ; `formattedPrice`: `string` ; `mintTransactionEstimatedGas`: `BigNumber` ; `mintTransactionFee`: `BigNumber` ; `paymentAddress`: `string` ; `price`: `BigNumber` }\> |
| `mint` | (`wallet`: `Wallet`, `paymentMethod`: [`PaymentMethod`](../modules.md#paymentmethod), `receiver`: `string`, `authorityAddress`: `string`, `signatureDate`: `number`, `signature`: `string`, `slippage`: `undefined` \| `number`) => `Promise`<`ContractTransaction`\> |
| `mint` | (`paymentMethod`: [`PaymentMethod`](../modules.md#paymentmethod), `receiver`: `string`, `authorityAddress`: `string`, `signatureDate`: `number`, `signature`: `string`, `slippage`: `undefined` \| `number`) => `Promise`<`ContractTransaction`\> |
| `sign` | (`receiver`: `string`) => `Promise`<`undefined` \| { `authorityAddress`: `string` ; `signature`: `string` ; `signatureDate`: `number` }\> |
| `types` | { `MintGreen`: { `name`: `string` = "to"; `type`: `string` = "address" }[] } |
| `types.MintGreen` | { `name`: `string` = "to"; `type`: `string` = "address" }[] |
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaCreditScore.md
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.5.1](../README.md) / [Exports](../modules.md) / MasaCreditScore
- v1.5.2](../README.md) / [Exports](../modules.md) / MasaCreditScore

# Class: MasaCreditScore

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaGreen.md
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.5.1](../README.md) / [Exports](../modules.md) / MasaGreen
- v1.5.2](../README.md) / [Exports](../modules.md) / MasaGreen

# Class: MasaGreen

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaIdentity.md
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.5.1](../README.md) / [Exports](../modules.md) / MasaIdentity
- v1.5.2](../README.md) / [Exports](../modules.md) / MasaIdentity

# Class: MasaIdentity

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

# Class: MasaSession

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaSoulLinker.md
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.5.1](../README.md) / [Exports](../modules.md) / MasaSoulLinker
- v1.5.2](../README.md) / [Exports](../modules.md) / MasaSoulLinker

# Class: MasaSoulLinker

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaSoulName.md
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.5.1](../README.md) / [Exports](../modules.md) / MasaSoulName
- v1.5.2](../README.md) / [Exports](../modules.md) / MasaSoulName

# Class: MasaSoulName

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

# Interface: Addresses

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

# Interface: Attribute

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

# Interface: BaseResult

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

# Interface: CreateSoulNameResult

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

# Interface: GenerateCreditScoreResult

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

# Interface: GenerateGreenResult

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

# Interface: GetChallengeResult

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

# Interface: ICreditScore

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

# Interface: IGreen

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

# Interface: IIdentity

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

# Interface: IIdentityContracts

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

# Interface: IPassport

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

# Interface: ISession

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

# Interface: ISoulName

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

# Interface: LoadContractArgs

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

# Interface: LogoutResult

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

# Interface: MasaArgs

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

# Interface: MasaConfig

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/SoulNameDetails.md
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.5.1](../README.md) / [Exports](../modules.md) / SoulNameDetails
- v1.5.2](../README.md) / [Exports](../modules.md) / SoulNameDetails

# Interface: SoulNameDetails

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/SoulNameMetadataStoreResult.md
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.5.1](../README.md) / [Exports](../modules.md) / SoulNameMetadataStoreResult
- v1.5.2](../README.md) / [Exports](../modules.md) / SoulNameMetadataStoreResult

# Interface: SoulNameMetadataStoreResult

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/UpdateCreditScoreResult.md
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.5.1](../README.md) / [Exports](../modules.md) / UpdateCreditScoreResult
- v1.5.2](../README.md) / [Exports](../modules.md) / UpdateCreditScoreResult

# Interface: UpdateCreditScoreResult

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/User.md
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.5.1](../README.md) / [Exports](../modules.md) / User
- v1.5.2](../README.md) / [Exports](../modules.md) / User

# Interface: User

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/VerifyGreenResult.md
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.5.1](../README.md) / [Exports](../modules.md) / VerifyGreenResult
- v1.5.2](../README.md) / [Exports](../modules.md) / VerifyGreenResult

# Interface: VerifyGreenResult

Expand Down
4 changes: 2 additions & 2 deletions docs/modules.md
@@ -1,8 +1,8 @@
[# Masa SDK
- v1.5.1](README.md) / Exports
- v1.5.2](README.md) / Exports

# # Masa SDK
- v1.5.1
- v1.5.2

## Table of contents

Expand Down

0 comments on commit 9d05ea9

Please sign in to comment.