update docs

masa-finance · Jan 5, 2023 · dc74364 · dc74364
1 parent 7afa663
commit dc74364
Show file tree

Hide file tree

Showing 19 changed files with 75 additions and 60 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,5 @@
 # Masa SDK
- - v0.8.0 / [Exports](modules.md)
+ - v0.9.0 / [Exports](modules.md)
 
 ---
 

diff --git a/docs/classes/Masa.md b/docs/classes/Masa.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0](../README.md) / [Exports](../modules.md) / Masa
+ - v0.9.0](../README.md) / [Exports](../modules.md) / Masa
 
 # Class: Masa
 
@@ -20,7 +20,7 @@
 - [identity](Masa.md#identity)
 - [metadata](Masa.md#metadata)
 - [session](Masa.md#session)
-- [soulNames](Masa.md#soulnames)
+- [soulName](Masa.md#soulname)
 - [twoFA](Masa.md#twofa)
 - [utils](Masa.md#utils)
 
@@ -89,7 +89,7 @@ ___
 | Name | Type |
 | :------ | :------ |
 | `retrieve` | (`url`: `string`, `additionalHeaders?`: `Record`<`string`, `string`\>) => `Promise`<`undefined` \| [`IIdentity`](../interfaces/IIdentity.md) \| [`ICreditScore`](../interfaces/ICreditScore.md) \| [`I2FA`](../interfaces/I2FA.md)\> |
-| `store` | (`soulName`: `string`) => `Promise`<`undefined` \| { `imageResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string`  } ; `imageTransaction`: `default` ; `metadataResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string`  } ; `metadataTransaction`: `default`  }\> |
+| `store` | (`soulName`: `string`, `receiver`: `string`, `duration`: `number`) => `Promise`<`undefined` \| { `authorityAddress`: `string` ; `imageResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string`  } ; `imageTransaction`: `default` ; `metadataResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string`  } ; `metadataTransaction`: `default` ; `signature`: `string`  }\> |
 
 ___
 
@@ -99,9 +99,9 @@ ___
 
 ___
 
-### soulNames
+### soulName
 
-• `Readonly` **soulNames**: [`MasaSoulNames`](MasaSoulNames.md)
+• `Readonly` **soulName**: [`MasaSoulName`](MasaSoulName.md)
 
 ___
 

diff --git a/docs/classes/MasaClient.md b/docs/classes/MasaClient.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0](../README.md) / [Exports](../modules.md) / MasaClient
+ - v0.9.0](../README.md) / [Exports](../modules.md) / MasaClient
 
 # Class: MasaClient
 
@@ -175,17 +175,19 @@ ___
 
 ### storeMetadata
 
-▸ **storeMetadata**(`soulName`): `Promise`<`undefined` \| { `imageResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string`  } ; `imageTransaction`: `default` ; `metadataResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string`  } ; `metadataTransaction`: `default`  }\>
+▸ **storeMetadata**(`soulName`, `receiver`, `duration`): `Promise`<`undefined` \| { `authorityAddress`: `string` ; `imageResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string`  } ; `imageTransaction`: `default` ; `metadataResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string`  } ; `metadataTransaction`: `default` ; `signature`: `string`  }\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `soulName` | `string` |
+| `receiver` | `string` |
+| `duration` | `number` |
 
 #### Returns
 
-`Promise`<`undefined` \| { `imageResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string`  } ; `imageTransaction`: `default` ; `metadataResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string`  } ; `metadataTransaction`: `default`  }\>
+`Promise`<`undefined` \| { `authorityAddress`: `string` ; `imageResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string`  } ; `imageTransaction`: `default` ; `metadataResponse`: { `data`: `any` ; `status`: `number` ; `statusText`: `string`  } ; `metadataTransaction`: `default` ; `signature`: `string`  }\>
 
 ___
 

diff --git a/docs/classes/MasaContracts.md b/docs/classes/MasaContracts.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0](../README.md) / [Exports](../modules.md) / MasaContracts
+ - v0.9.0](../README.md) / [Exports](../modules.md) / MasaContracts
 
 # Class: MasaContracts
 
@@ -26,7 +26,6 @@
 - [purchaseIdentity](MasaContracts.md#purchaseidentity)
 - [purchaseIdentityAndName](MasaContracts.md#purchaseidentityandname)
 - [purchaseName](MasaContracts.md#purchasename)
-- [queryLink](MasaContracts.md#querylink)
 
 ## Constructors
 
@@ -115,16 +114,16 @@ ___
 
 ### getPaymentInformation
 
-▸ **getPaymentInformation**(`name`, `paymentMethod`, `duration?`, `signer`): `Promise`<{ `formattedPrice`: `string` ; `paymentAddress`: `string` ; `price`: `BigNumber`  }\>
+▸ **getPaymentInformation**(`signer`, `paymentMethod`, `nameLength`, `duration?`): `Promise`<{ `formattedPrice`: `string` ; `paymentAddress`: `string` ; `price`: `BigNumber`  }\>
 
 #### Parameters
 
 | Name | Type | Default value |
 | :------ | :------ | :------ |
-| `name` | `string` | `undefined` |
+| `signer` | `Signer` | `undefined` |
 | `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `undefined` |
+| `nameLength` | `number` | `undefined` |
 | `duration` | `number` | `1` |
-| `signer` | `Signer` | `undefined` |
 
 #### Returns
 
@@ -203,17 +202,20 @@ ___
 
 ### purchaseIdentityAndName
 
-▸ **purchaseIdentityAndName**(`signer`, `name`, `paymentMethod`, `duration?`, `metadataURL`): `Promise`<`ContractTransaction`\>
+▸ **purchaseIdentityAndName**(`signer`, `paymentMethod`, `name`, `nameLength`, `duration?`, `metadataURL`, `authorityAddress`, `signature`): `Promise`<`ContractTransaction`\>
 
 #### Parameters
 
 | Name | Type | Default value |
 | :------ | :------ | :------ |
 | `signer` | `Signer` | `undefined` |
-| `name` | `string` | `undefined` |
 | `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `undefined` |
+| `name` | `string` | `undefined` |
+| `nameLength` | `number` | `undefined` |
 | `duration` | `number` | `1` |
 | `metadataURL` | `string` | `undefined` |
+| `authorityAddress` | `string` | `undefined` |
+| `signature` | `string` | `undefined` |
 
 #### Returns
 
@@ -223,42 +225,21 @@ ___
 
 ### purchaseName
 
-▸ **purchaseName**(`signer`, `name`, `paymentMethod`, `duration?`, `metadataURL`): `Promise`<`ContractTransaction`\>
+▸ **purchaseName**(`signer`, `paymentMethod`, `name`, `nameLength`, `duration?`, `metadataURL`, `authorityAddress`, `signature`): `Promise`<`ContractTransaction`\>
 
 #### Parameters
 
 | Name | Type | Default value |
 | :------ | :------ | :------ |
 | `signer` | `Signer` | `undefined` |
-| `name` | `string` | `undefined` |
 | `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `undefined` |
+| `name` | `string` | `undefined` |
+| `nameLength` | `number` | `undefined` |
 | `duration` | `number` | `1` |
 | `metadataURL` | `string` | `undefined` |
+| `authorityAddress` | `string` | `undefined` |
+| `signature` | `string` | `undefined` |
 
 #### Returns
 
 `Promise`<`ContractTransaction`\>
-
-___
-
-### queryLink
-
-▸ **queryLink**(`signer`, `tokenAddress`, `paymentMethod`, `readerIdentityId`, `ownerIdentityId`, `tokenId`, `signatureDate`, `expirationDate`, `signature`): `Promise`<`string`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `signer` | `Signer` |
-| `tokenAddress` | `string` |
-| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) |
-| `readerIdentityId` | `BigNumber` |
-| `ownerIdentityId` | `BigNumber` |
-| `tokenId` | `BigNumber` |
-| `signatureDate` | `number` |
-| `expirationDate` | `number` |
-| `signature` | `string` |
-
-#### Returns
-
-`Promise`<`string`\>
diff --git a/docs/interfaces/Addresses.md b/docs/interfaces/Addresses.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0](../README.md) / [Exports](../modules.md) / Addresses
+ - v0.9.0](../README.md) / [Exports](../modules.md) / Addresses
 
 # Interface: Addresses
 

diff --git a/docs/interfaces/Attribute.md b/docs/interfaces/Attribute.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0](../README.md) / [Exports](../modules.md) / Attribute
+ - v0.9.0](../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
- - v0.8.0](../README.md) / [Exports](../modules.md) / BaseResult
+ - v0.9.0](../README.md) / [Exports](../modules.md) / BaseResult
 
 # Interface: BaseResult
 

diff --git a/docs/interfaces/Create2FAResult.md b/docs/interfaces/Create2FAResult.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0](../README.md) / [Exports](../modules.md) / Create2FAResult
+ - v0.9.0](../README.md) / [Exports](../modules.md) / Create2FAResult
 
 # Interface: Create2FAResult
 

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

diff --git a/docs/interfaces/I2fa.md b/docs/interfaces/I2fa.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0](../README.md) / [Exports](../modules.md) / I2FA
+ - v0.9.0](../README.md) / [Exports](../modules.md) / I2FA
 
 # Interface: I2FA
 

diff --git a/docs/interfaces/ICreditScore.md b/docs/interfaces/ICreditScore.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0](../README.md) / [Exports](../modules.md) / ICreditScore
+ - v0.9.0](../README.md) / [Exports](../modules.md) / ICreditScore
 
 # Interface: ICreditScore
 

diff --git a/docs/interfaces/IIdentity.md b/docs/interfaces/IIdentity.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0](../README.md) / [Exports](../modules.md) / IIdentity
+ - v0.9.0](../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
- - v0.8.0](../README.md) / [Exports](../modules.md) / IIdentityContracts
+ - v0.9.0](../README.md) / [Exports](../modules.md) / IIdentityContracts
 
 # Interface: IIdentityContracts
 

diff --git a/docs/interfaces/ISession.md b/docs/interfaces/ISession.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0](../README.md) / [Exports](../modules.md) / ISession
+ - v0.9.0](../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
- - v0.8.0](../README.md) / [Exports](../modules.md) / ISoulName
+ - v0.9.0](../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
- - v0.8.0](../README.md) / [Exports](../modules.md) / LoadContractArgs
+ - v0.9.0](../README.md) / [Exports](../modules.md) / LoadContractArgs
 
 # Interface: LoadContractArgs
 

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

diff --git a/docs/interfaces/MasaConfig.md b/docs/interfaces/MasaConfig.md
@@ -1,5 +1,5 @@
 [# Masa SDK
- - v0.8.0](../README.md) / [Exports](../modules.md) / MasaConfig
+ - v0.9.0](../README.md) / [Exports](../modules.md) / MasaConfig
 
 # Interface: MasaConfig
 

diff --git a/docs/modules.md b/docs/modules.md
@@ -1,8 +1,8 @@
 [# Masa SDK
- - v0.8.0](README.md) / Exports
+ - v0.9.0](README.md) / Exports
 
 # # Masa SDK
- - v0.8.0
+ - v0.9.0
 
 ## Table of contents
 
@@ -18,7 +18,7 @@
 - [MasaIdentity](classes/MasaIdentity.md)
 - [MasaSession](classes/MasaSession.md)
 - [MasaSoulLinker](classes/MasaSoulLinker.md)
-- [MasaSoulNames](classes/MasaSoulNames.md)
+- [MasaSoulName](classes/MasaSoulName.md)
 
 ### Interfaces
 
@@ -51,6 +51,7 @@
 
 ### Variables
 
+- [ErrorMessage](modules.md#errormessage)
 - [Templates](modules.md#templates)
 - [addresses](modules.md#addresses)
 - [environments](modules.md#environments)
@@ -66,6 +67,7 @@
 - [burnIdentityById](modules.md#burnidentitybyid)
 - [burnSoulName](modules.md#burnsoulname)
 - [burnSoulNameByName](modules.md#burnsoulnamebyname)
+- [calculateSoulNameLength](modules.md#calculatesoulnamelength)
 - [checkAllowlist](modules.md#checkallowlist)
 - [checkLogin](modules.md#checklogin)
 - [create2FA](modules.md#create2fa)
@@ -176,6 +178,18 @@ ___
 
 ## Variables
 
+### ErrorMessage
+
+• `Const` **ErrorMessage**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `NoIdentity` | (`address?`: `string`) => `string` |
+
+___
+
 ### Templates
 
 • `Const` **Templates**: `Object`
@@ -356,6 +370,22 @@ ___
 
 ___
 
+### calculateSoulNameLength
+
+▸ **calculateSoulNameLength**(`soulName`): `number`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `soulName` | `string` |
+
+#### Returns
+
+`number`
+
+___
+
 ### checkAllowlist
 
 ▸ **checkAllowlist**(`masa`): `Promise`<`boolean`\>
@@ -974,14 +1004,15 @@ ___
 
 ### purchaseIdentityWithSoulName
 
-▸ **purchaseIdentityWithSoulName**(`masa`, `soulName`, `duration`, `paymentMethod`): `Promise`<`void`\>
+▸ **purchaseIdentityWithSoulName**(`masa`, `soulName`, `soulNameLength`, `duration`, `paymentMethod`): `Promise`<`void`\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `masa` | [`Masa`](classes/Masa.md) |
 | `soulName` | `string` |
+| `soulNameLength` | `number` |
 | `duration` | `number` |
 | `paymentMethod` | [`PaymentMethod`](modules.md#paymentmethod) |
 
@@ -1156,6 +1187,7 @@ ___
 | Name | Type |
 | :------ | :------ |
 | `isValid` | `boolean` |
+| `length` | `number` |
 | `message?` | `string` |
 
 ___