Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@H34D
H34D committed Jan 18, 2023
1 parent 5e48728 commit 7a3d8d9
Show file tree
Hide file tree
Showing 28 changed files with 52 additions and 50 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
View file
@@ -1,5 +1,5 @@
# Masa SDK
- v1.0.3 / [Exports](modules.md)
- v1.0.4 / [Exports](modules.md)

---

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/Masa.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / Masa
- v1.0.4](../README.md) / [Exports](../modules.md) / Masa

# Class: Masa

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/Masa2FA.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / Masa2FA
- v1.0.4](../README.md) / [Exports](../modules.md) / Masa2FA

# Class: Masa2FA

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaAccount.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / MasaAccount
- v1.0.4](../README.md) / [Exports](../modules.md) / MasaAccount

# Class: MasaAccount

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaArweave.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / MasaArweave
- v1.0.4](../README.md) / [Exports](../modules.md) / MasaArweave

# Class: MasaArweave

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaClient.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / MasaClient
- v1.0.4](../README.md) / [Exports](../modules.md) / MasaClient

# Class: MasaClient

Expand Down
46 changes: 24 additions & 22 deletions docs/classes/MasaContracts.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / MasaContracts
- v1.0.4](../README.md) / [Exports](../modules.md) / MasaContracts

# Class: MasaContracts

Expand Down Expand Up @@ -55,21 +55,22 @@ ___

### addLink

▸ **addLink**(`signer`, `tokenAddress`, `paymentMethod`, `readerIdentityId`, `ownerIdentityId`, `tokenId`, `signatureDate`, `expirationDate`, `signature`): `Promise`<`boolean`\>
▸ **addLink**(`signer`, `tokenAddress`, `paymentMethod`, `readerIdentityId`, `ownerIdentityId`, `tokenId`, `signatureDate`, `expirationDate`, `signature`, `slippage?`): `Promise`<`boolean`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `signer` | `Signer` |
| `tokenAddress` | `string` |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) |
| `readerIdentityId` | `BigNumber` |
| `ownerIdentityId` | `BigNumber` |
| `tokenId` | `BigNumber` |
| `signatureDate` | `number` |
| `expirationDate` | `number` |
| `signature` | `string` |
| Name | Type | Default value |
| :------ | :------ | :------ |
| `signer` | `Signer` | `undefined` |
| `tokenAddress` | `string` | `undefined` |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `undefined` |
| `readerIdentityId` | `BigNumber` | `undefined` |
| `ownerIdentityId` | `BigNumber` | `undefined` |
| `tokenId` | `BigNumber` | `undefined` |
| `signatureDate` | `number` | `undefined` |
| `expirationDate` | `number` | `undefined` |
| `signature` | `string` | `undefined` |
| `slippage` | `undefined` \| `number` | `250` |

#### Returns

Expand Down Expand Up @@ -166,18 +167,19 @@ ___

### mintCreditScore

▸ **mintCreditScore**(`wallet`, `paymentMethod`, `identityId`, `authorityAddress`, `signatureDate`, `signature`): `Promise`<`ContractTransaction`\>
▸ **mintCreditScore**(`wallet`, `paymentMethod`, `identityId`, `authorityAddress`, `signatureDate`, `signature`, `slippage?`): `Promise`<`ContractTransaction`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `wallet` | `Wallet` |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) |
| `identityId` | `BigNumber` |
| `authorityAddress` | `string` |
| `signatureDate` | `number` |
| `signature` | `string` |
| Name | Type | Default value |
| :------ | :------ | :------ |
| `wallet` | `Wallet` | `undefined` |
| `paymentMethod` | [`PaymentMethod`](../modules.md#paymentmethod) | `undefined` |
| `identityId` | `BigNumber` | `undefined` |
| `authorityAddress` | `string` | `undefined` |
| `signatureDate` | `number` | `undefined` |
| `signature` | `string` | `undefined` |
| `slippage` | `undefined` \| `number` | `250` |

#### Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaCreditScore.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / MasaCreditScore
- v1.0.4](../README.md) / [Exports](../modules.md) / MasaCreditScore

# Class: MasaCreditScore

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaIdentity.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / MasaIdentity
- v1.0.4](../README.md) / [Exports](../modules.md) / MasaIdentity

# Class: MasaIdentity

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaSession.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / MasaSession
- v1.0.4](../README.md) / [Exports](../modules.md) / MasaSession

# Class: MasaSession

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaSoulLinker.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / MasaSoulLinker
- v1.0.4](../README.md) / [Exports](../modules.md) / MasaSoulLinker

# Class: MasaSoulLinker

Expand Down
2 changes: 1 addition & 1 deletion docs/classes/MasaSoulName.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / MasaSoulName
- v1.0.4](../README.md) / [Exports](../modules.md) / MasaSoulName

# Class: MasaSoulName

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/Addresses.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / Addresses
- v1.0.4](../README.md) / [Exports](../modules.md) / Addresses

# Interface: Addresses

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/Attribute.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / Attribute
- v1.0.4](../README.md) / [Exports](../modules.md) / Attribute

# Interface: Attribute

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/BaseResult.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / BaseResult
- v1.0.4](../README.md) / [Exports](../modules.md) / BaseResult

# Interface: BaseResult

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/Create2FAResult.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / Create2FAResult
- v1.0.4](../README.md) / [Exports](../modules.md) / Create2FAResult

# Interface: Create2FAResult

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/CreateSoulNameResult.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / CreateSoulNameResult
- v1.0.4](../README.md) / [Exports](../modules.md) / CreateSoulNameResult

# Interface: CreateSoulNameResult

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/I2fa.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / I2FA
- v1.0.4](../README.md) / [Exports](../modules.md) / I2FA

# Interface: I2FA

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/ICreditScore.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / ICreditScore
- v1.0.4](../README.md) / [Exports](../modules.md) / ICreditScore

# Interface: ICreditScore

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/IIdentity.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / IIdentity
- v1.0.4](../README.md) / [Exports](../modules.md) / IIdentity

# Interface: IIdentity

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/IIdentityContracts.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / IIdentityContracts
- v1.0.4](../README.md) / [Exports](../modules.md) / IIdentityContracts

# Interface: IIdentityContracts

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/IPassport.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / IPassport
- v1.0.4](../README.md) / [Exports](../modules.md) / IPassport

# Interface: IPassport

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/ISession.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / ISession
- v1.0.4](../README.md) / [Exports](../modules.md) / ISession

# Interface: ISession

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/ISoulName.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / ISoulName
- v1.0.4](../README.md) / [Exports](../modules.md) / ISoulName

# Interface: ISoulName

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/LoadContractArgs.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / LoadContractArgs
- v1.0.4](../README.md) / [Exports](../modules.md) / LoadContractArgs

# Interface: LoadContractArgs

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/MasaArgs.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / MasaArgs
- v1.0.4](../README.md) / [Exports](../modules.md) / MasaArgs

# Interface: MasaArgs

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/MasaConfig.md
View file
@@ -1,5 +1,5 @@
[# Masa SDK
- v1.0.3](../README.md) / [Exports](../modules.md) / MasaConfig
- v1.0.4](../README.md) / [Exports](../modules.md) / MasaConfig

# Interface: MasaConfig

Expand Down
4 changes: 2 additions & 2 deletions docs/modules.md
View file
@@ -1,8 +1,8 @@
[# Masa SDK
- v1.0.3](README.md) / Exports
- v1.0.4](README.md) / Exports

# # Masa SDK
- v1.0.3
- v1.0.4

## Table of contents

Expand Down

0 comments on commit 7a3d8d9

Please sign in to comment.