update docs

masa-finance · Mar 17, 2023 · 344cc52 · 344cc52
1 parent 2da9362
commit 344cc52
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 37 deletions.
diff --git a/docs/interfaces/MasaContextProviderProps.md b/docs/interfaces/MasaContextProviderProps.md
@@ -218,15 +218,15 @@ ___
 
 ### handleCreateCreditScore
 
-• `Optional` **handleCreateCreditScore**: () => `void`
+• `Optional` **handleCreateCreditScore**: () => `Promise`<`undefined` \| `boolean`\>
 
 #### Type declaration
 
-▸ (): `void`
+▸ (): `Promise`<`undefined` \| `boolean`\>
 
 ##### Returns
 
-`void`
+`Promise`<`undefined` \| `boolean`\>
 
 #### Inherited from
 
@@ -303,11 +303,11 @@ ___
 
 ### handleLogout
 
-• `Optional` **handleLogout**: (`logoutCallback?`: () => `void`) => `void`
+• `Optional` **handleLogout**: (`logoutCallback?`: () => `void`) => `Promise`<`void`\>
 
 #### Type declaration
 
-▸ (`logoutCallback?`): `void`
+▸ (`logoutCallback?`): `Promise`<`void`\>
 
 ##### Parameters
 
@@ -317,7 +317,7 @@ ___
 
 ##### Returns
 
-`void`
+`Promise`<`void`\>
 
 #### Inherited from
 
@@ -327,15 +327,15 @@ ___
 
 ### handlePurchaseIdentity
 
-• `Optional` **handlePurchaseIdentity**: () => `void`
+• `Optional` **handlePurchaseIdentity**: () => `Promise`<`undefined` \| `boolean`\>
 
 #### Type declaration
 
-▸ (): `void`
+▸ (): `Promise`<`undefined` \| `boolean`\>
 
 ##### Returns
 
-`void`
+`Promise`<`undefined` \| `boolean`\>
 
 #### Inherited from
 
@@ -528,7 +528,7 @@ ___
 
 ### provider
 
-• `Optional` **provider**: `Signer` \| `Wallet`
+• `Optional` **provider**: `Wallet` \| `Signer`
 
 #### Inherited from
 
@@ -668,7 +668,7 @@ ___
 
 ### setProvider
 
-• `Optional` **setProvider**: (`provider?`: `Signer` \| `Wallet`) => `void`
+• `Optional` **setProvider**: (`provider?`: `Wallet` \| `Signer`) => `void`
 
 #### Type declaration
 
@@ -678,7 +678,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `provider?` | `Signer` \| `Wallet` |
+| `provider?` | `Wallet` \| `Signer` |
 
 ##### Returns
 
@@ -692,7 +692,7 @@ ___
 
 ### signer
 
-• `Optional` **signer**: `Signer` \| `Wallet`
+• `Optional` **signer**: `Wallet` \| `Signer`
 
 ___
 

diff --git a/docs/interfaces/MasaShape.md b/docs/interfaces/MasaShape.md
@@ -158,15 +158,15 @@ ___
 
 ### handleCreateCreditScore
 
-• `Optional` **handleCreateCreditScore**: () => `void`
+• `Optional` **handleCreateCreditScore**: () => `Promise`<`undefined` \| `boolean`\>
 
 #### Type declaration
 
-▸ (): `void`
+▸ (): `Promise`<`undefined` \| `boolean`\>
 
 ##### Returns
 
-`void`
+`Promise`<`undefined` \| `boolean`\>
 
 ___
 
@@ -227,11 +227,11 @@ ___
 
 ### handleLogout
 
-• `Optional` **handleLogout**: (`logoutCallback?`: () => `void`) => `void`
+• `Optional` **handleLogout**: (`logoutCallback?`: () => `void`) => `Promise`<`void`\>
 
 #### Type declaration
 
-▸ (`logoutCallback?`): `void`
+▸ (`logoutCallback?`): `Promise`<`void`\>
 
 ##### Parameters
 
@@ -241,21 +241,21 @@ ___
 
 ##### Returns
 
-`void`
+`Promise`<`void`\>
 
 ___
 
 ### handlePurchaseIdentity
 
-• `Optional` **handlePurchaseIdentity**: () => `void`
+• `Optional` **handlePurchaseIdentity**: () => `Promise`<`undefined` \| `boolean`\>
 
 #### Type declaration
 
-▸ (): `void`
+▸ (): `Promise`<`undefined` \| `boolean`\>
 
 ##### Returns
 
-`void`
+`Promise`<`undefined` \| `boolean`\>
 
 ___
 
@@ -382,7 +382,7 @@ ___
 
 ### provider
 
-• `Optional` **provider**: `Signer` \| `Wallet`
+• `Optional` **provider**: `Wallet` \| `Signer`
 
 ___
 
@@ -490,7 +490,7 @@ ___
 
 ### setProvider
 
-• `Optional` **setProvider**: (`provider?`: `Signer` \| `Wallet`) => `void`
+• `Optional` **setProvider**: (`provider?`: `Wallet` \| `Signer`) => `void`
 
 #### Type declaration
 
@@ -500,7 +500,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `provider?` | `Signer` \| `Wallet` |
+| `provider?` | `Wallet` \| `Signer` |
 
 ##### Returns
 

diff --git a/docs/modules.md b/docs/modules.md
@@ -20,7 +20,7 @@
 
 ### Variables
 
-- [MASA\_CONTEXT](modules.md#masa_context)
+- [MasaContext](modules.md#masacontext)
 - [queryClient](modules.md#queryclient)
 
 ### Functions
@@ -55,9 +55,9 @@
 
 ## Variables
 
-### MASA\_CONTEXT
+### MasaContext
 
-• `Const` **MASA\_CONTEXT**: `Context`<[`MasaShape`](interfaces/MasaShape.md)\>
+• `Const` **MasaContext**: `Context`<[`MasaShape`](interfaces/MasaShape.md)\>
 
 ___
 
@@ -160,7 +160,7 @@ ___
 
 ### createNewMasa
 
-▸ **createNewMasa**(`«destructured»`): `Promise`<`undefined` \| `default`\>
+▸ **createNewMasa**(`«destructured»`): `undefined` \| `default`
 
 #### Parameters
 
@@ -175,7 +175,7 @@ ___
 
 #### Returns
 
-`Promise`<`undefined` \| `default`\>
+`undefined` \| `default`
 
 ___
 
@@ -209,9 +209,9 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `creditScores` | `undefined` \| { `metadata?`: `ICreditScore` ; `tokenId`: `BigNumber` ; `tokenUri`: `string`  }[] |
+| `creditScores?` | { `metadata?`: `ICreditScore` ; `tokenId`: `BigNumber` ; `tokenUri`: `string`  }[] |
 | `error` | `unknown` |
-| `handleCreateCreditScore` | () => `void` |
+| `handleCreateCreditScore` | () => `Promise`<`undefined` \| `boolean`\> |
 | `isCreditScoresLoading` | `boolean` |
 | `reloadCreditScores` | () => `void` |
 | `status` | `string` |
@@ -298,9 +298,11 @@ ___
 | Name | Type |
 | :------ | :------ |
 | `error` | `unknown` |
-| `handlePurchaseIdentity` | () => `void` |
+| `handlePurchaseIdentity` | () => `Promise`<`boolean`\> |
 | `handlePurchaseIdentityWithSoulname` | (`paymentMethod`: `PaymentMethod`, `soulname`: `string`, `registrationPeriod`: `number`) => `Promise`<`boolean`\> |
-| `identity` | `undefined` \| { `address?`: `string` ; `identityId?`: `BigNumber`  } |
+| `identity?` | { `address?`: `string` ; `identityId?`: `BigNumber`  } |
+| `identity.address?` | `string` |
+| `identity.identityId?` | `BigNumber` |
 | `isIdentityLoading` | `boolean` |
 | `reloadIdentity` | () => `void` |
 | `status` | `string` |
@@ -389,7 +391,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `provider?` | `Signer` \| `Wallet` |
+| `provider?` | `Wallet` \| `Signer` |
 
 #### Returns
 
@@ -422,7 +424,7 @@ ___
 | :------ | :------ |
 | `error` | `unknown` |
 | `handleLogin` | () => `void` |
-| `handleLogout` | (`logoutCallback?`: () => `void`) => `void` |
+| `handleLogout` | (`logoutCallback?`: () => `void`) => `Promise`<`void`\> |
 | `isLoggedIn?` | `boolean` |
 | `isSessionLoading` | `boolean` |
 | `status` | `string` |
@@ -464,7 +466,7 @@ ___
 | Name | Type |
 | :------ | :------ |
 | `masa?` | `default` |
-| `provider?` | `Signer` \| `Wallet` |
+| `provider?` | `Wallet` \| `Signer` |
 
 #### Returns