Skip to content

Commit

Permalink
added docs
Browse files Browse the repository at this point in the history
  • Loading branch information
H34D committed May 25, 2023
1 parent db8b540 commit 93bf803
Show file tree
Hide file tree
Showing 9 changed files with 173 additions and 53 deletions.
62 changes: 62 additions & 0 deletions CHANGELOG.md
Expand Up @@ -4,6 +4,68 @@ 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).

#### [v2.2.1](https://github.com/masa-finance/masa-react/compare/v2.2.0...v2.2.1)

> 25 May 2023
- Bump tsconfig-paths-webpack-plugin from 3.5.2 to 4.0.1 [`#181`](https://github.com/masa-finance/masa-react/pull/181)
- Bump node-sass from 8.0.0 to 9.0.0 [`#182`](https://github.com/masa-finance/masa-react/pull/182)
- Feature/soul name overrides [`#180`](https://github.com/masa-finance/masa-react/pull/180)

#### [v2.2.0](https://github.com/masa-finance/masa-react/compare/v2.2.0-alpha.3...v2.2.0)

> 25 May 2023
- feat: add wallet connect, chore: better linting [`#179`](https://github.com/masa-finance/masa-react/pull/179)
- fix merge conflicts [`649eec7`](https://github.com/masa-finance/masa-react/commit/649eec7ad07bb86c47ed664b2146ac08fe2ed983)
- fix(build): remove modal css revert, correct css build for phone number [`95f400e`](https://github.com/masa-finance/masa-react/commit/95f400e16b54c9cbba5e8fe5ff575147f82c0a29)
- chore(refactor): lint all but components and custom sbts [`ad7e0bb`](https://github.com/masa-finance/masa-react/commit/ad7e0bb66d1fabef5b5e025e74726708bff2768c)

#### [v2.2.0-alpha.3](https://github.com/masa-finance/masa-react/compare/v2.2.0-alpha.2...v2.2.0-alpha.3)

> 25 May 2023
- added soul name styles [`afa9da7`](https://github.com/masa-finance/masa-react/commit/afa9da70934089716b708ae8848f5f9e8390710b)

#### [v2.2.0-alpha.2](https://github.com/masa-finance/masa-react/compare/v2.2.0-alpha.1...v2.2.0-alpha.2)

> 25 May 2023
- added soul name styles [`c6cec1d`](https://github.com/masa-finance/masa-react/commit/c6cec1df5161357bef8747f14956de874e03c339)
- update sdk [`e3361c7`](https://github.com/masa-finance/masa-react/commit/e3361c78455093d04e4b1d97f3168b9251be1841)

#### [v2.2.0-alpha.1](https://github.com/masa-finance/masa-react/compare/v2.1.0...v2.2.0-alpha.1)

> 25 May 2023
- make soul names overridable [`7dab67a`](https://github.com/masa-finance/masa-react/commit/7dab67a896459aea8d951617bd6b18c36f334fa2)

#### [v2.1.0](https://github.com/masa-finance/masa-react/compare/v2.1.0-alpha-6...v2.1.0)

> 25 May 2023
#### [v2.1.0-alpha-6](https://github.com/masa-finance/masa-react/compare/v2.1.0-alpha-5...v2.1.0-alpha-6)

> 25 May 2023
- fix(build): remove modal css revert, correct css build for phone number [`95f400e`](https://github.com/masa-finance/masa-react/commit/95f400e16b54c9cbba5e8fe5ff575147f82c0a29)

#### [v2.1.0-alpha-5](https://github.com/masa-finance/masa-react/compare/v2.1.0-alpha-4...v2.1.0-alpha-5)

> 25 May 2023
- chore(refactor): cleanup [`38cdca9`](https://github.com/masa-finance/masa-react/commit/38cdca9b2fc84b81bdd48a3b3e2d8bab2dfc7b40)
- feat(walletconnect): better switch chain modal, add wallet name [`20487c8`](https://github.com/masa-finance/masa-react/commit/20487c83e9195ba3e4b9b9519368eabd37dc6ea1)
- fix(account): invalidate account address when logging out [`b2dca71`](https://github.com/masa-finance/masa-react/commit/b2dca7116d149fc0f485d8dfa77d5c703bb9f108)

#### [v2.1.0-alpha-4](https://github.com/masa-finance/masa-react/compare/v2.1.0-alpha-3...v2.1.0-alpha-4)

> 24 May 2023
- feat(walletconnect): update rainbowkit & wagmi dependencies, update network switching [`e319b75`](https://github.com/masa-finance/masa-react/commit/e319b75eecdb2fddd4f44f49f5e147a81e18bc93)
- update docs [`53dd65d`](https://github.com/masa-finance/masa-react/commit/53dd65d5d953da6cff93c0ecfe5eb02e2ded3f1f)
- update sdk [`17380de`](https://github.com/masa-finance/masa-react/commit/17380de56916bb060a2b457270e2fd654cbae87e)

#### [v2.1.0-alpha-3](https://github.com/masa-finance/masa-react/compare/v2.1.0-alpha-2...v2.1.0-alpha-3)

> 24 May 2023
Expand Down
2 changes: 1 addition & 1 deletion docs/enums/SoulNameErrorCodes.md
@@ -1,5 +1,5 @@
[# Masa React
- v2.0.6](../README.md) / [Exports](../modules.md) / SoulNameErrorCodes
- v2.2.1](../README.md) / [Exports](../modules.md) / SoulNameErrorCodes

# Enumeration: SoulNameErrorCodes

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/ArweaveConfig.md
@@ -1,5 +1,5 @@
[# Masa React
- v2.0.6](../README.md) / [Exports](../modules.md) / ArweaveConfig
- v2.2.1](../README.md) / [Exports](../modules.md) / ArweaveConfig

# Interface: ArweaveConfig

Expand Down
61 changes: 44 additions & 17 deletions docs/interfaces/MasaContextProviderProps.md
@@ -1,5 +1,5 @@
[# Masa React
- v2.0.6](../README.md) / [Exports](../modules.md) / MasaContextProviderProps
- v2.2.1](../README.md) / [Exports](../modules.md) / MasaContextProviderProps

# Interface: MasaContextProviderProps

Expand All @@ -19,11 +19,12 @@
- [areScopesFullfiled](MasaContextProviderProps.md#arescopesfullfiled)
- [arweaveConfig](MasaContextProviderProps.md#arweaveconfig)
- [badges](MasaContextProviderProps.md#badges)
- [chainsToUse](MasaContextProviderProps.md#chainstouse)
- [canProgramaticallySwitchNetwork](MasaContextProviderProps.md#canprogramaticallyswitchnetwork)
- [children](MasaContextProviderProps.md#children)
- [closeModal](MasaContextProviderProps.md#closemodal)
- [company](MasaContextProviderProps.md#company)
- [connect](MasaContextProviderProps.md#connect)
- [contractAddressOverrides](MasaContextProviderProps.md#contractaddressoverrides)
- [creditScores](MasaContextProviderProps.md#creditscores)
- [currentNetwork](MasaContextProviderProps.md#currentnetwork)
- [currentNetworkNew](MasaContextProviderProps.md#currentnetworknew)
Expand Down Expand Up @@ -60,7 +61,6 @@
- [logout](MasaContextProviderProps.md#logout)
- [masa](MasaContextProviderProps.md#masa)
- [modalSize](MasaContextProviderProps.md#modalsize)
- [noWallet](MasaContextProviderProps.md#nowallet)
- [openAccountModal](MasaContextProviderProps.md#openaccountmodal)
- [openAuthenticateModal](MasaContextProviderProps.md#openauthenticatemodal)
- [openChainModal](MasaContextProviderProps.md#openchainmodal)
Expand All @@ -87,6 +87,7 @@
- [setRainbowkKitModalCallback](MasaContextProviderProps.md#setrainbowkkitmodalcallback)
- [setSigner](MasaContextProviderProps.md#setsigner)
- [signer](MasaContextProviderProps.md#signer)
- [soulNameStyle](MasaContextProviderProps.md#soulnamestyle)
- [soulnames](MasaContextProviderProps.md#soulnames)
- [switchNetwork](MasaContextProviderProps.md#switchnetwork)
- [switchNetworkNew](MasaContextProviderProps.md#switchnetworknew)
Expand All @@ -95,7 +96,7 @@
- [useRainbowKitWalletConnect](MasaContextProviderProps.md#userainbowkitwalletconnect)
- [verbose](MasaContextProviderProps.md#verbose)
- [walletAddress](MasaContextProviderProps.md#walletaddress)
- [walletsToUse](MasaContextProviderProps.md#walletstouse)
- [walletName](MasaContextProviderProps.md#walletname)

## Properties

Expand Down Expand Up @@ -151,9 +152,13 @@ ___

___

### chainsToUse
### canProgramaticallySwitchNetwork

`Optional` **chainsToUse**: (``"goerli"`` \| ``"ethereum"`` \| ``"alfajores"`` \| ``"celo"`` \| ``"mumbai"`` \| ``"polygon"`` \| ``"bsctest"`` \| ``"bsc"`` \| ``"basegoerli"`` \| ``"unknown"``)[]
`Optional` **canProgramaticallySwitchNetwork**: `boolean`

#### Inherited from

[MasaShape](MasaShape.md).[canProgramaticallySwitchNetwork](MasaShape.md#canprogramaticallyswitchnetwork)

___

Expand Down Expand Up @@ -227,6 +232,19 @@ ___

___

### contractAddressOverrides

`Optional` **contractAddressOverrides**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `SoulNameAddress` | `string` |
| `SoulStoreAddress` | `string` |

___

### creditScores

`Optional` **creditScores**: { `metadata?`: `ICreditScore` ; `tokenId`: `BigNumber` ; `tokenUri`: `string` }[]
Expand Down Expand Up @@ -478,11 +496,11 @@ ___

### handlePurchaseIdentityWithSoulname

`Optional` **handlePurchaseIdentityWithSoulname**: (`paymentMethod`: `PaymentMethod`, `soulname`: `string`, `registrationPrice`: `number`) => `Promise`<`boolean`\>
`Optional` **handlePurchaseIdentityWithSoulname**: (`paymentMethod`: `PaymentMethod`, `soulname`: `string`, `registrationPrice`: `number`, `style?`: `string`) => `Promise`<`boolean`\>

#### Type declaration

▸ (`paymentMethod`, `soulname`, `registrationPrice`): `Promise`<`boolean`\>
▸ (`paymentMethod`, `soulname`, `registrationPrice`, `style?`): `Promise`<`boolean`\>

##### Parameters

Expand All @@ -491,6 +509,7 @@ ___
| `paymentMethod` | `PaymentMethod` |
| `soulname` | `string` |
| `registrationPrice` | `number` |
| `style?` | `string` |

##### Returns

Expand Down Expand Up @@ -697,12 +716,6 @@ ___

___

### noWallet

`Optional` **noWallet**: `boolean`

___

### openAccountModal

`Optional` **openAccountModal**: () => `void`
Expand Down Expand Up @@ -1187,12 +1200,22 @@ ___

`Optional` **signer**: `Signer`

#### Overrides
#### Inherited from

[MasaShape](MasaShape.md).[signer](MasaShape.md#signer)

___

### soulNameStyle

`Optional` **soulNameStyle**: `string`

#### Overrides

[MasaShape](MasaShape.md).[soulNameStyle](MasaShape.md#soulnamestyle)

___

### soulnames

`Optional` **soulnames**: `SoulNameDetails`[]
Expand Down Expand Up @@ -1313,6 +1336,10 @@ ___

___

### walletsToUse
### walletName

`Optional` **walletName**: `string`

#### Inherited from

`Optional` **walletsToUse**: `string`[]
[MasaShape](MasaShape.md).[walletName](MasaShape.md#walletname)
28 changes: 25 additions & 3 deletions docs/interfaces/MasaShape.md
@@ -1,5 +1,5 @@
[# Masa React
- v2.0.6](../README.md) / [Exports](../modules.md) / MasaShape
- v2.2.1](../README.md) / [Exports](../modules.md) / MasaShape

# Interface: MasaShape

Expand All @@ -17,6 +17,7 @@
- [accountAddress](MasaShape.md#accountaddress)
- [areScopesFullfiled](MasaShape.md#arescopesfullfiled)
- [badges](MasaShape.md#badges)
- [canProgramaticallySwitchNetwork](MasaShape.md#canprogramaticallyswitchnetwork)
- [children](MasaShape.md#children)
- [closeModal](MasaShape.md#closemodal)
- [company](MasaShape.md#company)
Expand Down Expand Up @@ -82,13 +83,15 @@
- [setRainbowkKitModalCallback](MasaShape.md#setrainbowkkitmodalcallback)
- [setSigner](MasaShape.md#setsigner)
- [signer](MasaShape.md#signer)
- [soulNameStyle](MasaShape.md#soulnamestyle)
- [soulnames](MasaShape.md#soulnames)
- [switchNetwork](MasaShape.md#switchnetwork)
- [switchNetworkNew](MasaShape.md#switchnetworknew)
- [useModalSize](MasaShape.md#usemodalsize)
- [useRainbowKit](MasaShape.md#userainbowkit)
- [verbose](MasaShape.md#verbose)
- [walletAddress](MasaShape.md#walletaddress)
- [walletName](MasaShape.md#walletname)

## Properties

Expand Down Expand Up @@ -116,6 +119,12 @@ ___

___

### canProgramaticallySwitchNetwork

`Optional` **canProgramaticallySwitchNetwork**: `boolean`

___

### children

`Optional` **children**: `ReactNode`
Expand Down Expand Up @@ -351,11 +360,11 @@ ___

### handlePurchaseIdentityWithSoulname

`Optional` **handlePurchaseIdentityWithSoulname**: (`paymentMethod`: `PaymentMethod`, `soulname`: `string`, `registrationPrice`: `number`) => `Promise`<`boolean`\>
`Optional` **handlePurchaseIdentityWithSoulname**: (`paymentMethod`: `PaymentMethod`, `soulname`: `string`, `registrationPrice`: `number`, `style?`: `string`) => `Promise`<`boolean`\>

#### Type declaration

▸ (`paymentMethod`, `soulname`, `registrationPrice`): `Promise`<`boolean`\>
▸ (`paymentMethod`, `soulname`, `registrationPrice`, `style?`): `Promise`<`boolean`\>

##### Parameters

Expand All @@ -364,6 +373,7 @@ ___
| `paymentMethod` | `PaymentMethod` |
| `soulname` | `string` |
| `registrationPrice` | `number` |
| `style?` | `string` |

##### Returns

Expand Down Expand Up @@ -880,6 +890,12 @@ ___

___

### soulNameStyle

`Optional` **soulNameStyle**: `string`

___

### soulnames

`Optional` **soulnames**: `SoulNameDetails`[]
Expand Down Expand Up @@ -963,3 +979,9 @@ ___
### walletAddress

`Optional` **walletAddress**: `string`

___

### walletName

`Optional` **walletName**: `string`
2 changes: 1 addition & 1 deletion docs/interfaces/ModalProps.md
@@ -1,5 +1,5 @@
[# Masa React
- v2.0.6](../README.md) / [Exports](../modules.md) / ModalProps
- v2.2.1](../README.md) / [Exports](../modules.md) / ModalProps

# Interface: ModalProps

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/SpinnerProps.md
@@ -1,5 +1,5 @@
[# Masa React
- v2.0.6](../README.md) / [Exports](../modules.md) / SpinnerProps
- v2.2.1](../README.md) / [Exports](../modules.md) / SpinnerProps

# Interface: SpinnerProps

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/WrapperModalProps.md
@@ -1,5 +1,5 @@
[# Masa React
- v2.0.6](../README.md) / [Exports](../modules.md) / WrapperModalProps
- v2.2.1](../README.md) / [Exports](../modules.md) / WrapperModalProps

# Interface: WrapperModalProps

Expand Down

0 comments on commit 93bf803

Please sign in to comment.