From bdb6a515d147079393282611cb5ab32089c09843 Mon Sep 17 00:00:00 2001 From: Sebastian Gerske <13647606+H34D@users.noreply.github.com> Date: Fri, 24 Feb 2023 18:35:41 +0100 Subject: [PATCH] update docs --- docs/interfaces/MasaContextProviderProps.md | 76 ++-- docs/interfaces/MasaShape.md | 446 ++++++++++++++++++++ docs/modules.md | 7 +- src/provider/index.ts | 1 + 4 files changed, 489 insertions(+), 41 deletions(-) create mode 100644 docs/interfaces/MasaShape.md diff --git a/docs/interfaces/MasaContextProviderProps.md b/docs/interfaces/MasaContextProviderProps.md index bcfa1d63..d04c40c7 100644 --- a/docs/interfaces/MasaContextProviderProps.md +++ b/docs/interfaces/MasaContextProviderProps.md @@ -5,7 +5,7 @@ ## Hierarchy -- `MasaShape` +- [`MasaShape`](MasaShape.md) ↳ **`MasaContextProviderProps`** @@ -64,7 +64,7 @@ #### Inherited from -MasaShape.SupportedNetworks +[MasaShape](MasaShape.md).[SupportedNetworks](MasaShape.md#supportednetworks) ___ @@ -80,7 +80,7 @@ ___ #### Overrides -MasaShape.children +[MasaShape](MasaShape.md).[children](MasaShape.md#children) ___ @@ -98,7 +98,7 @@ ___ #### Inherited from -MasaShape.closeModal +[MasaShape](MasaShape.md).[closeModal](MasaShape.md#closemodal) ___ @@ -108,7 +108,7 @@ ___ #### Overrides -MasaShape.company +[MasaShape](MasaShape.md).[company](MasaShape.md#company) ___ @@ -134,7 +134,7 @@ ___ #### Inherited from -MasaShape.connect +[MasaShape](MasaShape.md).[connect](MasaShape.md#connect) ___ @@ -144,7 +144,7 @@ ___ #### Inherited from -MasaShape.creditScores +[MasaShape](MasaShape.md).[creditScores](MasaShape.md#creditscores) ___ @@ -160,7 +160,7 @@ ___ #### Inherited from -MasaShape.greens +[MasaShape](MasaShape.md).[greens](MasaShape.md#greens) ___ @@ -178,7 +178,7 @@ ___ #### Inherited from -MasaShape.handleCreateCreditScore +[MasaShape](MasaShape.md).[handleCreateCreditScore](MasaShape.md#handlecreatecreditscore) ___ @@ -203,7 +203,7 @@ ___ #### Inherited from -MasaShape.handleCreateGreen +[MasaShape](MasaShape.md).[handleCreateGreen](MasaShape.md#handlecreategreen) ___ @@ -227,7 +227,7 @@ ___ #### Inherited from -MasaShape.handleGenerateGreen +[MasaShape](MasaShape.md).[handleGenerateGreen](MasaShape.md#handlegenerategreen) ___ @@ -245,7 +245,7 @@ ___ #### Inherited from -MasaShape.handleLogin +[MasaShape](MasaShape.md).[handleLogin](MasaShape.md#handlelogin) ___ @@ -269,7 +269,7 @@ ___ #### Inherited from -MasaShape.handleLogout +[MasaShape](MasaShape.md).[handleLogout](MasaShape.md#handlelogout) ___ @@ -287,7 +287,7 @@ ___ #### Inherited from -MasaShape.handlePurchaseIdentity +[MasaShape](MasaShape.md).[handlePurchaseIdentity](MasaShape.md#handlepurchaseidentity) ___ @@ -304,7 +304,7 @@ ___ #### Inherited from -MasaShape.identity +[MasaShape](MasaShape.md).[identity](MasaShape.md#identity) ___ @@ -314,7 +314,7 @@ ___ #### Inherited from -MasaShape.isConnected +[MasaShape](MasaShape.md).[isConnected](MasaShape.md#isconnected) ___ @@ -324,7 +324,7 @@ ___ #### Inherited from -MasaShape.isCreditScoresLoading +[MasaShape](MasaShape.md).[isCreditScoresLoading](MasaShape.md#iscreditscoresloading) ___ @@ -334,7 +334,7 @@ ___ #### Inherited from -MasaShape.isGreensLoading +[MasaShape](MasaShape.md).[isGreensLoading](MasaShape.md#isgreensloading) ___ @@ -344,7 +344,7 @@ ___ #### Inherited from -MasaShape.isIdentityLoading +[MasaShape](MasaShape.md).[isIdentityLoading](MasaShape.md#isidentityloading) ___ @@ -354,7 +354,7 @@ ___ #### Inherited from -MasaShape.isLoading +[MasaShape](MasaShape.md).[isLoading](MasaShape.md#isloading) ___ @@ -364,7 +364,7 @@ ___ #### Inherited from -MasaShape.isLoggedIn +[MasaShape](MasaShape.md).[isLoggedIn](MasaShape.md#isloggedin) ___ @@ -374,7 +374,7 @@ ___ #### Inherited from -MasaShape.isModalOpen +[MasaShape](MasaShape.md).[isModalOpen](MasaShape.md#ismodalopen) ___ @@ -384,7 +384,7 @@ ___ #### Inherited from -MasaShape.isSessionLoading +[MasaShape](MasaShape.md).[isSessionLoading](MasaShape.md#issessionloading) ___ @@ -394,7 +394,7 @@ ___ #### Inherited from -MasaShape.isSoulnamesLoading +[MasaShape](MasaShape.md).[isSoulnamesLoading](MasaShape.md#issoulnamesloading) ___ @@ -404,7 +404,7 @@ ___ #### Inherited from -MasaShape.isWalletLoading +[MasaShape](MasaShape.md).[isWalletLoading](MasaShape.md#iswalletloading) ___ @@ -414,7 +414,7 @@ ___ #### Inherited from -MasaShape.masa +[MasaShape](MasaShape.md).[masa](MasaShape.md#masa) ___ @@ -424,7 +424,7 @@ ___ #### Inherited from -MasaShape.network +[MasaShape](MasaShape.md).[network](MasaShape.md#network) ___ @@ -440,7 +440,7 @@ ___ #### Inherited from -MasaShape.provider +[MasaShape](MasaShape.md).[provider](MasaShape.md#provider) ___ @@ -458,7 +458,7 @@ ___ #### Inherited from -MasaShape.reloadCreditScores +[MasaShape](MasaShape.md).[reloadCreditScores](MasaShape.md#reloadcreditscores) ___ @@ -476,7 +476,7 @@ ___ #### Inherited from -MasaShape.reloadGreens +[MasaShape](MasaShape.md).[reloadGreens](MasaShape.md#reloadgreens) ___ @@ -494,7 +494,7 @@ ___ #### Inherited from -MasaShape.reloadIdentity +[MasaShape](MasaShape.md).[reloadIdentity](MasaShape.md#reloadidentity) ___ @@ -512,7 +512,7 @@ ___ #### Inherited from -MasaShape.reloadSoulnames +[MasaShape](MasaShape.md).[reloadSoulnames](MasaShape.md#reloadsoulnames) ___ @@ -522,7 +522,7 @@ ___ #### Inherited from -MasaShape.scope +[MasaShape](MasaShape.md).[scope](MasaShape.md#scope) ___ @@ -546,7 +546,7 @@ ___ #### Inherited from -MasaShape.setModalOpen +[MasaShape](MasaShape.md).[setModalOpen](MasaShape.md#setmodalopen) ___ @@ -570,7 +570,7 @@ ___ #### Inherited from -MasaShape.setProvider +[MasaShape](MasaShape.md).[setProvider](MasaShape.md#setprovider) ___ @@ -586,7 +586,7 @@ ___ #### Inherited from -MasaShape.soulnames +[MasaShape](MasaShape.md).[soulnames](MasaShape.md#soulnames) ___ @@ -610,7 +610,7 @@ ___ #### Inherited from -MasaShape.switchNetwork +[MasaShape](MasaShape.md).[switchNetwork](MasaShape.md#switchnetwork) ___ @@ -626,4 +626,4 @@ ___ #### Inherited from -MasaShape.walletAddress +[MasaShape](MasaShape.md).[walletAddress](MasaShape.md#walletaddress) diff --git a/docs/interfaces/MasaShape.md b/docs/interfaces/MasaShape.md new file mode 100644 index 00000000..5db84666 --- /dev/null +++ b/docs/interfaces/MasaShape.md @@ -0,0 +1,446 @@ +[# Masa React + - v0.28.2](../README.md) / [Exports](../modules.md) / MasaShape + +# Interface: MasaShape + +## Hierarchy + +- **`MasaShape`** + + ↳ [`MasaContextProviderProps`](MasaContextProviderProps.md) + +## Table of contents + +### Properties + +- [SupportedNetworks](MasaShape.md#supportednetworks) +- [children](MasaShape.md#children) +- [closeModal](MasaShape.md#closemodal) +- [company](MasaShape.md#company) +- [connect](MasaShape.md#connect) +- [creditScores](MasaShape.md#creditscores) +- [greens](MasaShape.md#greens) +- [handleCreateCreditScore](MasaShape.md#handlecreatecreditscore) +- [handleCreateGreen](MasaShape.md#handlecreategreen) +- [handleGenerateGreen](MasaShape.md#handlegenerategreen) +- [handleLogin](MasaShape.md#handlelogin) +- [handleLogout](MasaShape.md#handlelogout) +- [handlePurchaseIdentity](MasaShape.md#handlepurchaseidentity) +- [identity](MasaShape.md#identity) +- [isConnected](MasaShape.md#isconnected) +- [isCreditScoresLoading](MasaShape.md#iscreditscoresloading) +- [isGreensLoading](MasaShape.md#isgreensloading) +- [isIdentityLoading](MasaShape.md#isidentityloading) +- [isLoading](MasaShape.md#isloading) +- [isLoggedIn](MasaShape.md#isloggedin) +- [isModalOpen](MasaShape.md#ismodalopen) +- [isSessionLoading](MasaShape.md#issessionloading) +- [isSoulnamesLoading](MasaShape.md#issoulnamesloading) +- [isWalletLoading](MasaShape.md#iswalletloading) +- [masa](MasaShape.md#masa) +- [network](MasaShape.md#network) +- [provider](MasaShape.md#provider) +- [reloadCreditScores](MasaShape.md#reloadcreditscores) +- [reloadGreens](MasaShape.md#reloadgreens) +- [reloadIdentity](MasaShape.md#reloadidentity) +- [reloadSoulnames](MasaShape.md#reloadsoulnames) +- [scope](MasaShape.md#scope) +- [setModalOpen](MasaShape.md#setmodalopen) +- [setProvider](MasaShape.md#setprovider) +- [soulnames](MasaShape.md#soulnames) +- [switchNetwork](MasaShape.md#switchnetwork) +- [walletAddress](MasaShape.md#walletaddress) + +## Properties + +### SupportedNetworks + +• `Optional` **SupportedNetworks**: `Partial`<{ `alfajores`: [`Network`](Network.md) ; `bsc`: [`Network`](Network.md) ; `bsctest`: [`Network`](Network.md) ; `celo`: [`Network`](Network.md) ; `ethereum`: [`Network`](Network.md) ; `goerli`: [`Network`](Network.md) ; `mainnet`: [`Network`](Network.md) ; `mumbai`: [`Network`](Network.md) ; `polygon`: [`Network`](Network.md) ; `unknown`: [`Network`](Network.md) }\> + +___ + +### children + +• `Optional` **children**: `ReactNode` + +___ + +### closeModal + +• `Optional` **closeModal**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +___ + +### company + +• `Optional` **company**: `string` + +___ + +### connect + +• `Optional` **connect**: (`options?`: { `callback?`: () => `void` ; `scope?`: `string`[] }) => `void` + +#### Type declaration + +▸ (`options?`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | `Object` | +| `options.callback?` | () => `void` | +| `options.scope?` | `string`[] | + +##### Returns + +`void` + +___ + +### creditScores + +• `Optional` **creditScores**: { `metadata?`: `ICreditScore` ; `tokenId`: `BigNumber` ; `tokenUri`: `string` }[] + +___ + +### greens + +• `Optional` **greens**: { `metadata?`: `IGreen` ; `tokenId`: `BigNumber` ; `tokenUri`: `string` }[] + +___ + +### handleCreateCreditScore + +• `Optional` **handleCreateCreditScore**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +___ + +### handleCreateGreen + +• `Optional` **handleCreateGreen**: (`phoneNumber`: `string`, `code`: `string`) => `Promise`<`undefined` \| `VerifyGreenResult`\> + +#### Type declaration + +▸ (`phoneNumber`, `code`): `Promise`<`undefined` \| `VerifyGreenResult`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `phoneNumber` | `string` | +| `code` | `string` | + +##### Returns + +`Promise`<`undefined` \| `VerifyGreenResult`\> + +___ + +### handleGenerateGreen + +• `Optional` **handleGenerateGreen**: (`phoneNumber`: `string`) => `Promise`<`undefined` \| `GenerateGreenResult`\> + +#### Type declaration + +▸ (`phoneNumber`): `Promise`<`undefined` \| `GenerateGreenResult`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `phoneNumber` | `string` | + +##### Returns + +`Promise`<`undefined` \| `GenerateGreenResult`\> + +___ + +### handleLogin + +• `Optional` **handleLogin**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +___ + +### handleLogout + +• `Optional` **handleLogout**: (`logoutCallback?`: () => `void`) => `void` + +#### Type declaration + +▸ (`logoutCallback?`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `logoutCallback?` | () => `void` | + +##### Returns + +`void` + +___ + +### handlePurchaseIdentity + +• `Optional` **handlePurchaseIdentity**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +___ + +### identity + +• `Optional` **identity**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `address?` | `string` | +| `identityId?` | `BigNumber` | + +___ + +### isConnected + +• `Optional` **isConnected**: `boolean` + +___ + +### isCreditScoresLoading + +• `Optional` **isCreditScoresLoading**: `boolean` + +___ + +### isGreensLoading + +• `Optional` **isGreensLoading**: `boolean` + +___ + +### isIdentityLoading + +• `Optional` **isIdentityLoading**: `boolean` + +___ + +### isLoading + +• `Optional` **isLoading**: `boolean` + +___ + +### isLoggedIn + +• `Optional` **isLoggedIn**: `boolean` + +___ + +### isModalOpen + +• `Optional` **isModalOpen**: `boolean` + +___ + +### isSessionLoading + +• `Optional` **isSessionLoading**: `boolean` + +___ + +### isSoulnamesLoading + +• `Optional` **isSoulnamesLoading**: `boolean` + +___ + +### isWalletLoading + +• `Optional` **isWalletLoading**: `boolean` + +___ + +### masa + +• `Optional` **masa**: `default` + +___ + +### network + +• `Optional` **network**: `Network` + +___ + +### provider + +• `Optional` **provider**: `Signer` \| `Wallet` + +___ + +### reloadCreditScores + +• `Optional` **reloadCreditScores**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +___ + +### reloadGreens + +• `Optional` **reloadGreens**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +___ + +### reloadIdentity + +• `Optional` **reloadIdentity**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +___ + +### reloadSoulnames + +• `Optional` **reloadSoulnames**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +___ + +### scope + +• `Optional` **scope**: `string`[] + +___ + +### setModalOpen + +• `Optional` **setModalOpen**: (`val`: `boolean`) => `void` + +#### Type declaration + +▸ (`val`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `boolean` | + +##### Returns + +`void` + +___ + +### setProvider + +• `Optional` **setProvider**: (`provider?`: `Signer` \| `Wallet`) => `void` + +#### Type declaration + +▸ (`provider?`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `provider?` | `Signer` \| `Wallet` | + +##### Returns + +`void` + +___ + +### soulnames + +• `Optional` **soulnames**: `SoulNameDetails`[] + +___ + +### switchNetwork + +• `Optional` **switchNetwork**: (`chainId`: `number`) => `void` + +#### Type declaration + +▸ (`chainId`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `chainId` | `number` | + +##### Returns + +`void` + +___ + +### walletAddress + +• `Optional` **walletAddress**: `string` diff --git a/docs/modules.md b/docs/modules.md index ab2bc704..31060fb8 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -10,6 +10,7 @@ - [ArweaveConfig](interfaces/ArweaveConfig.md) - [MasaContextProviderProps](interfaces/MasaContextProviderProps.md) +- [MasaShape](interfaces/MasaShape.md) - [ModalProps](interfaces/ModalProps.md) - [Network](interfaces/Network.md) - [SpinnerProps](interfaces/SpinnerProps.md) @@ -58,7 +59,7 @@ ### MASA\_CONTEXT -• `Const` **MASA\_CONTEXT**: `Context`<`MasaShape`\> +• `Const` **MASA\_CONTEXT**: `Context`<[`MasaShape`](interfaces/MasaShape.md)\> ___ @@ -330,11 +331,11 @@ ___ ### useMasa -▸ **useMasa**(): `MasaShape` +▸ **useMasa**(): [`MasaShape`](interfaces/MasaShape.md) #### Returns -`MasaShape` +[`MasaShape`](interfaces/MasaShape.md) ___ diff --git a/src/provider/index.ts b/src/provider/index.ts index 934a521e..72c0d5fb 100644 --- a/src/provider/index.ts +++ b/src/provider/index.ts @@ -6,3 +6,4 @@ export * from './use-masa'; export * from './use-metamask'; export * from './use-debounce'; export * from './modules'; +export * from './masa-shape';