update docs

masa-finance · May 19, 2023 · 72830da · 72830da
1 parent 330809d
commit 72830da
Show file tree

Hide file tree

Showing 59 changed files with 89 additions and 69 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,26 @@ 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).
 
+#### [v2.1.1](https://github.com/masa-finance/masa-sdk/compare/v2.1.0...v2.1.1)
+
+> 19 May 2023
+
+- support protocol fee in price calculation for soul name [`fbaf1b6`](https://github.com/masa-finance/masa-sdk/commit/fbaf1b64493eabebfb26f08d2a508260b8238954)
+
+#### [v2.1.0](https://github.com/masa-finance/masa-sdk/compare/v2.0.4...v2.1.0)
+
+> 17 May 2023
+
+- update contracts [`0fd5151`](https://github.com/masa-finance/masa-sdk/commit/0fd5151c573f4c21811cb75fa50971e48beefb9a)
+
+#### [v2.0.4](https://github.com/masa-finance/masa-sdk/compare/v2.0.3...v2.0.4)
+
+> 17 May 2023
+
+- update docs [`4529a4a`](https://github.com/masa-finance/masa-sdk/commit/4529a4a4c9367714cd435933f55c3801063b30e5)
+- added comments [`8d17a0a`](https://github.com/masa-finance/masa-sdk/commit/8d17a0a69d79e036bf3220d3879da9b2cc9ccf57)
+- prettier [`9189a53`](https://github.com/masa-finance/masa-sdk/commit/9189a5387b39005f72325fbcc9b99d166bc54e85)
+
 #### [v2.0.3](https://github.com/masa-finance/masa-sdk/compare/v2.0.2...v2.0.3)
 
 > 15 May 2023

diff --git a/docs/classes/ContractFactory.md b/docs/classes/ContractFactory.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / ContractFactory
+ - v2.1.1](../README.md) / [Exports](../modules.md) / ContractFactory
 
 # Class: ContractFactory
 

diff --git a/docs/classes/CreditScore.md b/docs/classes/CreditScore.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / CreditScore
+ - v2.1.1](../README.md) / [Exports](../modules.md) / CreditScore
 
 # Class: CreditScore
 

diff --git a/docs/classes/ERC20__factory.md b/docs/classes/ERC20__factory.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / ERC20\_\_factory
+ - v2.1.1](../README.md) / [Exports](../modules.md) / ERC20\_\_factory
 
 # Class: ERC20\_\_factory
 

diff --git a/docs/classes/Green.md b/docs/classes/Green.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / Green
+ - v2.1.1](../README.md) / [Exports](../modules.md) / Green
 
 # Class: Green
 

diff --git a/docs/classes/Identity.md b/docs/classes/Identity.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / Identity
+ - v2.1.1](../README.md) / [Exports](../modules.md) / Identity
 
 # Class: Identity
 

diff --git a/docs/classes/Masa.md b/docs/classes/Masa.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / Masa
+ - v2.1.1](../README.md) / [Exports](../modules.md) / Masa
 
 # Class: Masa
 

diff --git a/docs/classes/MasaAccount.md b/docs/classes/MasaAccount.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / MasaAccount
+ - v2.1.1](../README.md) / [Exports](../modules.md) / MasaAccount
 
 # Class: MasaAccount
 
@@ -53,7 +53,7 @@ MasaBase.masa
 
 ### getBalances
 
-▸ **getBalances**(`address?`): `Promise`<`Partial`<{ `CELO`: `undefined` \| `number` ; `CreditScore`: `undefined` \| `number` ; `ETH`: `undefined` \| `number` ; `G$`: `undefined` \| `number` ; `Green`: `undefined` \| `number` ; `Identity`: `undefined` \| `number` ; `MASA`: `undefined` \| `number` ; `Native`: `undefined` \| `number` ; `SoulName`: `undefined` \| `number` ; `USDC`: `undefined` \| `number` ; `WETH`: `undefined` \| `number` ; `cUSD`: `undefined` \| `number`  }\>\>
+▸ **getBalances**(`address?`): `Promise`<`Partial`<{ `BNB`: `undefined` \| `number` ; `CELO`: `undefined` \| `number` ; `CreditScore`: `undefined` \| `number` ; `ETH`: `undefined` \| `number` ; `G$`: `undefined` \| `number` ; `Green`: `undefined` \| `number` ; `Identity`: `undefined` \| `number` ; `MASA`: `undefined` \| `number` ; `MATIC`: `undefined` \| `number` ; `Native`: `undefined` \| `number` ; `SoulName`: `undefined` \| `number` ; `USDC`: `undefined` \| `number` ; `WETH`: `undefined` \| `number` ; `cUSD`: `undefined` \| `number`  }\>\>
 
 #### Parameters
 
@@ -63,4 +63,4 @@ MasaBase.masa
 
 #### Returns
 
-`Promise`<`Partial`<{ `CELO`: `undefined` \| `number` ; `CreditScore`: `undefined` \| `number` ; `ETH`: `undefined` \| `number` ; `G$`: `undefined` \| `number` ; `Green`: `undefined` \| `number` ; `Identity`: `undefined` \| `number` ; `MASA`: `undefined` \| `number` ; `Native`: `undefined` \| `number` ; `SoulName`: `undefined` \| `number` ; `USDC`: `undefined` \| `number` ; `WETH`: `undefined` \| `number` ; `cUSD`: `undefined` \| `number`  }\>\>
+`Promise`<`Partial`<{ `BNB`: `undefined` \| `number` ; `CELO`: `undefined` \| `number` ; `CreditScore`: `undefined` \| `number` ; `ETH`: `undefined` \| `number` ; `G$`: `undefined` \| `number` ; `Green`: `undefined` \| `number` ; `Identity`: `undefined` \| `number` ; `MASA`: `undefined` \| `number` ; `MATIC`: `undefined` \| `number` ; `Native`: `undefined` \| `number` ; `SoulName`: `undefined` \| `number` ; `USDC`: `undefined` \| `number` ; `WETH`: `undefined` \| `number` ; `cUSD`: `undefined` \| `number`  }\>\>
diff --git a/docs/classes/MasaArweave.md b/docs/classes/MasaArweave.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / MasaArweave
+ - v2.1.1](../README.md) / [Exports](../modules.md) / MasaArweave
 
 # Class: MasaArweave
 

diff --git a/docs/classes/MasaClient.md b/docs/classes/MasaClient.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / MasaClient
+ - v2.1.1](../README.md) / [Exports](../modules.md) / MasaClient
 
 # Class: MasaClient
 

diff --git a/docs/classes/MasaContracts.md b/docs/classes/MasaContracts.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / MasaContracts
+ - v2.1.1](../README.md) / [Exports](../modules.md) / MasaContracts
 
 # Class: MasaContracts
 

diff --git a/docs/classes/MasaCreditScore.md b/docs/classes/MasaCreditScore.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / MasaCreditScore
+ - v2.1.1](../README.md) / [Exports](../modules.md) / MasaCreditScore
 
 # Class: MasaCreditScore
 

diff --git a/docs/classes/MasaGreen.md b/docs/classes/MasaGreen.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / MasaGreen
+ - v2.1.1](../README.md) / [Exports](../modules.md) / MasaGreen
 
 # Class: MasaGreen
 

diff --git a/docs/classes/MasaIdentity.md b/docs/classes/MasaIdentity.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / MasaIdentity
+ - v2.1.1](../README.md) / [Exports](../modules.md) / MasaIdentity
 
 # Class: MasaIdentity
 

diff --git a/docs/classes/MasaModuleBase.md b/docs/classes/MasaModuleBase.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / MasaModuleBase
+ - v2.1.1](../README.md) / [Exports](../modules.md) / MasaModuleBase
 
 # Class: MasaModuleBase
 

diff --git a/docs/classes/MasaSBT.md b/docs/classes/MasaSBT.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / MasaSBT
+ - v2.1.1](../README.md) / [Exports](../modules.md) / MasaSBT
 
 # Class: MasaSBT
 

diff --git a/docs/classes/MasaSession.md b/docs/classes/MasaSession.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / MasaSession
+ - v2.1.1](../README.md) / [Exports](../modules.md) / MasaSession
 
 # Class: MasaSession
 

diff --git a/docs/classes/MasaSoulLinker.md b/docs/classes/MasaSoulLinker.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / MasaSoulLinker
+ - v2.1.1](../README.md) / [Exports](../modules.md) / MasaSoulLinker
 
 # Class: MasaSoulLinker
 

diff --git a/docs/classes/MasaSoulName.md b/docs/classes/MasaSoulName.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / MasaSoulName
+ - v2.1.1](../README.md) / [Exports](../modules.md) / MasaSoulName
 
 # Class: MasaSoulName
 

diff --git a/docs/classes/SBT.md b/docs/classes/SBT.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / SBT
+ - v2.1.1](../README.md) / [Exports](../modules.md) / SBT
 
 # Class: SBT
 

diff --git a/docs/classes/SoulLinker.md b/docs/classes/SoulLinker.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / SoulLinker
+ - v2.1.1](../README.md) / [Exports](../modules.md) / SoulLinker
 
 # Class: SoulLinker
 

diff --git a/docs/classes/SoulName.md b/docs/classes/SoulName.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / SoulName
+ - v2.1.1](../README.md) / [Exports](../modules.md) / SoulName
 
 # Class: SoulName
 
@@ -196,7 +196,7 @@ ___
 
 ### getPrice
 
-▸ **getPrice**(`paymentMethod`, `nameLength`, `duration?`, `slippage?`): `Promise`<{ `formattedPrice`: `string` ; `paymentAddress`: `string` ; `price`: `BigNumber`  }\>
+▸ **getPrice**(`paymentMethod`, `nameLength`, `duration?`, `slippage?`): `Promise`<{ `formattedMintFee`: `string` ; `formattedPrice`: `string` ; `formattedProtocolFee`: `string` ; `mintFee`: `BigNumber` ; `paymentAddress`: `string` ; `price`: `BigNumber` ; `protocolFee`: `BigNumber`  }\>
 
 Get price for minting a soul name
 
@@ -211,7 +211,7 @@ Get price for minting a soul name
 
 #### Returns
 
-`Promise`<{ `formattedPrice`: `string` ; `paymentAddress`: `string` ; `price`: `BigNumber`  }\>
+`Promise`<{ `formattedMintFee`: `string` ; `formattedPrice`: `string` ; `formattedProtocolFee`: `string` ; `mintFee`: `BigNumber` ; `paymentAddress`: `string` ; `price`: `BigNumber` ; `protocolFee`: `BigNumber`  }\>
 
 ___
 

diff --git a/docs/enums/SoulNameErrorCodes.md b/docs/enums/SoulNameErrorCodes.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / SoulNameErrorCodes
+ - v2.1.1](../README.md) / [Exports](../modules.md) / SoulNameErrorCodes
 
 # Enumeration: SoulNameErrorCodes
 

diff --git a/docs/interfaces/Addresses.md b/docs/interfaces/Addresses.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / Addresses
+ - v2.1.1](../README.md) / [Exports](../modules.md) / Addresses
 
 # Interface: Addresses
 
@@ -55,4 +55,4 @@ ___
 
 ### tokens
 
-• `Optional` **tokens**: `Partial`<{ `CELO`: `string` ; `ETH`: `string` ; `G$`: `string` ; `MASA`: `string` ; `USDC`: `string` ; `WETH`: `string` ; `cUSD`: `string`  }\>
+• `Optional` **tokens**: `Partial`<{ `BNB`: `string` ; `CELO`: `string` ; `ETH`: `string` ; `G$`: `string` ; `MASA`: `string` ; `MATIC`: `string` ; `USDC`: `string` ; `WETH`: `string` ; `cUSD`: `string`  }\>
diff --git a/docs/interfaces/ApprovalEventObject.md b/docs/interfaces/ApprovalEventObject.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / ApprovalEventObject
+ - v2.1.1](../README.md) / [Exports](../modules.md) / ApprovalEventObject
 
 # Interface: ApprovalEventObject
 

diff --git a/docs/interfaces/Attribute.md b/docs/interfaces/Attribute.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / Attribute
+ - v2.1.1](../README.md) / [Exports](../modules.md) / Attribute
 
 # Interface: Attribute
 

diff --git a/docs/interfaces/BaseResult.md b/docs/interfaces/BaseResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / BaseResult
+ - v2.1.1](../README.md) / [Exports](../modules.md) / BaseResult
 
 # Interface: BaseResult
 

diff --git a/docs/interfaces/ChallengeResult.md b/docs/interfaces/ChallengeResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / ChallengeResult
+ - v2.1.1](../README.md) / [Exports](../modules.md) / ChallengeResult
 
 # Interface: ChallengeResult
 

diff --git a/docs/interfaces/ChallengeResultWithCookie.md b/docs/interfaces/ChallengeResultWithCookie.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / ChallengeResultWithCookie
+ - v2.1.1](../README.md) / [Exports](../modules.md) / ChallengeResultWithCookie
 
 # Interface: ChallengeResultWithCookie
 

diff --git a/docs/interfaces/ContractInfo.md b/docs/interfaces/ContractInfo.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / ContractInfo
+ - v2.1.1](../README.md) / [Exports](../modules.md) / ContractInfo
 
 # Interface: ContractInfo
 

diff --git a/docs/interfaces/CreateSoulNameResult.md b/docs/interfaces/CreateSoulNameResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
+ - v2.1.1](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
 
 # Interface: CreateSoulNameResult
 

diff --git a/docs/interfaces/CreditScoreDetails.md b/docs/interfaces/CreditScoreDetails.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / CreditScoreDetails
+ - v2.1.1](../README.md) / [Exports](../modules.md) / CreditScoreDetails
 
 # Interface: CreditScoreDetails
 

diff --git a/docs/interfaces/ERC20.md b/docs/interfaces/ERC20.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / ERC20
+ - v2.1.1](../README.md) / [Exports](../modules.md) / ERC20
 
 # Interface: ERC20
 

diff --git a/docs/interfaces/ERC20Interface.md b/docs/interfaces/ERC20Interface.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / ERC20Interface
+ - v2.1.1](../README.md) / [Exports](../modules.md) / ERC20Interface
 
 # Interface: ERC20Interface
 

diff --git a/docs/interfaces/GenerateCreditScoreResult.md b/docs/interfaces/GenerateCreditScoreResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / GenerateCreditScoreResult
+ - v2.1.1](../README.md) / [Exports](../modules.md) / GenerateCreditScoreResult
 
 # Interface: GenerateCreditScoreResult
 

diff --git a/docs/interfaces/GenerateGreenResult.md b/docs/interfaces/GenerateGreenResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / GenerateGreenResult
+ - v2.1.1](../README.md) / [Exports](../modules.md) / GenerateGreenResult
 
 # Interface: GenerateGreenResult
 

diff --git a/docs/interfaces/GreenDetails.md b/docs/interfaces/GreenDetails.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / GreenDetails
+ - v2.1.1](../README.md) / [Exports](../modules.md) / GreenDetails
 
 # Interface: GreenDetails
 

diff --git a/docs/interfaces/ICreditScore.md b/docs/interfaces/ICreditScore.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / ICreditScore
+ - v2.1.1](../README.md) / [Exports](../modules.md) / ICreditScore
 
 # Interface: ICreditScore
 

diff --git a/docs/interfaces/IGreen.md b/docs/interfaces/IGreen.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / IGreen
+ - v2.1.1](../README.md) / [Exports](../modules.md) / IGreen
 
 # Interface: IGreen
 

diff --git a/docs/interfaces/IIdentity.md b/docs/interfaces/IIdentity.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / IIdentity
+ - v2.1.1](../README.md) / [Exports](../modules.md) / IIdentity
 
 # Interface: IIdentity
 

diff --git a/docs/interfaces/IIdentityContracts.md b/docs/interfaces/IIdentityContracts.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / IIdentityContracts
+ - v2.1.1](../README.md) / [Exports](../modules.md) / IIdentityContracts
 
 # Interface: IIdentityContracts
 

diff --git a/docs/interfaces/IPassport.md b/docs/interfaces/IPassport.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / IPassport
+ - v2.1.1](../README.md) / [Exports](../modules.md) / IPassport
 
 # Interface: IPassport
 

diff --git a/docs/interfaces/ISession.md b/docs/interfaces/ISession.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / ISession
+ - v2.1.1](../README.md) / [Exports](../modules.md) / ISession
 
 # Interface: ISession
 

diff --git a/docs/interfaces/ISoulName.md b/docs/interfaces/ISoulName.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / ISoulName
+ - v2.1.1](../README.md) / [Exports](../modules.md) / ISoulName
 
 # Interface: ISoulName
 

diff --git a/docs/interfaces/IdentityDetails.md b/docs/interfaces/IdentityDetails.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / IdentityDetails
+ - v2.1.1](../README.md) / [Exports](../modules.md) / IdentityDetails
 
 # Interface: IdentityDetails
 

diff --git a/docs/interfaces/LoadContractArgs.md b/docs/interfaces/LoadContractArgs.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / LoadContractArgs
+ - v2.1.1](../README.md) / [Exports](../modules.md) / LoadContractArgs
 
 # Interface: LoadContractArgs
 

diff --git a/docs/interfaces/LogoutResult.md b/docs/interfaces/LogoutResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / LogoutResult
+ - v2.1.1](../README.md) / [Exports](../modules.md) / LogoutResult
 
 # Interface: LogoutResult
 

diff --git a/docs/interfaces/MasaArgs.md b/docs/interfaces/MasaArgs.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v2.0.3](../README.md) / [Exports](../modules.md) / MasaArgs
+ - v2.1.1](../README.md) / [Exports](../modules.md) / MasaArgs
 
 # Interface: MasaArgs