added docs

masa-finance · Sep 29, 2023 · b1fbd88 · b1fbd88
1 parent fa0737d
commit b1fbd88
Show file tree

Hide file tree

Showing 72 changed files with 126 additions and 95 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,20 @@ 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).
 
+#### [v3.9.3](https://github.com/masa-finance/masa-sdk/compare/v3.9.2...v3.9.3)
+
+> 29 September 2023
+
+- added soulname renewal steps [`8f5f9f5`](https://github.com/masa-finance/masa-sdk/commit/8f5f9f57e96a0b5cd48b69ec75dc43de0c9b364e)
+
+#### [v3.9.2](https://github.com/masa-finance/masa-sdk/compare/v3.9.1...v3.9.2)
+
+> 27 September 2023
+
+- update docs [`6dd13c8`](https://github.com/masa-finance/masa-sdk/commit/6dd13c8c486c2c60d10fb10ef314b587c9aec7aa)
+- remove skip loading [`d66a549`](https://github.com/masa-finance/masa-sdk/commit/d66a5491cd12f2857999310d842cb830ee48b24c)
+- optimize check exists [`5c919e5`](https://github.com/masa-finance/masa-sdk/commit/5c919e5bf34dd1f980258b93b78386da77aa186a)
+
 #### [v3.9.1](https://github.com/masa-finance/masa-sdk/compare/v3.9.0...v3.9.1)
 
 > 27 September 2023

diff --git a/docs/classes/ASBTContract.md b/docs/classes/ASBTContract.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / ASBTContract
+ - v3.9.3](../README.md) / [Exports](../modules.md) / ASBTContract
 
 # Class: ASBTContract
 

diff --git a/docs/classes/ASBTContractWrapper.md b/docs/classes/ASBTContractWrapper.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / ASBTContractWrapper
+ - v3.9.3](../README.md) / [Exports](../modules.md) / ASBTContractWrapper
 
 # Class: ASBTContractWrapper<Contract\>
 

diff --git a/docs/classes/ContractFactory.md b/docs/classes/ContractFactory.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / ContractFactory
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / CreditScore
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / ERC20\_\_factory
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / Green
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / Identity
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / Masa
+ - v3.9.3](../README.md) / [Exports](../modules.md) / Masa
 
 # Class: Masa
 
@@ -196,13 +196,13 @@ ___
 
 ### create
 
-▸ `Static` **create**(`args`): `Promise`<[`Masa`](Masa.md)\>
+▸ `Static` **create**(`masaArgs`): `Promise`<[`Masa`](Masa.md)\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `args` | [`MasaArgs`](../interfaces/MasaArgs.md) |
+| `masaArgs` | [`MasaArgs`](../interfaces/MasaArgs.md) |
 
 #### Returns
 

diff --git a/docs/classes/MasaASBT.md b/docs/classes/MasaASBT.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaASBT
+ - v3.9.3](../README.md) / [Exports](../modules.md) / MasaASBT
 
 # Class: MasaASBT
 

diff --git a/docs/classes/MasaASBTWrapper.md b/docs/classes/MasaASBTWrapper.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaASBTWrapper
+ - v3.9.3](../README.md) / [Exports](../modules.md) / MasaASBTWrapper
 
 # Class: MasaASBTWrapper<Contract\>
 

diff --git a/docs/classes/MasaAccount.md b/docs/classes/MasaAccount.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaAccount
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaArweave
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaClient
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaContracts
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaCreditScore
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaGreen
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaIdentity
+ - v3.9.3](../README.md) / [Exports](../modules.md) / MasaIdentity
 
 # Class: MasaIdentity
 

diff --git a/docs/classes/MasaSBTBase.md b/docs/classes/MasaSBTBase.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaSBTBase
+ - v3.9.3](../README.md) / [Exports](../modules.md) / MasaSBTBase
 
 # Class: MasaSBTBase
 

diff --git a/docs/classes/MasaSBTWrapper.md b/docs/classes/MasaSBTWrapper.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaSBTWrapper
+ - v3.9.3](../README.md) / [Exports](../modules.md) / MasaSBTWrapper
 
 # Class: MasaSBTWrapper<Contract\>
 

diff --git a/docs/classes/MasaSSSBT.md b/docs/classes/MasaSSSBT.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaSSSBT
+ - v3.9.3](../README.md) / [Exports](../modules.md) / MasaSSSBT
 
 # Class: MasaSSSBT
 

diff --git a/docs/classes/MasaSSSBTWrapper.md b/docs/classes/MasaSSSBTWrapper.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaSSSBTWrapper
+ - v3.9.3](../README.md) / [Exports](../modules.md) / MasaSSSBTWrapper
 
 # Class: MasaSSSBTWrapper<Contract\>
 

diff --git a/docs/classes/MasaSession.md b/docs/classes/MasaSession.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaSession
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaSoulLinker
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / MasaSoulName
+ - v3.9.3](../README.md) / [Exports](../modules.md) / MasaSoulName
 
 # Class: MasaSoulName
 
@@ -28,6 +28,7 @@
 - [loadSoulNameByName](MasaSoulName.md#loadsoulnamebyname)
 - [loadSoulNameByTokenId](MasaSoulName.md#loadsoulnamebytokenid)
 - [loadSoulNames](MasaSoulName.md#loadsoulnames)
+- [renew](MasaSoulName.md#renew)
 - [resolve](MasaSoulName.md#resolve)
 - [send](MasaSoulName.md#send)
 - [tail](MasaSoulName.md#tail)
@@ -172,6 +173,23 @@ ___
 
 ___
 
+### renew
+
+▸ **renew**(`soulName`, `years`): `Promise`<`boolean`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `soulName` | `string` |
+| `years` | `number` |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+___
+
 ### resolve
 
 ▸ **resolve**(`soulName`): `Promise`<`undefined` \| `string`\>

diff --git a/docs/classes/SBTContract.md b/docs/classes/SBTContract.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / SBTContract
+ - v3.9.3](../README.md) / [Exports](../modules.md) / SBTContract
 
 # Class: SBTContract
 

diff --git a/docs/classes/SBTContractWrapper.md b/docs/classes/SBTContractWrapper.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / SBTContractWrapper
+ - v3.9.3](../README.md) / [Exports](../modules.md) / SBTContractWrapper
 
 # Class: SBTContractWrapper<Contract\>
 

diff --git a/docs/classes/SSSBTContract.md b/docs/classes/SSSBTContract.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / SSSBTContract
+ - v3.9.3](../README.md) / [Exports](../modules.md) / SSSBTContract
 
 # Class: SSSBTContract
 

diff --git a/docs/classes/SSSBTContractWrapper.md b/docs/classes/SSSBTContractWrapper.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / SSSBTContractWrapper
+ - v3.9.3](../README.md) / [Exports](../modules.md) / SSSBTContractWrapper
 
 # Class: SSSBTContractWrapper<Contract\>
 

diff --git a/docs/classes/SoulLinker.md b/docs/classes/SoulLinker.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / SoulLinker
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / SoulName
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / SoulNameErrorCodes
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / Addresses
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / ApprovalEventObject
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / Attribute
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / BaseResult
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / ChallengeResult
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / ChallengeResultWithCookie
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / ContractInfo
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / CreditScoreDetails
+ - v3.9.3](../README.md) / [Exports](../modules.md) / CreditScoreDetails
 
 # Interface: CreditScoreDetails
 

diff --git a/docs/interfaces/DeployResult.md b/docs/interfaces/DeployResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / DeployResult
+ - v3.9.3](../README.md) / [Exports](../modules.md) / DeployResult
 
 # Interface: DeployResult<Tuple\>
 

diff --git a/docs/interfaces/ERC20.md b/docs/interfaces/ERC20.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / ERC20
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / ERC20Interface
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / GenerateCreditScoreResult
+ - v3.9.3](../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
- - v3.9.1](../README.md) / [Exports](../modules.md) / GenerateGreenResult
+ - v3.9.3](../README.md) / [Exports](../modules.md) / GenerateGreenResult
 
 # Interface: GenerateGreenResult
 

diff --git a/docs/interfaces/GreenBaseResult.md b/docs/interfaces/GreenBaseResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.9.1](../README.md) / [Exports](../modules.md) / GreenBaseResult
+ - v3.9.3](../README.md) / [Exports](../modules.md) / GreenBaseResult
 
 # Interface: GreenBaseResult
 

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