Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
serg-plusplus committed Jun 21, 2021
1 parent e5aeb37 commit e70df8a
Show file tree
Hide file tree
Showing 23 changed files with 137 additions and 102 deletions.
42 changes: 21 additions & 21 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,23 +67,23 @@

Ƭ **TempleDAppMessage**: *[TempleDAppRequest](README.md#templedapprequest) | [TempleDAppResponse](README.md#templedappresponse)*

*Defined in [types.ts:1](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/types.ts#L1)*
*Defined in [types.ts:1](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/types.ts#L1)*

___

### TempleDAppNetwork

Ƭ **TempleDAppNetwork**: *"mainnet" | "edo2net" | "delphinet" | "edo2net" | "carthagenet" | "sandbox" | object*
Ƭ **TempleDAppNetwork**: *"mainnet" | "edo2net" | "florencenet" | "sandbox" | object*

*Defined in [types.ts:115](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/types.ts#L115)*
*Defined in [types.ts:115](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/types.ts#L115)*

___

### TempleDAppPermission

Ƭ **TempleDAppPermission**: *object | null*

*Defined in [types.ts:109](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/types.ts#L109)*
*Defined in [types.ts:109](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/types.ts#L109)*

Misc

Expand All @@ -93,23 +93,23 @@ ___

Ƭ **TempleDAppRequest**: *[TempleDAppGetCurrentPermissionRequest](interfaces/templedappgetcurrentpermissionrequest.md) | [TempleDAppPermissionRequest](interfaces/templedapppermissionrequest.md) | [TempleDAppOperationRequest](interfaces/templedappoperationrequest.md) | [TempleDAppSignRequest](interfaces/templedappsignrequest.md) | [TempleDAppBroadcastRequest](interfaces/templedappbroadcastrequest.md)*

*Defined in [types.ts:3](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/types.ts#L3)*
*Defined in [types.ts:3](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/types.ts#L3)*

___

### TempleDAppResponse

Ƭ **TempleDAppResponse**: *[TempleDAppGetCurrentPermissionResponse](interfaces/templedappgetcurrentpermissionresponse.md) | [TempleDAppPermissionResponse](interfaces/templedapppermissionresponse.md) | [TempleDAppOperationResponse](interfaces/templedappoperationresponse.md) | [TempleDAppSignResponse](interfaces/templedappsignresponse.md) | [TempleDAppBroadcastResponse](interfaces/templedappbroadcastresponse.md)*

*Defined in [types.ts:10](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/types.ts#L10)*
*Defined in [types.ts:10](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/types.ts#L10)*

## Functions

### assertConnected

**assertConnected**(`perm`: [TempleDAppPermission](README.md#templedapppermission)): *asserts perm*

*Defined in [taquito-wallet.ts:106](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/taquito-wallet.ts#L106)*
*Defined in [taquito-wallet.ts:147](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/taquito-wallet.ts#L147)*

**Parameters:**

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

**assertResponse**(`condition`: any): *asserts condition*

*Defined in [client.ts:204](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L204)*
*Defined in [client.ts:204](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L204)*

**Parameters:**

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

**createError**(`payload`: any): *[TempleWalletError](classes/templewalleterror.md)‹› | TezosOperationError‹›*

*Defined in [client.ts:179](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L179)*
*Defined in [client.ts:179](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L179)*

**Parameters:**

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

**formatOpParams**(`op`: any): *any*

*Defined in [taquito-wallet.ts:112](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/taquito-wallet.ts#L112)*
*Defined in [taquito-wallet.ts:153](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/taquito-wallet.ts#L153)*

**Parameters:**

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

**getCurrentPermission**(): *Promise‹null | object›*

*Defined in [client.ts:82](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L82)*
*Defined in [client.ts:82](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L82)*

**Returns:** *Promise‹null | object›*

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

**isAvailable**(): *Promise‹boolean›*

*Defined in [client.ts:15](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L15)*
*Defined in [client.ts:15](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L15)*

**Returns:** *Promise‹boolean›*

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

**onAvailabilityChange**(`callback`: function): *(Anonymous function)*

*Defined in [client.ts:42](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L42)*
*Defined in [client.ts:42](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L42)*

**Parameters:**

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

**onPermissionChange**(`callback`: function): *(Anonymous function)*

*Defined in [client.ts:62](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L62)*
*Defined in [client.ts:62](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L62)*

**Parameters:**

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

**permissionsAreEqual**(`aPerm`: [TempleDAppPermission](README.md#templedapppermission), `bPerm`: [TempleDAppPermission](README.md#templedapppermission)): *boolean*

*Defined in [client.ts:171](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L171)*
*Defined in [client.ts:171](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L171)*

**Parameters:**

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

**request**(`payload`: [TempleDAppRequest](README.md#templedapprequest)): *Promise‹[TempleDAppGetCurrentPermissionResponse](interfaces/templedappgetcurrentpermissionresponse.md) | [TempleDAppPermissionResponse](interfaces/templedapppermissionresponse.md) | [TempleDAppOperationResponse](interfaces/templedappoperationresponse.md) | [TempleDAppSignResponse](interfaces/templedappsignresponse.md) | [TempleDAppBroadcastResponse](interfaces/templedappbroadcastresponse.md)*

*Defined in [client.ts:140](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L140)*
*Defined in [client.ts:140](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L140)*

**Parameters:**

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

**requestBroadcast**(`signedOpBytes`: string): *Promise‹string›*

*Defined in [client.ts:131](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L131)*
*Defined in [client.ts:131](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L131)*

**Parameters:**

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

**requestOperation**(`sourcePkh`: string, `opParams`: any): *Promise‹string›*

*Defined in [client.ts:111](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L111)*
*Defined in [client.ts:111](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L111)*

**Parameters:**

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

**requestPermission**(`network`: [TempleDAppNetwork](README.md#templedappnetwork), `appMeta`: [TempleDAppMetadata](interfaces/templedappmetadata.md), `force`: boolean): *Promise‹object›*

*Defined in [client.ts:92](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L92)*
*Defined in [client.ts:92](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L92)*

**Parameters:**

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

**requestSign**(`sourcePkh`: string, `payload`: string): *Promise‹string›*

*Defined in [client.ts:121](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L121)*
*Defined in [client.ts:121](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L121)*

**Parameters:**

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

**send**(`msg`: [TemplePageMessage](interfaces/templepagemessage.md)): *void*

*Defined in [client.ts:210](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L210)*
*Defined in [client.ts:210](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L210)*

**Parameters:**

Expand Down
4 changes: 2 additions & 2 deletions docs/classes/invalidparamstemplewalleterror.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

*Overrides [TempleWalletError](templewalleterror.md).[message](templewalleterror.md#message)*

*Defined in [client.ts:231](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L231)*
*Defined in [client.ts:231](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L231)*

___

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

*Overrides [TempleWalletError](templewalleterror.md).[name](templewalleterror.md#name)*

*Defined in [client.ts:230](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L230)*
*Defined in [client.ts:230](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L230)*
4 changes: 2 additions & 2 deletions docs/classes/notconnectedtemplewalleterror.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

*Overrides [TempleWalletError](templewalleterror.md).[message](templewalleterror.md#message)*

*Defined in [taquito-wallet.ts:102](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/taquito-wallet.ts#L102)*
*Defined in [taquito-wallet.ts:143](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/taquito-wallet.ts#L143)*

___

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

*Overrides [TempleWalletError](templewalleterror.md).[name](templewalleterror.md#name)*

*Defined in [taquito-wallet.ts:101](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/taquito-wallet.ts#L101)*
*Defined in [taquito-wallet.ts:142](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/taquito-wallet.ts#L142)*
4 changes: 2 additions & 2 deletions docs/classes/notfoundtemplewalleterror.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

*Overrides [TempleWalletError](templewalleterror.md).[message](templewalleterror.md#message)*

*Defined in [client.ts:226](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L226)*
*Defined in [client.ts:226](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L226)*

___

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

*Overrides [TempleWalletError](templewalleterror.md).[name](templewalleterror.md#name)*

*Defined in [client.ts:225](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L225)*
*Defined in [client.ts:225](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L225)*
4 changes: 2 additions & 2 deletions docs/classes/notgrantedtemplewalleterror.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

*Overrides [TempleWalletError](templewalleterror.md).[message](templewalleterror.md#message)*

*Defined in [client.ts:221](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L221)*
*Defined in [client.ts:221](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L221)*

___

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

*Overrides [TempleWalletError](templewalleterror.md).[name](templewalleterror.md#name)*

*Defined in [client.ts:220](https://github.com/madfish-solutions/templewallet-dapp/blob/91ad23c/src/client.ts#L220)*
*Defined in [client.ts:220](https://github.com/madfish-solutions/templewallet-dapp/blob/e5aeb37/src/client.ts#L220)*
Loading

0 comments on commit e70df8a

Please sign in to comment.