update docs

masa-finance · Apr 17, 2023 · 0ec2408 · 0ec2408
1 parent 6b373ad
commit 0ec2408
Show file tree

Hide file tree

Showing 60 changed files with 119 additions and 60 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,4 +1,5 @@
-# Masa SDK / [Exports](modules.md)
+# Masa SDK
+ / [Exports](modules.md)
 
 <!-- TOC -->
   * [Installation](#installation)

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

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

diff --git a/docs/classes/ERC20__factory.md b/docs/classes/ERC20__factory.md
@@ -1,4 +1,5 @@
-[# Masa SDK](../README.md) / [Exports](../modules.md) / ERC20\_\_factory
+[# Masa SDK
+](../README.md) / [Exports](../modules.md) / ERC20\_\_factory
 
 # Class: ERC20\_\_factory
 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

diff --git a/docs/enums/SoulNameErrorCodes.md b/docs/enums/SoulNameErrorCodes.md
@@ -1,4 +1,5 @@
-[# Masa SDK](../README.md) / [Exports](../modules.md) / SoulNameErrorCodes
+[# Masa SDK
+](../README.md) / [Exports](../modules.md) / SoulNameErrorCodes
 
 # Enumeration: SoulNameErrorCodes
 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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