Skip to content

Commit

Permalink
docs: generate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
web-flow committed Jul 5, 2023
1 parent 4e481fb commit 7bc96fa
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 77 deletions.
56 changes: 21 additions & 35 deletions www/docs/API/classes/CallData.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ custom_edit_url: null

#### Defined in

[src/utils/calldata/index.ts:34](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L34)
[src/utils/calldata/index.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L37)

## Properties

Expand All @@ -30,7 +30,17 @@ custom_edit_url: null

#### Defined in

[src/utils/calldata/index.ts:30](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L30)
[src/utils/calldata/index.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L31)

---

### parser

**parser**: `AbiParserInterface`

#### Defined in

[src/utils/calldata/index.ts:33](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L33)

---

Expand All @@ -40,7 +50,7 @@ custom_edit_url: null

#### Defined in

[src/utils/calldata/index.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L32)
[src/utils/calldata/index.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L35)

## Methods

Expand All @@ -64,31 +74,7 @@ Calldata

#### Defined in

[src/utils/calldata/index.ts:121](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L121)

---

### abiInputsLength

`Static` **abiInputsLength**(`inputs`): `number`

Helper to calculate inputs from abi

#### Parameters

| Name | Type | Description |
| :------- | :---------------------------------------------- | :---------- |
| `inputs` | [`AbiEntry`](../namespaces/types.md#abientry)[] | AbiEntry |

#### Returns

`number`

number

#### Defined in

[src/utils/calldata/index.ts:202](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L202)
[src/utils/calldata/index.ts:125](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L125)

---

Expand All @@ -112,7 +98,7 @@ AbiStructs - structs from abi

#### Defined in

[src/utils/calldata/index.ts:211](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L211)
[src/utils/calldata/index.ts:206](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L206)

---

Expand All @@ -136,7 +122,7 @@ Calldata

#### Defined in

[src/utils/calldata/index.ts:228](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L228)
[src/utils/calldata/index.ts:223](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L223)

---

Expand All @@ -160,7 +146,7 @@ HexCalldata

#### Defined in

[src/utils/calldata/index.ts:237](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L237)
[src/utils/calldata/index.ts:232](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L232)

---

Expand All @@ -184,7 +170,7 @@ Validate arguments passed to the method as corresponding to the ones in the abi

#### Defined in

[src/utils/calldata/index.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L45)
[src/utils/calldata/index.ts:49](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L49)

---

Expand Down Expand Up @@ -220,7 +206,7 @@ Calldata - parsed arguments in format that contract is expecting

#### Defined in

[src/utils/calldata/index.ts:94](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L94)
[src/utils/calldata/index.ts:98](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L98)

---

Expand All @@ -245,7 +231,7 @@ Result - parsed response corresponding to the abi

#### Defined in

[src/utils/calldata/index.ts:168](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L168)
[src/utils/calldata/index.ts:172](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L172)

---

Expand All @@ -271,4 +257,4 @@ Result - parsed and formatted response object

#### Defined in

[src/utils/calldata/index.ts:192](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L192)
[src/utils/calldata/index.ts:196](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L196)
38 changes: 19 additions & 19 deletions www/docs/API/classes/Contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Contract class to handle contract methods

#### Defined in

[src/contract/default.ts:145](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L145)
[src/contract/default.ts:146](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L146)

## Properties

Expand All @@ -48,7 +48,7 @@ Contract class to handle contract methods

#### Defined in

[src/contract/default.ts:116](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L116)
[src/contract/default.ts:117](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L117)

---

Expand All @@ -62,7 +62,7 @@ Contract class to handle contract methods

#### Defined in

[src/contract/default.ts:118](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L118)
[src/contract/default.ts:119](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L119)

---

Expand All @@ -76,7 +76,7 @@ Contract class to handle contract methods

#### Defined in

[src/contract/default.ts:120](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L120)
[src/contract/default.ts:121](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L121)

---

Expand All @@ -90,7 +90,7 @@ Contract class to handle contract methods

#### Defined in

[src/contract/default.ts:122](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L122)
[src/contract/default.ts:123](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L123)

---

Expand All @@ -104,7 +104,7 @@ Contract class to handle contract methods

#### Defined in

[src/contract/default.ts:124](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L124)
[src/contract/default.ts:125](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L125)

---

Expand All @@ -122,7 +122,7 @@ Contract class to handle contract methods

#### Defined in

[src/contract/default.ts:126](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L126)
[src/contract/default.ts:127](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L127)

---

Expand All @@ -140,7 +140,7 @@ Contract class to handle contract methods

#### Defined in

[src/contract/default.ts:128](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L128)
[src/contract/default.ts:129](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L129)

---

Expand All @@ -158,7 +158,7 @@ Contract class to handle contract methods

#### Defined in

[src/contract/default.ts:130](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L130)
[src/contract/default.ts:131](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L131)

---

Expand All @@ -176,7 +176,7 @@ Contract class to handle contract methods

#### Defined in

[src/contract/default.ts:132](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L132)
[src/contract/default.ts:133](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L133)

---

Expand All @@ -186,7 +186,7 @@ Contract class to handle contract methods

#### Defined in

[src/contract/default.ts:136](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L136)
[src/contract/default.ts:137](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L137)

## Methods

Expand All @@ -212,7 +212,7 @@ Saves the address of the contract deployed on network that will be used for inte

#### Defined in

[src/contract/default.ts:199](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L199)
[src/contract/default.ts:201](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L201)

---

Expand All @@ -238,7 +238,7 @@ Attaches to new Provider or Account

#### Defined in

[src/contract/default.ts:203](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L203)
[src/contract/default.ts:205](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L205)

---

Expand All @@ -264,7 +264,7 @@ Promise that resolves when contract is deployed on the network or when no deploy

#### Defined in

[src/contract/default.ts:207](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L207)
[src/contract/default.ts:209](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L209)

---

Expand Down Expand Up @@ -294,7 +294,7 @@ Result of the call as an array with key value pars

#### Defined in

[src/contract/default.ts:215](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L215)
[src/contract/default.ts:217](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L217)

---

Expand Down Expand Up @@ -324,7 +324,7 @@ Add Transaction Response

#### Defined in

[src/contract/default.ts:257](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L257)
[src/contract/default.ts:259](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L259)

---

Expand All @@ -351,7 +351,7 @@ Estimates a method on a contract

#### Defined in

[src/contract/default.ts:301](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L301)
[src/contract/default.ts:303](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L303)

---

Expand Down Expand Up @@ -380,7 +380,7 @@ Invocation object

#### Defined in

[src/contract/default.ts:315](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L315)
[src/contract/default.ts:317](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L317)

---

Expand Down Expand Up @@ -408,4 +408,4 @@ TRUE if the contract comes from a Cairo1 contract

#### Defined in

[src/contract/default.ts:325](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L325)
[src/contract/default.ts:327](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L327)
6 changes: 3 additions & 3 deletions www/docs/API/modules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: 'modules'
title: 'Starknet.js API - v5.15.0'
title: 'Starknet.js API - v5.16.0'
sidebar_label: 'Exports'
sidebar_position: 0.5
custom_edit_url: null
Expand Down Expand Up @@ -904,7 +904,7 @@ prefer the 'num' naming

#### Defined in

[src/contract/default.ts:99](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L99)
[src/contract/default.ts:100](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L100)

---

Expand All @@ -924,7 +924,7 @@ prefer the 'num' naming

#### Defined in

[src/contract/default.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L26)
[src/contract/default.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L27)

---

Expand Down
6 changes: 3 additions & 3 deletions www/docs/API/namespaces/cairo.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ felt cairo type

#### Defined in

[src/utils/calldata/cairo.ts:81](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L81)
[src/utils/calldata/cairo.ts:85](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L85)

---

Expand Down Expand Up @@ -319,7 +319,7 @@ Uint256 cairo type (helper for common struct type)

#### Defined in

[src/utils/calldata/cairo.ts:60](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L60)
[src/utils/calldata/cairo.ts:64](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L64)

---

Expand All @@ -341,4 +341,4 @@ unnamed tuple cairo type (helper same as common struct type)

#### Defined in

[src/utils/calldata/cairo.ts:74](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L74)
[src/utils/calldata/cairo.ts:78](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L78)
Loading

0 comments on commit 7bc96fa

Please sign in to comment.