update docs

masa-finance · Mar 30, 2023 · a641bdb · a641bdb
1 parent 6a671db
commit a641bdb
Show file tree

Hide file tree

Showing 59 changed files with 135 additions and 104 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,22 @@ 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.12.5](https://github.com/masa-finance/masa-sdk/compare/v1.12.4...v1.12.5)
+
+> 30 March 2023
+
+- remove unused code [`933f0d1`](https://github.com/masa-finance/masa-sdk/commit/933f0d1f636926a1209eb54c323887819f056841)
+- refactor logging [`f48488f`](https://github.com/masa-finance/masa-sdk/commit/f48488f57e925a706925504cd64d025e2239adfe)
+- update basecamp url [`e6d1e12`](https://github.com/masa-finance/masa-sdk/commit/e6d1e1201275bf06a208f140f50a639d65961a8f)
+
+#### [v1.12.4](https://github.com/masa-finance/masa-sdk/compare/v1.12.3...v1.12.4)
+
+> 30 March 2023
+
+- update docs [`450275f`](https://github.com/masa-finance/masa-sdk/commit/450275fc5154d185e3c1e9d37a3873d395c00327)
+- added tail functionality to list soul names [`8603a93`](https://github.com/masa-finance/masa-sdk/commit/8603a93260b3dc9df6c3771c29cb637f387c8747)
+- fix logging [`7161649`](https://github.com/masa-finance/masa-sdk/commit/7161649dae3ede5b995b484d07cd3acf118a9860)
+
 #### [v1.12.3](https://github.com/masa-finance/masa-sdk/compare/v1.12.2...v1.12.3)
 
 > 30 March 2023

diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,5 @@
 # Masa SDK
- - v1.12.3 / [Exports](modules.md)
+ - v1.12.5 / [Exports](modules.md)
 
 <!-- TOC -->
   * [Installation](#installation)

diff --git a/docs/classes/ContractFactory.md b/docs/classes/ContractFactory.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.12.3](../README.md) / [Exports](../modules.md) / ContractFactory
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / CreditScore
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / ERC20\_\_factory
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / Green
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / Identity
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / Masa
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / MasaAccount
+ - v1.12.5](../README.md) / [Exports](../modules.md) / MasaAccount
 
 # Class: MasaAccount
 

diff --git a/docs/classes/MasaArweave.md b/docs/classes/MasaArweave.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.12.3](../README.md) / [Exports](../modules.md) / MasaArweave
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / MasaClient
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / MasaContracts
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / MasaCreditScore
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / MasaGreen
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / MasaIdentity
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / MasaModuleBase
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / MasaSBT
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / MasaSession
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / MasaSoulLinker
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / MasaSoulName
+ - v1.12.5](../README.md) / [Exports](../modules.md) / MasaSoulName
 
 # Class: MasaSoulName
 
@@ -23,14 +23,14 @@
 
 - [burn](MasaSoulName.md#burn)
 - [create](MasaSoulName.md#create)
-- [getRegistrationPrice](MasaSoulName.md#getregistrationprice)
 - [getSoulNameMetadataPrefix](MasaSoulName.md#getsoulnamemetadataprefix)
 - [list](MasaSoulName.md#list)
 - [loadSoulNameByName](MasaSoulName.md#loadsoulnamebyname)
 - [loadSoulNameByTokenId](MasaSoulName.md#loadsoulnamebytokenid)
 - [loadSoulNamesByIdentityId](MasaSoulName.md#loadsoulnamesbyidentityid)
 - [resolve](MasaSoulName.md#resolve)
 - [send](MasaSoulName.md#send)
+- [tail](MasaSoulName.md#tail)
 - [validate](MasaSoulName.md#validate)
 - [verify](MasaSoulName.md#verify)
 
@@ -97,24 +97,6 @@ ___
 
 ___
 
-### getRegistrationPrice
-
-▸ **getRegistrationPrice**(`paymentMethod?`, `soulName`, `duration`): `Promise`<`BigNumber`\>
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"ETH"` |
-| `soulName` | `string` | `undefined` |
-| `duration` | `number` | `undefined` |
-
-#### Returns
-
-`Promise`<`BigNumber`\>
-
-___
-
 ### getSoulNameMetadataPrefix
 
 ▸ **getSoulNameMetadataPrefix**(): `string`
@@ -222,6 +204,22 @@ ___
 
 ___
 
+### tail
+
+▸ **tail**(`limit?`): `Promise`<[`SoulNameDetails`](../interfaces/SoulNameDetails.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `limit?` | `number` |
+
+#### Returns
+
+`Promise`<[`SoulNameDetails`](../interfaces/SoulNameDetails.md)[]\>
+
+___
+
 ### validate
 
 ▸ **validate**(`soulName`): `Object`

diff --git a/docs/classes/SBT.md b/docs/classes/SBT.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.12.3](../README.md) / [Exports](../modules.md) / SBT
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / SoulLinker
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / SoulName
+ - v1.12.5](../README.md) / [Exports](../modules.md) / SoulName
 
 # Class: SoulName
 

diff --git a/docs/enums/SoulNameErrorCodes.md b/docs/enums/SoulNameErrorCodes.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.12.3](../README.md) / [Exports](../modules.md) / SoulNameErrorCodes
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / Addresses
+ - v1.12.5](../README.md) / [Exports](../modules.md) / Addresses
 
 # Interface: Addresses
 

diff --git a/docs/interfaces/ApprovalEventObject.md b/docs/interfaces/ApprovalEventObject.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.12.3](../README.md) / [Exports](../modules.md) / ApprovalEventObject
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / Attribute
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / BaseResult
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / ChallengeResult
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / ChallengeResultWithCookie
+ - v1.12.5](../README.md) / [Exports](../modules.md) / ChallengeResultWithCookie
 
 # Interface: ChallengeResultWithCookie
 

diff --git a/docs/interfaces/CreateSoulNameResult.md b/docs/interfaces/CreateSoulNameResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.12.3](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / CreditScoreDetails
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / ERC20
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / ERC20Interface
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / GenerateCreditScoreResult
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / GenerateGreenResult
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / GreenDetails
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / ICreditScore
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / IGreen
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / IIdentity
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / IIdentityContracts
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / IPassport
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / ISession
+ - v1.12.5](../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
- - v1.12.3](../README.md) / [Exports](../modules.md) / ISoulName
+ - v1.12.5](../README.md) / [Exports](../modules.md) / ISoulName
 
 # Interface: ISoulName
 
@@ -40,7 +40,7 @@ ___
 
 ### external\_url
 
-• **external\_url**: ``"https://app.getbasecamp.xyz"`` \| ``"https://app.prosperity.global"`` \| ``"https://testnet.app.masa.finance"`` \| ``"https://app.masa.finance"``
+• **external\_url**: ``"https://app.basecamp.global"`` \| ``"https://app.prosperity.global"`` \| ``"https://testnet.app.masa.finance"`` \| ``"https://app.masa.finance"``
 
 ___