Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@H34D
H34D committed Oct 25, 2022
1 parent e8cf287 commit 3671f4d
Show file tree
Hide file tree
Showing 9 changed files with 53 additions and 39 deletions.
16 changes: 15 additions & 1 deletion docs/README.md
View file
Expand Up @@ -43,12 +43,26 @@ export const masa = new Masa({ wallet });

### Interface

For a detailed interface description see [Masa](./docs/modules.md)
For a detailed interface description see [Masa](docs/classes/Masa.md)

### Config

| Key | Type | Description | Default Value |
|------------------|----------------------------------|---------------------------------------------------------------------------------------|-------------------------------------------|
| cookie | `string` | Cookie value. Don't set this manually unless you know what you do! | |
| wallet | `ethers.Signer or ethers.Wallet` | The Wallet instance to use when interacting with the Blockchain. | "wallet with a random private key" |
| apiUrl | `string` | The API Endpoint of the Masa Infrastructure for `dev`, `test`, `beta` and production. | "https://dev.middleware.masa.finance/" |
| environment | `string` | The environment to use `dev`, `test`, `beta`, `production`. | "dev" |
| network | `string` | The network name ie. "goerli". | "goerli" |
| arweave.host | `string` | The arweave host to use for loading metadata. | "arweave.net" |
| arweave.port | `number` | The arweave port to use for loading metadata. | 443 |
| arweave.protocol | `string` | The arweave protocol to use for loading metadata. | "https" |
| arweave.logging | `boolean` | Turn arweave logging on or off. | false |

```typescript
new Masa({
// cookie value for connecting with the backend
cookie: "my fancy cookie",
// wallet object is always mandatory
wallet,
// api endpoint to the masa infrastructure
Expand Down
24 changes: 12 additions & 12 deletions docs/classes/Masa.md
View file
Expand Up @@ -36,7 +36,7 @@

#### Defined in

[src/masa.ts:52](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/masa.ts#L52)
[src/masa.ts:52](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/masa.ts#L52)

## Properties

Expand All @@ -52,7 +52,7 @@

#### Defined in

[src/masa.ts:100](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/masa.ts#L100)
[src/masa.ts:100](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/masa.ts#L100)

___

Expand All @@ -62,7 +62,7 @@ ___

#### Defined in

[src/masa.ts:50](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/masa.ts#L50)
[src/masa.ts:50](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/masa.ts#L50)

___

Expand All @@ -72,7 +72,7 @@ ___

#### Defined in

[src/masa.ts:49](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/masa.ts#L49)
[src/masa.ts:49](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/masa.ts#L49)

___

Expand All @@ -82,7 +82,7 @@ ___

#### Defined in

[src/masa.ts:80](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/masa.ts#L80)
[src/masa.ts:80](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/masa.ts#L80)

___

Expand All @@ -100,7 +100,7 @@ ___

#### Defined in

[src/masa.ts:136](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/masa.ts#L136)
[src/masa.ts:136](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/masa.ts#L136)

___

Expand All @@ -120,7 +120,7 @@ ___

#### Defined in

[src/masa.ts:122](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/masa.ts#L122)
[src/masa.ts:122](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/masa.ts#L122)

___

Expand All @@ -139,7 +139,7 @@ ___

#### Defined in

[src/masa.ts:89](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/masa.ts#L89)
[src/masa.ts:89](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/masa.ts#L89)

___

Expand All @@ -157,7 +157,7 @@ ___

#### Defined in

[src/masa.ts:116](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/masa.ts#L116)
[src/masa.ts:116](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/masa.ts#L116)

___

Expand All @@ -176,7 +176,7 @@ ___

#### Defined in

[src/masa.ts:82](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/masa.ts#L82)
[src/masa.ts:82](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/masa.ts#L82)

___

Expand All @@ -195,7 +195,7 @@ ___

#### Defined in

[src/masa.ts:104](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/masa.ts#L104)
[src/masa.ts:104](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/masa.ts#L104)

___

Expand All @@ -211,4 +211,4 @@ ___

#### Defined in

[src/masa.ts:132](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/masa.ts#L132)
[src/masa.ts:132](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/masa.ts#L132)
6 changes: 3 additions & 3 deletions docs/interfaces/Attribute.md
View file
Expand Up @@ -18,7 +18,7 @@

#### Defined in

[src/interface/soulName.ts:2](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/soulName.ts#L2)
[src/interface/soulName.ts:2](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/soulName.ts#L2)

___

Expand All @@ -28,7 +28,7 @@ ___

#### Defined in

[src/interface/soulName.ts:3](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/soulName.ts#L3)
[src/interface/soulName.ts:3](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/soulName.ts#L3)

___

Expand All @@ -38,4 +38,4 @@ ___

#### Defined in

[src/interface/soulName.ts:4](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/soulName.ts#L4)
[src/interface/soulName.ts:4](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/soulName.ts#L4)
8 changes: 4 additions & 4 deletions docs/interfaces/ICreditReport.md
View file
Expand Up @@ -19,7 +19,7 @@

#### Defined in

[src/interface/creditReport.ts:3](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/creditReport.ts#L3)
[src/interface/creditReport.ts:3](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/creditReport.ts#L3)

___

Expand All @@ -29,7 +29,7 @@ ___

#### Defined in

[src/interface/creditReport.ts:4](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/creditReport.ts#L4)
[src/interface/creditReport.ts:4](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/creditReport.ts#L4)

___

Expand All @@ -39,7 +39,7 @@ ___

#### Defined in

[src/interface/creditReport.ts:2](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/creditReport.ts#L2)
[src/interface/creditReport.ts:2](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/creditReport.ts#L2)

___

Expand All @@ -61,4 +61,4 @@ ___

#### Defined in

[src/interface/creditReport.ts:5](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/creditReport.ts#L5)
[src/interface/creditReport.ts:5](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/creditReport.ts#L5)
10 changes: 5 additions & 5 deletions docs/interfaces/IISoulName.md
View file
Expand Up @@ -20,7 +20,7 @@

#### Defined in

[src/interface/soulName.ts:12](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/soulName.ts#L12)
[src/interface/soulName.ts:12](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/soulName.ts#L12)

___

Expand All @@ -30,7 +30,7 @@ ___

#### Defined in

[src/interface/soulName.ts:8](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/soulName.ts#L8)
[src/interface/soulName.ts:8](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/soulName.ts#L8)

___

Expand All @@ -40,7 +40,7 @@ ___

#### Defined in

[src/interface/soulName.ts:9](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/soulName.ts#L9)
[src/interface/soulName.ts:9](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/soulName.ts#L9)

___

Expand All @@ -50,7 +50,7 @@ ___

#### Defined in

[src/interface/soulName.ts:10](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/soulName.ts#L10)
[src/interface/soulName.ts:10](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/soulName.ts#L10)

___

Expand All @@ -60,4 +60,4 @@ ___

#### Defined in

[src/interface/soulName.ts:11](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/soulName.ts#L11)
[src/interface/soulName.ts:11](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/soulName.ts#L11)
8 changes: 4 additions & 4 deletions docs/interfaces/IIdentity.md
View file
Expand Up @@ -19,7 +19,7 @@

#### Defined in

[src/interface/identity.ts:3](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/identity.ts#L3)
[src/interface/identity.ts:3](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/identity.ts#L3)

___

Expand All @@ -29,7 +29,7 @@ ___

#### Defined in

[src/interface/identity.ts:4](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/identity.ts#L4)
[src/interface/identity.ts:4](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/identity.ts#L4)

___

Expand All @@ -39,7 +39,7 @@ ___

#### Defined in

[src/interface/identity.ts:2](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/identity.ts#L2)
[src/interface/identity.ts:2](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/identity.ts#L2)

___

Expand All @@ -57,4 +57,4 @@ ___

#### Defined in

[src/interface/identity.ts:5](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/identity.ts#L5)
[src/interface/identity.ts:5](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/identity.ts#L5)
10 changes: 5 additions & 5 deletions docs/interfaces/IIdentityContracts.md
View file
Expand Up @@ -20,7 +20,7 @@

#### Defined in

[src/interface/contracts.ts:13](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/contracts.ts#L13)
[src/interface/contracts.ts:13](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/contracts.ts#L13)

___

Expand All @@ -30,7 +30,7 @@ ___

#### Defined in

[src/interface/contracts.ts:12](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/contracts.ts#L12)
[src/interface/contracts.ts:12](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/contracts.ts#L12)

___

Expand All @@ -40,7 +40,7 @@ ___

#### Defined in

[src/interface/contracts.ts:14](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/contracts.ts#L14)
[src/interface/contracts.ts:14](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/contracts.ts#L14)

___

Expand All @@ -50,7 +50,7 @@ ___

#### Defined in

[src/interface/contracts.ts:11](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/contracts.ts#L11)
[src/interface/contracts.ts:11](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/contracts.ts#L11)

___

Expand All @@ -60,4 +60,4 @@ ___

#### Defined in

[src/interface/contracts.ts:10](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/interface/contracts.ts#L10)
[src/interface/contracts.ts:10](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/interface/contracts.ts#L10)
4 changes: 2 additions & 2 deletions docs/interfaces/LoadContractArgs.md
View file
Expand Up @@ -17,7 +17,7 @@

#### Defined in

[src/contracts/index.ts:31](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/contracts/index.ts#L31)
[src/contracts/index.ts:31](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/contracts/index.ts#L31)

___

Expand All @@ -27,4 +27,4 @@ ___

#### Defined in

[src/contracts/index.ts:30](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/contracts/index.ts#L30)
[src/contracts/index.ts:30](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/contracts/index.ts#L30)
6 changes: 3 additions & 3 deletions docs/modules.md
View file
Expand Up @@ -38,7 +38,7 @@

#### Defined in

[src/contracts/contract-service.ts:8](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/contracts/contract-service.ts#L8)
[src/contracts/contract-service.ts:8](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/contracts/contract-service.ts#L8)

## Variables

Expand All @@ -48,7 +48,7 @@

#### Defined in

[src/contracts/index.ts:25](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/contracts/index.ts#L25)
[src/contracts/index.ts:25](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/contracts/index.ts#L25)

## Functions

Expand All @@ -68,4 +68,4 @@

#### Defined in

[src/contracts/index.ts:34](https://github.com/masa-finance/masa-sdk/blob/72beff4/src/contracts/index.ts#L34)
[src/contracts/index.ts:34](https://github.com/masa-finance/masa-sdk/blob/e8cf287/src/contracts/index.ts#L34)

0 comments on commit 3671f4d

Please sign in to comment.