Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[sdk:ci:bot] Update SDK Documentation #11

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+994 −150
Open

[sdk:ci:bot] Update SDK Documentation #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions source/includes/classes/_Centrifuge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@

## Class: Centrifuge

Defined in: [src/Centrifuge.ts:72](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/Centrifuge.ts#L72)
Defined in: [src/Centrifuge.ts:72](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/Centrifuge.ts#L72)

### Constructors

#### new Centrifuge()

> **new Centrifuge**(`config`): [`Centrifuge`](#class-centrifuge)

Defined in: [src/Centrifuge.ts:97](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/Centrifuge.ts#L97)
Defined in: [src/Centrifuge.ts:97](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/Centrifuge.ts#L97)

##### Parameters

Expand All @@ -29,7 +29,7 @@ Defined in: [src/Centrifuge.ts:97](https://github.com/centrifuge/sdk/blob/1e4b29

> **get** **chains**(): `number`[]

Defined in: [src/Centrifuge.ts:82](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/Centrifuge.ts#L82)
Defined in: [src/Centrifuge.ts:82](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/Centrifuge.ts#L82)

###### Returns

Expand All @@ -43,7 +43,7 @@ Defined in: [src/Centrifuge.ts:82](https://github.com/centrifuge/sdk/blob/1e4b29

> **get** **config**(): `DerivedConfig`

Defined in: [src/Centrifuge.ts:74](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/Centrifuge.ts#L74)
Defined in: [src/Centrifuge.ts:74](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/Centrifuge.ts#L74)

###### Returns

Expand All @@ -57,7 +57,7 @@ Defined in: [src/Centrifuge.ts:74](https://github.com/centrifuge/sdk/blob/1e4b29

> **get** **signer**(): `null` \| [`Signer`](#type-signer)

Defined in: [src/Centrifuge.ts:93](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/Centrifuge.ts#L93)
Defined in: [src/Centrifuge.ts:93](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/Centrifuge.ts#L93)

###### Returns

Expand All @@ -69,7 +69,7 @@ Defined in: [src/Centrifuge.ts:93](https://github.com/centrifuge/sdk/blob/1e4b29

> **account**(`address`, `chainId`?): [`Query`](#type-query)\<`Account`\>

Defined in: [src/Centrifuge.ts:123](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/Centrifuge.ts#L123)
Defined in: [src/Centrifuge.ts:123](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/Centrifuge.ts#L123)

##### Parameters

Expand All @@ -91,7 +91,7 @@ Defined in: [src/Centrifuge.ts:123](https://github.com/centrifuge/sdk/blob/1e4b2

> **balance**(`currency`, `owner`, `chainId`?): [`Query`](#type-query)\<[`Currency`](#class-currency)\>

Defined in: [src/Centrifuge.ts:168](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/Centrifuge.ts#L168)
Defined in: [src/Centrifuge.ts:168](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/Centrifuge.ts#L168)

Get the balance of an ERC20 token for a given owner.

Expand Down Expand Up @@ -125,7 +125,7 @@ The chain ID

> **currency**(`address`, `chainId`?): [`Query`](#type-query)\<[`CurrencyMetadata`](#type-currencymetadata)\>

Defined in: [src/Centrifuge.ts:132](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/Centrifuge.ts#L132)
Defined in: [src/Centrifuge.ts:132](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/Centrifuge.ts#L132)

Get the metadata for an ERC20 token

Expand Down Expand Up @@ -153,7 +153,7 @@ The chain ID

> **getChainConfig**(`chainId`?): `Chain`

Defined in: [src/Centrifuge.ts:85](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/Centrifuge.ts#L85)
Defined in: [src/Centrifuge.ts:85](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/Centrifuge.ts#L85)

##### Parameters

Expand All @@ -171,7 +171,7 @@ Defined in: [src/Centrifuge.ts:85](https://github.com/centrifuge/sdk/blob/1e4b29

> **getClient**(`chainId`?): `undefined` \| \{\}

Defined in: [src/Centrifuge.ts:79](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/Centrifuge.ts#L79)
Defined in: [src/Centrifuge.ts:79](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/Centrifuge.ts#L79)

##### Parameters

Expand All @@ -189,7 +189,7 @@ Defined in: [src/Centrifuge.ts:79](https://github.com/centrifuge/sdk/blob/1e4b29

> **pool**(`id`, `metadataHash`?): [`Query`](#type-query)\<[`Pool`](#class-pool)\>

Defined in: [src/Centrifuge.ts:119](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/Centrifuge.ts#L119)
Defined in: [src/Centrifuge.ts:119](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/Centrifuge.ts#L119)

##### Parameters

Expand All @@ -211,7 +211,7 @@ Defined in: [src/Centrifuge.ts:119](https://github.com/centrifuge/sdk/blob/1e4b2

> **setSigner**(`signer`): `void`

Defined in: [src/Centrifuge.ts:90](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/Centrifuge.ts#L90)
Defined in: [src/Centrifuge.ts:90](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/Centrifuge.ts#L90)

##### Parameters

Expand Down
40 changes: 20 additions & 20 deletions source/includes/classes/_Currency.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

## Class: Currency

Defined in: [src/utils/BigInt.ts:124](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L124)
Defined in: [src/utils/BigInt.ts:124](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L124)

### Extends

Expand All @@ -13,7 +13,7 @@ Defined in: [src/utils/BigInt.ts:124](https://github.com/centrifuge/sdk/blob/1e4

> **new Currency**(`value`, `decimals`): [`Currency`](#class-currency)

Defined in: [src/utils/BigInt.ts:29](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L29)
Defined in: [src/utils/BigInt.ts:29](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L29)

##### Parameters

Expand All @@ -39,7 +39,7 @@ Defined in: [src/utils/BigInt.ts:29](https://github.com/centrifuge/sdk/blob/1e4b

> `readonly` **decimals**: `number` = `27`

Defined in: [src/utils/BigInt.ts:27](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L27)
Defined in: [src/utils/BigInt.ts:27](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L27)

##### Inherited from

Expand All @@ -51,7 +51,7 @@ Defined in: [src/utils/BigInt.ts:27](https://github.com/centrifuge/sdk/blob/1e4b

> `protected` **value**: `bigint`

Defined in: [src/utils/BigInt.ts:3](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L3)
Defined in: [src/utils/BigInt.ts:3](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L3)

##### Inherited from

Expand All @@ -63,15 +63,15 @@ Defined in: [src/utils/BigInt.ts:3](https://github.com/centrifuge/sdk/blob/1e4b2

> `static` **ZERO**: [`Currency`](#class-currency)

Defined in: [src/utils/BigInt.ts:129](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L129)
Defined in: [src/utils/BigInt.ts:129](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L129)

### Methods

#### add()

> **add**(`value`): [`Currency`](#class-currency)

Defined in: [src/utils/BigInt.ts:131](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L131)
Defined in: [src/utils/BigInt.ts:131](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L131)

##### Parameters

Expand All @@ -89,7 +89,7 @@ Defined in: [src/utils/BigInt.ts:131](https://github.com/centrifuge/sdk/blob/1e4

> **div**(`value`): [`Currency`](#class-currency)

Defined in: [src/utils/BigInt.ts:143](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L143)
Defined in: [src/utils/BigInt.ts:143](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L143)

##### Parameters

Expand All @@ -107,7 +107,7 @@ Defined in: [src/utils/BigInt.ts:143](https://github.com/centrifuge/sdk/blob/1e4

> **eq**\<`T`\>(`value`): `boolean`

Defined in: [src/utils/BigInt.ts:115](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L115)
Defined in: [src/utils/BigInt.ts:115](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L115)

##### Type Parameters

Expand All @@ -133,7 +133,7 @@ Defined in: [src/utils/BigInt.ts:115](https://github.com/centrifuge/sdk/blob/1e4

> **gt**\<`T`\>(`value`): `boolean`

Defined in: [src/utils/BigInt.ts:105](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L105)
Defined in: [src/utils/BigInt.ts:105](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L105)

##### Type Parameters

Expand All @@ -159,7 +159,7 @@ Defined in: [src/utils/BigInt.ts:105](https://github.com/centrifuge/sdk/blob/1e4

> **gte**\<`T`\>(`value`): `boolean`

Defined in: [src/utils/BigInt.ts:110](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L110)
Defined in: [src/utils/BigInt.ts:110](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L110)

##### Type Parameters

Expand All @@ -185,7 +185,7 @@ Defined in: [src/utils/BigInt.ts:110](https://github.com/centrifuge/sdk/blob/1e4

> **isZero**(): `boolean`

Defined in: [src/utils/BigInt.ts:119](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L119)
Defined in: [src/utils/BigInt.ts:119](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L119)

##### Returns

Expand All @@ -201,7 +201,7 @@ Defined in: [src/utils/BigInt.ts:119](https://github.com/centrifuge/sdk/blob/1e4

> **lt**\<`T`\>(`value`): `boolean`

Defined in: [src/utils/BigInt.ts:95](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L95)
Defined in: [src/utils/BigInt.ts:95](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L95)

##### Type Parameters

Expand All @@ -227,7 +227,7 @@ Defined in: [src/utils/BigInt.ts:95](https://github.com/centrifuge/sdk/blob/1e4b

> **lte**\<`T`\>(`value`): `boolean`

Defined in: [src/utils/BigInt.ts:100](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L100)
Defined in: [src/utils/BigInt.ts:100](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L100)

##### Type Parameters

Expand All @@ -253,7 +253,7 @@ Defined in: [src/utils/BigInt.ts:100](https://github.com/centrifuge/sdk/blob/1e4

> **mul**(`value`): [`Currency`](#class-currency)

Defined in: [src/utils/BigInt.ts:139](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L139)
Defined in: [src/utils/BigInt.ts:139](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L139)

##### Parameters

Expand All @@ -271,7 +271,7 @@ Defined in: [src/utils/BigInt.ts:139](https://github.com/centrifuge/sdk/blob/1e4

> **sub**(`value`): [`Currency`](#class-currency)

Defined in: [src/utils/BigInt.ts:135](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L135)
Defined in: [src/utils/BigInt.ts:135](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L135)

##### Parameters

Expand All @@ -289,7 +289,7 @@ Defined in: [src/utils/BigInt.ts:135](https://github.com/centrifuge/sdk/blob/1e4

> **toBigInt**(): `bigint`

Defined in: [src/utils/BigInt.ts:21](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L21)
Defined in: [src/utils/BigInt.ts:21](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L21)

##### Returns

Expand All @@ -305,7 +305,7 @@ Defined in: [src/utils/BigInt.ts:21](https://github.com/centrifuge/sdk/blob/1e4b

> **toDecimal**(): `Decimal`

Defined in: [src/utils/BigInt.ts:43](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L43)
Defined in: [src/utils/BigInt.ts:43](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L43)

##### Returns

Expand All @@ -321,7 +321,7 @@ Defined in: [src/utils/BigInt.ts:43](https://github.com/centrifuge/sdk/blob/1e4b

> **toFloat**(): `number`

Defined in: [src/utils/BigInt.ts:47](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L47)
Defined in: [src/utils/BigInt.ts:47](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L47)

##### Returns

Expand All @@ -337,7 +337,7 @@ Defined in: [src/utils/BigInt.ts:47](https://github.com/centrifuge/sdk/blob/1e4b

> **toString**(): `string`

Defined in: [src/utils/BigInt.ts:17](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L17)
Defined in: [src/utils/BigInt.ts:17](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L17)

##### Returns

Expand All @@ -353,7 +353,7 @@ Defined in: [src/utils/BigInt.ts:17](https://github.com/centrifuge/sdk/blob/1e4b

> `static` **fromFloat**(`num`, `decimals`): [`Currency`](#class-currency)

Defined in: [src/utils/BigInt.ts:125](https://github.com/centrifuge/sdk/blob/1e4b2916d77ce8c4f4eb61be819c3477c050b599/src/utils/BigInt.ts#L125)
Defined in: [src/utils/BigInt.ts:125](https://github.com/centrifuge/sdk/blob/89e29cfd91c249c6d0dc7754dc9ba4bee482214a/src/utils/BigInt.ts#L125)

##### Parameters

Expand Down
Loading