update docs

masa-finance · Jun 16, 2023 · d6c7e7e · d6c7e7e
1 parent 9b08ce2
commit d6c7e7e
Show file tree

Hide file tree

Showing 76 changed files with 240 additions and 848 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,14 @@ 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.4.10](https://github.com/masa-finance/masa-sdk/compare/v3.4.9...v3.4.10)
+
+> 16 June 2023
+
+- update docs [`50d0a9e`](https://github.com/masa-finance/masa-sdk/commit/50d0a9ec1b1ac62ef4e8ea07f9f7d678387d433f)
+- update docs [`765bd06`](https://github.com/masa-finance/masa-sdk/commit/765bd06398242b2d149b3b33b8e571af813dcded)
+- remove cyclic imports [`73e9008`](https://github.com/masa-finance/masa-sdk/commit/73e9008ce5011e20c88e42a2bf74788d8f42a5ce)
+
 #### [v3.4.9](https://github.com/masa-finance/masa-sdk/compare/v3.4.8...v3.4.9)
 
 > 16 June 2023

diff --git a/docs/classes/ASBTContract.md b/docs/classes/ASBTContract.md
@@ -1,11 +1,11 @@
 [# Masa SDK
- - v3.4.9](../README.md) / [Exports](../modules.md) / ASBTContract
+ - v3.4.10](../README.md) / [Exports](../modules.md) / ASBTContract
 
 # Class: ASBTContract
 
 ## Hierarchy
 
-- [`MasaSBTModuleBase`](MasaSBTModuleBase.md)
+- `MasaSBTModuleBase`
 
   ↳ **`ASBTContract`**
 
@@ -49,7 +49,7 @@
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[constructor](MasaSBTModuleBase.md#constructor)
+MasaSBTModuleBase.constructor
 
 ## Properties
 
@@ -59,7 +59,7 @@
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[instances](MasaSBTModuleBase.md#instances)
+MasaSBTModuleBase.instances
 
 ___
 
@@ -69,7 +69,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[masa](MasaSBTModuleBase.md#masa)
+MasaSBTModuleBase.masa
 
 ## Methods
 
@@ -116,7 +116,7 @@ Checks or gives allowance on ERC20 tokens
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[checkOrGiveAllowance](MasaSBTModuleBase.md#checkorgiveallowance)
+MasaSBTModuleBase.checkOrGiveAllowance
 
 ___
 
@@ -159,7 +159,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[createOverrides](MasaSBTModuleBase.md#createoverrides)
+MasaSBTModuleBase.createOverrides
 
 ___
 
@@ -180,7 +180,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[formatPrice](MasaSBTModuleBase.md#formatprice)
+MasaSBTModuleBase.formatPrice
 
 ___
 
@@ -202,7 +202,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[getMintPrice](MasaSBTModuleBase.md#getmintprice)
+MasaSBTModuleBase.getMintPrice
 
 ___
 
@@ -216,7 +216,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[getNetworkFeeInformation](MasaSBTModuleBase.md#getnetworkfeeinformation)
+MasaSBTModuleBase.getNetworkFeeInformation
 
 ___
 
@@ -238,7 +238,7 @@ Gets the payment address for a given payment method
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[getPaymentAddress](MasaSBTModuleBase.md#getpaymentaddress)
+MasaSBTModuleBase.getPaymentAddress
 
 ___
 
@@ -265,7 +265,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[loadSBTContract](MasaSBTModuleBase.md#loadsbtcontract)
+MasaSBTModuleBase.loadSBTContract
 
 ___
 
@@ -293,7 +293,7 @@ verify a signature created during one of the SBT signing flows
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[verify](MasaSBTModuleBase.md#verify)
+MasaSBTModuleBase.verify
 
 ___
 
@@ -316,4 +316,4 @@ adds a percentage to the price as slippage
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[addSlippage](MasaSBTModuleBase.md#addslippage)
+MasaSBTModuleBase.addSlippage
diff --git a/docs/classes/ASBTContractWrapper.md b/docs/classes/ASBTContractWrapper.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.4.9](../README.md) / [Exports](../modules.md) / ASBTContractWrapper
+ - v3.4.10](../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.4.9](../README.md) / [Exports](../modules.md) / ContractFactory
+ - v3.4.10](../README.md) / [Exports](../modules.md) / ContractFactory
 
 # Class: ContractFactory
 

diff --git a/docs/classes/CreditScore.md b/docs/classes/CreditScore.md
@@ -1,11 +1,11 @@
 [# Masa SDK
- - v3.4.9](../README.md) / [Exports](../modules.md) / CreditScore
+ - v3.4.10](../README.md) / [Exports](../modules.md) / CreditScore
 
 # Class: CreditScore
 
 ## Hierarchy
 
-- [`MasaSBTModuleBase`](MasaSBTModuleBase.md)
+- `MasaSBTModuleBase`
 
   ↳ **`CreditScore`**
 
@@ -52,7 +52,7 @@
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[constructor](MasaSBTModuleBase.md#constructor)
+MasaSBTModuleBase.constructor
 
 ## Properties
 
@@ -62,7 +62,7 @@
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[instances](MasaSBTModuleBase.md#instances)
+MasaSBTModuleBase.instances
 
 ___
 
@@ -72,7 +72,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[masa](MasaSBTModuleBase.md#masa)
+MasaSBTModuleBase.masa
 
 ___
 
@@ -125,7 +125,7 @@ Checks or gives allowance on ERC20 tokens
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[checkOrGiveAllowance](MasaSBTModuleBase.md#checkorgiveallowance)
+MasaSBTModuleBase.checkOrGiveAllowance
 
 ___
 
@@ -145,7 +145,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[createOverrides](MasaSBTModuleBase.md#createoverrides)
+MasaSBTModuleBase.createOverrides
 
 ___
 
@@ -166,7 +166,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[formatPrice](MasaSBTModuleBase.md#formatprice)
+MasaSBTModuleBase.formatPrice
 
 ___
 
@@ -188,7 +188,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[getMintPrice](MasaSBTModuleBase.md#getmintprice)
+MasaSBTModuleBase.getMintPrice
 
 ___
 
@@ -202,7 +202,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[getNetworkFeeInformation](MasaSBTModuleBase.md#getnetworkfeeinformation)
+MasaSBTModuleBase.getNetworkFeeInformation
 
 ___
 
@@ -224,7 +224,7 @@ Gets the payment address for a given payment method
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[getPaymentAddress](MasaSBTModuleBase.md#getpaymentaddress)
+MasaSBTModuleBase.getPaymentAddress
 
 ___
 
@@ -270,7 +270,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[loadSBTContract](MasaSBTModuleBase.md#loadsbtcontract)
+MasaSBTModuleBase.loadSBTContract
 
 ___
 
@@ -339,7 +339,7 @@ verify a signature created during one of the SBT signing flows
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[verify](MasaSBTModuleBase.md#verify)
+MasaSBTModuleBase.verify
 
 ___
 
@@ -362,4 +362,4 @@ adds a percentage to the price as slippage
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[addSlippage](MasaSBTModuleBase.md#addslippage)
+MasaSBTModuleBase.addSlippage
diff --git a/docs/classes/ERC20__factory.md b/docs/classes/ERC20__factory.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.4.9](../README.md) / [Exports](../modules.md) / ERC20\_\_factory
+ - v3.4.10](../README.md) / [Exports](../modules.md) / ERC20\_\_factory
 
 # Class: ERC20\_\_factory
 

diff --git a/docs/classes/Green.md b/docs/classes/Green.md
@@ -1,11 +1,11 @@
 [# Masa SDK
- - v3.4.9](../README.md) / [Exports](../modules.md) / Green
+ - v3.4.10](../README.md) / [Exports](../modules.md) / Green
 
 # Class: Green
 
 ## Hierarchy
 
-- [`MasaSBTModuleBase`](MasaSBTModuleBase.md)
+- `MasaSBTModuleBase`
 
   ↳ **`Green`**
 
@@ -52,7 +52,7 @@
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[constructor](MasaSBTModuleBase.md#constructor)
+MasaSBTModuleBase.constructor
 
 ## Properties
 
@@ -62,7 +62,7 @@
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[instances](MasaSBTModuleBase.md#instances)
+MasaSBTModuleBase.instances
 
 ___
 
@@ -72,7 +72,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[masa](MasaSBTModuleBase.md#masa)
+MasaSBTModuleBase.masa
 
 ___
 
@@ -125,7 +125,7 @@ Checks or gives allowance on ERC20 tokens
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[checkOrGiveAllowance](MasaSBTModuleBase.md#checkorgiveallowance)
+MasaSBTModuleBase.checkOrGiveAllowance
 
 ___
 
@@ -145,7 +145,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[createOverrides](MasaSBTModuleBase.md#createoverrides)
+MasaSBTModuleBase.createOverrides
 
 ___
 
@@ -166,7 +166,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[formatPrice](MasaSBTModuleBase.md#formatprice)
+MasaSBTModuleBase.formatPrice
 
 ___
 
@@ -188,7 +188,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[getMintPrice](MasaSBTModuleBase.md#getmintprice)
+MasaSBTModuleBase.getMintPrice
 
 ___
 
@@ -202,7 +202,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[getNetworkFeeInformation](MasaSBTModuleBase.md#getnetworkfeeinformation)
+MasaSBTModuleBase.getNetworkFeeInformation
 
 ___
 
@@ -224,7 +224,7 @@ Gets the payment address for a given payment method
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[getPaymentAddress](MasaSBTModuleBase.md#getpaymentaddress)
+MasaSBTModuleBase.getPaymentAddress
 
 ___
 
@@ -270,7 +270,7 @@ ___
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[loadSBTContract](MasaSBTModuleBase.md#loadsbtcontract)
+MasaSBTModuleBase.loadSBTContract
 
 ___
 
@@ -339,7 +339,7 @@ verify a signature created during one of the SBT signing flows
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[verify](MasaSBTModuleBase.md#verify)
+MasaSBTModuleBase.verify
 
 ___
 
@@ -362,4 +362,4 @@ adds a percentage to the price as slippage
 
 #### Inherited from
 
-[MasaSBTModuleBase](MasaSBTModuleBase.md).[addSlippage](MasaSBTModuleBase.md#addslippage)
+MasaSBTModuleBase.addSlippage