update: docs

masa-finance · Feb 7, 2024 · 20e76ac · 20e76ac
1 parent 03eee18
commit 20e76ac
Show file tree

Hide file tree

Showing 79 changed files with 136 additions and 80 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -26,13 +26,25 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 > 5 December 2023
 
-#### [v4.0.0-alpha.1](https://github.com/masa-finance/masa-sdk/compare/v3.17.0...v4.0.0-alpha.1)
+#### [v4.0.0-alpha.1](https://github.com/masa-finance/masa-sdk/compare/v3.18.1...v4.0.0-alpha.1)
 
 > 5 December 2023
 
 - feature: optimize error handling with error codes [`996e849`](https://github.com/masa-finance/masa-sdk/commit/996e849b55ff5f333f032c31b7c8312e01aecfb2)
 - feature: error codes [`b1e82b0`](https://github.com/masa-finance/masa-sdk/commit/b1e82b0a319e290f5998a2525db3197989e0b161)
 
+#### [v3.18.1](https://github.com/masa-finance/masa-sdk/compare/v3.18.0...v3.18.1)
+
+> 7 February 2024
+
+- fix: build [`c09aead`](https://github.com/masa-finance/masa-sdk/commit/c09aeadafd0080ba519c27ca3a2f6d98a9fdf21b)
+
+#### [v3.18.0](https://github.com/masa-finance/masa-sdk/compare/v3.17.0...v3.18.0)
+
+> 7 February 2024
+
+- feature (token): added swap functionality [`f7e34ca`](https://github.com/masa-finance/masa-sdk/commit/f7e34ca36767d3b9e57d50e4e222629b9acbc603)
+
 #### [v3.17.0](https://github.com/masa-finance/masa-sdk/compare/v3.16.1...v3.17.0)
 
 > 5 February 2024

diff --git a/docs/classes/ASBTContract.md b/docs/classes/ASBTContract.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.17.0](../README.md) / [Exports](../modules.md) / ASBTContract
+ - v3.18.1](../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.17.0](../README.md) / [Exports](../modules.md) / ASBTContractWrapper
+ - v3.18.1](../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.17.0](../README.md) / [Exports](../modules.md) / ContractFactory
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / CreditScore
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / ERC20\_\_factory
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / Green
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / Identity
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / Masa
+ - v3.18.1](../README.md) / [Exports](../modules.md) / Masa
 
 # Class: Masa
 
@@ -30,6 +30,7 @@
 - [session](Masa.md#session)
 - [soulName](Masa.md#soulname)
 - [sssbt](Masa.md#sssbt)
+- [token](Masa.md#token)
 - [utils](Masa.md#utils)
 
 ### Methods
@@ -196,6 +197,12 @@ ___
 
 ___
 
+### token
+
+• `Readonly` **token**: [`MasaToken`](MasaToken.md)
+
+___
+
 ### utils
 
 • **utils**: `Object`

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

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

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

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

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

diff --git a/docs/classes/MasaGreen.md b/docs/classes/MasaGreen.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.17.0](../README.md) / [Exports](../modules.md) / MasaGreen
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / MasaIdentity
+ - v3.18.1](../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.17.0](../README.md) / [Exports](../modules.md) / MasaSBTBase
+ - v3.18.1](../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.17.0](../README.md) / [Exports](../modules.md) / MasaSBTWrapper
+ - v3.18.1](../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.17.0](../README.md) / [Exports](../modules.md) / MasaSSSBT
+ - v3.18.1](../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.17.0](../README.md) / [Exports](../modules.md) / MasaSSSBTWrapper
+ - v3.18.1](../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.17.0](../README.md) / [Exports](../modules.md) / MasaSession
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / MasaSoulLinker
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / MasaSoulName
+ - v3.18.1](../README.md) / [Exports](../modules.md) / MasaSoulName
 
 # Class: MasaSoulName
 

diff --git a/docs/classes/SBTContract.md b/docs/classes/SBTContract.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.17.0](../README.md) / [Exports](../modules.md) / SBTContract
+ - v3.18.1](../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.17.0](../README.md) / [Exports](../modules.md) / SBTContractWrapper
+ - v3.18.1](../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.17.0](../README.md) / [Exports](../modules.md) / SSSBTContract
+ - v3.18.1](../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.17.0](../README.md) / [Exports](../modules.md) / SSSBTContractWrapper
+ - v3.18.1](../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.17.0](../README.md) / [Exports](../modules.md) / SoulLinker
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / SoulName
+ - v3.18.1](../README.md) / [Exports](../modules.md) / SoulName
 
 # Class: SoulName
 

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

diff --git a/docs/enums/SoulNameErrorCodes.md b/docs/enums/SoulNameErrorCodes.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.17.0](../README.md) / [Exports](../modules.md) / SoulNameErrorCodes
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / Addresses
+ - v3.18.1](../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.17.0](../README.md) / [Exports](../modules.md) / ApprovalEventObject
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / Attribute
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / BaseResult
+ - v3.18.1](../README.md) / [Exports](../modules.md) / BaseResult
 
 # Interface: BaseResult
 

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

diff --git a/docs/interfaces/ChallengeResult.md b/docs/interfaces/ChallengeResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.17.0](../README.md) / [Exports](../modules.md) / ChallengeResult
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / ChallengeResultWithCookie
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / ContractInfo
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / CreditScoreDetails
+ - v3.18.1](../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.17.0](../README.md) / [Exports](../modules.md) / DeployResult
+ - v3.18.1](../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.17.0](../README.md) / [Exports](../modules.md) / ERC20
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / ERC20Interface
+ - v3.18.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
- - v3.17.0](../README.md) / [Exports](../modules.md) / GenerateCreditScoreResult
+ - v3.18.1](../README.md) / [Exports](../modules.md) / GenerateCreditScoreResult
 
 # Interface: GenerateCreditScoreResult