update docs

masa-finance · Mar 23, 2023 · aebfc18 · aebfc18
1 parent f4cf82e
commit aebfc18
Show file tree

Hide file tree

Showing 41 changed files with 150 additions and 74 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).
 
+#### [v1.10.5](https://github.com/masa-finance/masa-sdk/compare/v1.10.4...v1.10.5)
+
+> 23 March 2023
+
+- fixed 0 and decimal handling [`40eaaa2`](https://github.com/masa-finance/masa-sdk/commit/40eaaa2883acae79d438981e587670ec2e2714a9)
+
+#### [v1.10.4](https://github.com/masa-finance/masa-sdk/compare/v1.10.3...v1.10.4)
+
+> 23 March 2023
+
+- updated multi currency support [`b75089c`](https://github.com/masa-finance/masa-sdk/commit/b75089cab54854513b7a44a4618f8e22c5e756d6)
+- update docs [`94104e9`](https://github.com/masa-finance/masa-sdk/commit/94104e91e94b16bb090e79bc8e4bc89beaf72065)
+- added test for regex control chars [`6818a06`](https://github.com/masa-finance/masa-sdk/commit/6818a062c56f5253f3e9de9c2f2e34d51a0d7211)
+
 #### [v1.10.3](https://github.com/masa-finance/masa-sdk/compare/v1.10.2...v1.10.3)
 
 > 21 March 2023

diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,5 @@
 # Masa SDK
- - v1.10.3 / [Exports](modules.md)
+ - v1.10.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.10.3](../README.md) / [Exports](../modules.md) / ContractFactory
+ - v1.10.5](../README.md) / [Exports](../modules.md) / ContractFactory
 
 # Class: ContractFactory
 

diff --git a/docs/classes/Masa.md b/docs/classes/Masa.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / Masa
+ - v1.10.5](../README.md) / [Exports](../modules.md) / Masa
 
 # Class: Masa
 

diff --git a/docs/classes/MasaAccount.md b/docs/classes/MasaAccount.md
@@ -1,8 +1,14 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / MasaAccount
+ - v1.10.5](../README.md) / [Exports](../modules.md) / MasaAccount
 
 # Class: MasaAccount
 
+## Hierarchy
+
+- `MasaBase`
+
+  ↳ **`MasaAccount`**
+
 ## Table of contents
 
 ### Constructors
@@ -11,7 +17,7 @@
 
 ### Properties
 
-- [mass](MasaAccount.md#mass)
+- [masa](MasaAccount.md#masa)
 
 ### Methods
 
@@ -21,25 +27,33 @@
 
 ### constructor
 
-• **new MasaAccount**(`mass`)
+• **new MasaAccount**(`masa`)
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `mass` | [`Masa`](Masa.md) |
+| `masa` | [`Masa`](Masa.md) |
+
+#### Inherited from
+
+MasaBase.constructor
 
 ## Properties
 
-### mass
+### masa
+
+• `Protected` **masa**: [`Masa`](Masa.md)
+
+#### Inherited from
 
-• `Private` **mass**: [`Masa`](Masa.md)
+MasaBase.masa
 
 ## Methods
 
 ### getBalances
 
-▸ **getBalances**(`address?`): `Promise`<`undefined` \| { `ethBalance`: `BigNumber` ; `identityBalance`: `BigNumber` ; `masaBalance`: `BigNumber` ; `soulNameBalance`: `BigNumber` ; `soulboundCreditScoreBalance`: `BigNumber` ; `soulboundGreenBalance`: `BigNumber` ; `usdcBalance`: `BigNumber` ; `wethBalance`: `BigNumber`  }\>
+▸ **getBalances**(`address?`): `Promise`<`Partial`<{ `CELO`: `undefined` \| `number` ; `CreditScore`: `undefined` \| `number` ; `ETH`: `undefined` \| `number` ; `G$`: `undefined` \| `number` ; `Green`: `undefined` \| `number` ; `Identity`: `undefined` \| `number` ; `MASA`: `undefined` \| `number` ; `Native`: `undefined` \| `number` ; `SoulName`: `undefined` \| `number` ; `USDC`: `undefined` \| `number` ; `WETH`: `undefined` \| `number` ; `cUSD`: `undefined` \| `number`  }\>\>
 
 #### Parameters
 
@@ -49,4 +63,4 @@
 
 #### Returns
 
-`Promise`<`undefined` \| { `ethBalance`: `BigNumber` ; `identityBalance`: `BigNumber` ; `masaBalance`: `BigNumber` ; `soulNameBalance`: `BigNumber` ; `soulboundCreditScoreBalance`: `BigNumber` ; `soulboundGreenBalance`: `BigNumber` ; `usdcBalance`: `BigNumber` ; `wethBalance`: `BigNumber`  }\>
+`Promise`<`Partial`<{ `CELO`: `undefined` \| `number` ; `CreditScore`: `undefined` \| `number` ; `ETH`: `undefined` \| `number` ; `G$`: `undefined` \| `number` ; `Green`: `undefined` \| `number` ; `Identity`: `undefined` \| `number` ; `MASA`: `undefined` \| `number` ; `Native`: `undefined` \| `number` ; `SoulName`: `undefined` \| `number` ; `USDC`: `undefined` \| `number` ; `WETH`: `undefined` \| `number` ; `cUSD`: `undefined` \| `number`  }\>\>
diff --git a/docs/classes/MasaArweave.md b/docs/classes/MasaArweave.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / MasaArweave
+ - v1.10.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.10.3](../README.md) / [Exports](../modules.md) / MasaClient
+ - v1.10.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.10.3](../README.md) / [Exports](../modules.md) / MasaContracts
+ - v1.10.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.10.3](../README.md) / [Exports](../modules.md) / MasaCreditScore
+ - v1.10.5](../README.md) / [Exports](../modules.md) / MasaCreditScore
 
 # Class: MasaCreditScore
 
@@ -85,7 +85,7 @@ ___
 
 | Name | Type | Default value |
 | :------ | :------ | :------ |
-| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"eth"` |
+| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"ETH"` |
 
 #### Returns
 

diff --git a/docs/classes/MasaGreen.md b/docs/classes/MasaGreen.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / MasaGreen
+ - v1.10.5](../README.md) / [Exports](../modules.md) / MasaGreen
 
 # Class: MasaGreen
 
@@ -92,7 +92,7 @@ Does the verification and mint step in one go
 
 | Name | Type | Default value |
 | :------ | :------ | :------ |
-| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"eth"` |
+| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"ETH"` |
 | `phoneNumber` | `string` | `undefined` |
 | `code` | `string` | `undefined` |
 
@@ -166,7 +166,7 @@ Mints a green based on the previously made verification result
 
 | Name | Type | Default value |
 | :------ | :------ | :------ |
-| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"eth"` |
+| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"ETH"` |
 | `authorityAddress` | `string` | `undefined` |
 | `signatureDate` | `number` | `undefined` |
 | `signature` | `string` | `undefined` |

diff --git a/docs/classes/MasaIdentity.md b/docs/classes/MasaIdentity.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / MasaIdentity
+ - v1.10.5](../README.md) / [Exports](../modules.md) / MasaIdentity
 
 # Class: MasaIdentity
 

diff --git a/docs/classes/MasaSBT.md b/docs/classes/MasaSBT.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / MasaSBT
+ - v1.10.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.10.3](../README.md) / [Exports](../modules.md) / MasaSession
+ - v1.10.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.10.3](../README.md) / [Exports](../modules.md) / MasaSoulLinker
+ - v1.10.5](../README.md) / [Exports](../modules.md) / MasaSoulLinker
 
 # Class: MasaSoulLinker
 
@@ -106,7 +106,7 @@ ___
 
 | Name | Type | Default value |
 | :------ | :------ | :------ |
-| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"eth"` |
+| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"ETH"` |
 | `passport` | `string` | `undefined` |
 
 #### Returns

diff --git a/docs/classes/MasaSoulName.md b/docs/classes/MasaSoulName.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / MasaSoulName
+ - v1.10.5](../README.md) / [Exports](../modules.md) / MasaSoulName
 
 # Class: MasaSoulName
 
@@ -86,7 +86,7 @@ ___
 
 | Name | Type | Default value |
 | :------ | :------ | :------ |
-| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"eth"` |
+| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"ETH"` |
 | `soulName` | `string` | `undefined` |
 | `duration` | `number` | `undefined` |
 | `receiver?` | `string` | `undefined` |
@@ -105,7 +105,7 @@ ___
 
 | Name | Type | Default value |
 | :------ | :------ | :------ |
-| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"eth"` |
+| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `"ETH"` |
 | `soulName` | `string` | `undefined` |
 | `duration` | `number` | `undefined` |
 

diff --git a/docs/interfaces/Addresses.md b/docs/interfaces/Addresses.md
@@ -1,30 +1,22 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / Addresses
+ - v1.10.5](../README.md) / [Exports](../modules.md) / Addresses
 
 # Interface: Addresses
 
 ## Table of contents
 
 ### Properties
 
-- [MASA](Addresses.md#masa)
 - [SoulLinkerAddress](Addresses.md#soullinkeraddress)
 - [SoulNameAddress](Addresses.md#soulnameaddress)
 - [SoulStoreAddress](Addresses.md#soulstoreaddress)
 - [SoulboundCreditScoreAddress](Addresses.md#soulboundcreditscoreaddress)
 - [SoulboundGreenAddress](Addresses.md#soulboundgreenaddress)
 - [SoulboundIdentityAddress](Addresses.md#soulboundidentityaddress)
-- [USDC](Addresses.md#usdc)
-- [WETH](Addresses.md#weth)
+- [tokens](Addresses.md#tokens)
 
 ## Properties
 
-### MASA
-
-• `Optional` **MASA**: `string`
-
-___
-
 ### SoulLinkerAddress
 
 • `Optional` **SoulLinkerAddress**: `string`
@@ -61,12 +53,6 @@ ___
 
 ___
 
-### USDC
-
-• `Optional` **USDC**: `string`
-
-___
-
-### WETH
+### tokens
 
-• `Optional` **WETH**: `string`
+• `Optional` **tokens**: `Partial`<{ `CELO`: `string` ; `ETH`: `string` ; `G$`: `string` ; `MASA`: `string` ; `USDC`: `string` ; `WETH`: `string` ; `cUSD`: `string`  }\>
diff --git a/docs/interfaces/Attribute.md b/docs/interfaces/Attribute.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / Attribute
+ - v1.10.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.10.3](../README.md) / [Exports](../modules.md) / BaseResult
+ - v1.10.5](../README.md) / [Exports](../modules.md) / BaseResult
 
 # Interface: BaseResult
 

diff --git a/docs/interfaces/CreateSoulNameResult.md b/docs/interfaces/CreateSoulNameResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
+ - v1.10.5](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
 
 # Interface: CreateSoulNameResult
 

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

diff --git a/docs/interfaces/GetChallengeResult.md b/docs/interfaces/GetChallengeResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / GetChallengeResult
+ - v1.10.5](../README.md) / [Exports](../modules.md) / GetChallengeResult
 
 # Interface: GetChallengeResult
 

diff --git a/docs/interfaces/ICreditScore.md b/docs/interfaces/ICreditScore.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / ICreditScore
+ - v1.10.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.10.3](../README.md) / [Exports](../modules.md) / IGreen
+ - v1.10.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.10.3](../README.md) / [Exports](../modules.md) / IIdentity
+ - v1.10.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.10.3](../README.md) / [Exports](../modules.md) / IIdentityContracts
+ - v1.10.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.10.3](../README.md) / [Exports](../modules.md) / IPassport
+ - v1.10.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.10.3](../README.md) / [Exports](../modules.md) / ISession
+ - v1.10.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.10.3](../README.md) / [Exports](../modules.md) / ISoulName
+ - v1.10.5](../README.md) / [Exports](../modules.md) / ISoulName
 
 # Interface: ISoulName
 

diff --git a/docs/interfaces/LoadContractArgs.md b/docs/interfaces/LoadContractArgs.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / LoadContractArgs
+ - v1.10.5](../README.md) / [Exports](../modules.md) / LoadContractArgs
 
 # Interface: LoadContractArgs
 

diff --git a/docs/interfaces/LogoutResult.md b/docs/interfaces/LogoutResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / LogoutResult
+ - v1.10.5](../README.md) / [Exports](../modules.md) / LogoutResult
 
 # Interface: LogoutResult
 

diff --git a/docs/interfaces/MasaArgs.md b/docs/interfaces/MasaArgs.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v1.10.3](../README.md) / [Exports](../modules.md) / MasaArgs
+ - v1.10.5](../README.md) / [Exports](../modules.md) / MasaArgs
 
 # Interface: MasaArgs