update docs

masa-finance · Jun 12, 2023 · 1043887 · 1043887
1 parent 4ce7662
commit 1043887
Show file tree

Hide file tree

Showing 66 changed files with 794 additions and 749 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,19 @@ 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.3.0](https://github.com/masa-finance/masa-sdk/compare/v3.2.3...v3.3.0)
+
+> 12 June 2023
+
+- Bump @typescript-eslint/eslint-plugin from 5.59.8 to 5.59.9 [`#95`](https://github.com/masa-finance/masa-sdk/pull/95)
+- Bump typescript from 5.0.4 to 5.1.3 [`#97`](https://github.com/masa-finance/masa-sdk/pull/97)
+- Bump @typescript-eslint/parser from 5.59.8 to 5.59.9 [`#96`](https://github.com/masa-finance/masa-sdk/pull/96)
+- Bump webpack-cli from 5.1.1 to 5.1.4 [`#98`](https://github.com/masa-finance/masa-sdk/pull/98)
+- Bump webpack from 5.85.0 to 5.86.0 [`#99`](https://github.com/masa-finance/masa-sdk/pull/99)
+- moved sbt contract interaction code to the contracts section [`385dfcc`](https://github.com/masa-finance/masa-sdk/commit/385dfcc665c7cff6d42075ffb3232eb1438194ef)
+- refactor [`0743943`](https://github.com/masa-finance/masa-sdk/commit/074394354a32474c34cf4e53eb0f8bc4e9656d58)
+- refactor [`f806ced`](https://github.com/masa-finance/masa-sdk/commit/f806ced3e807021f75204f0a0a31cf03483fee5d)
+
 #### [v3.2.3](https://github.com/masa-finance/masa-sdk/compare/v3.2.2...v3.2.3)
 
 > 8 June 2023

diff --git a/docs/classes/ASBTWrapper.md b/docs/classes/ASBTWrapper.md
@@ -1,17 +1,11 @@
 [# Masa SDK
- - v3.2.3](../README.md) / [Exports](../modules.md) / ASBTWrapper
+ - v3.3.0](../README.md) / [Exports](../modules.md) / ASBTWrapper
 
-# Class: ASBTWrapper<Contract\>
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `Contract` | extends `ReferenceSBTAuthority` |
+# Class: ASBTWrapper
 
 ## Hierarchy
 
-- [`SBTWrapper`](SBTWrapper.md)<`Contract`\>
+- [`SBTWrapper`](SBTWrapper.md)<`ReferenceSBTAuthority`\>
 
   ↳ **`ASBTWrapper`**
 
@@ -37,20 +31,14 @@
 
 ### constructor
 
-• **new ASBTWrapper**<`Contract`\>(`masa`, `contract`)
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `Contract` | extends `ReferenceSBTAuthority`<`Contract`\> |
+• **new ASBTWrapper**(`masa`, `contract`)
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `masa` | [`Masa`](Masa.md) |
-| `contract` | `Contract` |
+| `masa` | [`MasaInterface`](../interfaces/MasaInterface.md) |
+| `contract` | `ReferenceSBTAuthority` |
 
 #### Inherited from
 
@@ -60,7 +48,7 @@
 
 ### contract
 
-• `Readonly` **contract**: `Contract`
+• `Readonly` **contract**: `ReferenceSBTAuthority`
 
 #### Inherited from
 
@@ -80,7 +68,7 @@ ___
 
 ### masa
 
-• `Protected` `Readonly` **masa**: [`Masa`](Masa.md)
+• `Protected` `Readonly` **masa**: [`MasaInterface`](../interfaces/MasaInterface.md)
 
 #### Inherited from
 

diff --git a/docs/classes/ContractFactory.md b/docs/classes/ContractFactory.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.2.3](../README.md) / [Exports](../modules.md) / ContractFactory
+ - v3.3.0](../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.2.3](../README.md) / [Exports](../modules.md) / CreditScore
+ - v3.3.0](../README.md) / [Exports](../modules.md) / CreditScore
 
 # Class: CreditScore
 
@@ -23,17 +23,17 @@
 
 ### Methods
 
-- [addSlippage](CreditScore.md#addslippage)
 - [burn](CreditScore.md#burn)
 - [checkOrGiveAllowance](CreditScore.md#checkorgiveallowance)
 - [formatPrice](CreditScore.md#formatprice)
 - [getMintPrice](CreditScore.md#getmintprice)
 - [getPaymentAddress](CreditScore.md#getpaymentaddress)
 - [getPrice](CreditScore.md#getprice)
-- [loadSBTContract](CreditScore.md#loadsbtcontract)
 - [mint](CreditScore.md#mint)
 - [sign](CreditScore.md#sign)
 - [verify](CreditScore.md#verify)
+- [addSlippage](CreditScore.md#addslippage)
+- [loadSBTContract](CreditScore.md#loadsbtcontract)
 
 ## Constructors
 
@@ -45,7 +45,7 @@
 
 | Name | Type |
 | :------ | :------ |
-| `masa` | [`Masa`](Masa.md) |
+| `masa` | [`MasaInterface`](../interfaces/MasaInterface.md) |
 | `instances` | [`IIdentityContracts`](../interfaces/IIdentityContracts.md) |
 
 #### Inherited from
@@ -66,7 +66,7 @@ ___
 
 ### masa
 
-• `Protected` `Readonly` **masa**: [`Masa`](Masa.md)
+• `Protected` `Readonly` **masa**: [`MasaInterface`](../interfaces/MasaInterface.md)
 
 #### Inherited from
 
@@ -86,29 +86,6 @@ ___
 
 ## Methods
 
-### addSlippage
-
-▸ `Protected` **addSlippage**(`price`, `slippage`): `BigNumber`
-
-adds a percentage to the price as slippage
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `price` | `BigNumber` |
-| `slippage` | `number` |
-
-#### Returns
-
-`BigNumber`
-
-#### Inherited from
-
-[MasaModuleBase](MasaModuleBase.md).[addSlippage](MasaModuleBase.md#addslippage)
-
-___
-
 ### burn
 
 ▸ **burn**(`creditScoreId`): `Promise`<`boolean`\>
@@ -180,7 +157,7 @@ ___
 | Name | Type | Default value |
 | :------ | :------ | :------ |
 | `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `undefined` |
-| `contract` | `MasaSBT` \| `MasaSBTSelfSovereign` \| `MasaSBTAuthority` | `undefined` |
+| `contract` | `MasaSBTSelfSovereign` \| `MasaSBTAuthority` \| `MasaSBT` | `undefined` |
 | `slippage` | `undefined` \| `number` | `250` |
 
 #### Returns
@@ -234,34 +211,6 @@ gets the price for a credit score
 
 ___
 
-### loadSBTContract
-
-▸ `Protected` **loadSBTContract**<`Contract`\>(`masaConfig`, `address`, `factory`): `Promise`<`Contract`\>
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `Contract` | extends `MasaSBT` \| `MasaSBTSelfSovereign` \| `MasaSBTAuthority` |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `masaConfig` | [`MasaConfig`](../interfaces/MasaConfig.md) |
-| `address` | `string` |
-| `factory` | [`ContractFactory`](ContractFactory.md) |
-
-#### Returns
-
-`Promise`<`Contract`\>
-
-#### Inherited from
-
-[MasaModuleBase](MasaModuleBase.md).[loadSBTContract](MasaModuleBase.md#loadsbtcontract)
-
-___
-
 ### mint
 
 ▸ **mint**(`paymentMethod`, `identityId`, `authorityAddress`, `signatureDate`, `signature`, `slippage?`): `Promise`<`ContractTransaction`\>
@@ -314,7 +263,7 @@ verify a signature created during one of the SBT signing flows
 | Name | Type |
 | :------ | :------ |
 | `errorMessage` | `string` |
-| `contract` | `MasaSBT` \| `MasaSBTSelfSovereign` \| `MasaSBTAuthority` \| `SoulLinker` \| `SoulStore` |
+| `contract` | `SoulLinker` \| `SoulStore` \| `MasaSBTSelfSovereign` \| `MasaSBTAuthority` \| `MasaSBT` |
 | `domain` | `TypedDataDomain` |
 | `types` | `Record`<`string`, `TypedDataField`[]\> |
 | `value` | `Record`<`string`, `string` \| `number` \| `BigNumber`\> |
@@ -328,3 +277,54 @@ verify a signature created during one of the SBT signing flows
 #### Inherited from
 
 [MasaModuleBase](MasaModuleBase.md).[verify](MasaModuleBase.md#verify)
+
+___
+
+### addSlippage
+
+▸ `Static` `Protected` **addSlippage**(`price`, `slippage`): `BigNumber`
+
+adds a percentage to the price as slippage
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `price` | `BigNumber` |
+| `slippage` | `number` |
+
+#### Returns
+
+`BigNumber`
+
+#### Inherited from
+
+[MasaModuleBase](MasaModuleBase.md).[addSlippage](MasaModuleBase.md#addslippage)
+
+___
+
+### loadSBTContract
+
+▸ `Static` `Protected` **loadSBTContract**<`Contract`\>(`masaConfig`, `address`, `factory`): `Promise`<`Contract`\>
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Contract` | extends `MasaSBTSelfSovereign` \| `MasaSBTAuthority` \| `MasaSBT` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `masaConfig` | [`MasaConfig`](../interfaces/MasaConfig.md) |
+| `address` | `string` |
+| `factory` | [`ContractFactory`](ContractFactory.md) |
+
+#### Returns
+
+`Promise`<`Contract`\>
+
+#### Inherited from
+
+[MasaModuleBase](MasaModuleBase.md).[loadSBTContract](MasaModuleBase.md#loadsbtcontract)
diff --git a/docs/classes/ERC20__factory.md b/docs/classes/ERC20__factory.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v3.2.3](../README.md) / [Exports](../modules.md) / ERC20\_\_factory
+ - v3.3.0](../README.md) / [Exports](../modules.md) / ERC20\_\_factory
 
 # Class: ERC20\_\_factory