Skip to content

Commit

Permalink
docs: rebuild
Browse files Browse the repository at this point in the history
  • Loading branch information
Unique-Divine committed Dec 5, 2023
1 parent fe5a329 commit 3e2dcd7
Show file tree
Hide file tree
Showing 34 changed files with 481 additions and 481 deletions.
44 changes: 22 additions & 22 deletions packages/nibijs/docs/classes/CustomChain.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ export const TEST_CHAIN = new CustomChain({

#### Parameters

| Name | Type |
| :------------- | :---------------------------------------------- |
| Name | Type |
| :------ | :------ |
| `chainIdParts` | [`ChainIdParts`](../interfaces/ChainIdParts.md) |

#### Defined in

[chain/chain.ts:57](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L57)
[chain/chain.ts:57](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L57)

## Properties

Expand All @@ -70,19 +70,19 @@ chainId: identifier for the chain

#### Defined in

[chain/chain.ts:48](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L48)
[chain/chain.ts:48](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L48)

---
___

### chainIdParts

`Private` `Readonly` **chainIdParts**: [`ChainIdParts`](../interfaces/ChainIdParts.md)

#### Defined in

[chain/chain.ts:55](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L55)
[chain/chain.ts:55](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L55)

---
___

### chainName

Expand All @@ -96,9 +96,9 @@ chainName: the name of the chain to display to the user

#### Defined in

[chain/chain.ts:49](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L49)
[chain/chain.ts:49](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L49)

---
___

### endptGrpc

Expand All @@ -112,9 +112,9 @@ endptGrpc: endpoint for the gRPC gateway. Usually on port 9090.

#### Defined in

[chain/chain.ts:52](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L52)
[chain/chain.ts:52](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L52)

---
___

### endptRest

Expand All @@ -128,9 +128,9 @@ endptRest: endpoint for the REST server. Also, the LCD endpoint.

#### Defined in

[chain/chain.ts:51](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L51)
[chain/chain.ts:51](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L51)

---
___

### endptTm

Expand All @@ -144,13 +144,13 @@ endptTm: endpoint for the Tendermint RPC server. Usually on port 26657.

#### Defined in

[chain/chain.ts:50](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L50)
[chain/chain.ts:50](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L50)

---
___

### feeDenom

`Readonly` **feeDenom**: `"unibi"`
`Readonly` **feeDenom**: ``"unibi"``

feeDenom: the denomination of the fee to be paid for transactions.

Expand All @@ -160,7 +160,7 @@ feeDenom: the denomination of the fee to be paid for transactions.

#### Defined in

[chain/chain.ts:53](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L53)
[chain/chain.ts:53](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L53)

## Methods

Expand All @@ -174,18 +174,18 @@ feeDenom: the denomination of the fee to be paid for transactions.

#### Defined in

[chain/chain.ts:76](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L76)
[chain/chain.ts:76](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L76)

---
___

### fromChainId

`Static` **fromChainId**(`chainId`): [`Chain`](../interfaces/Chain.md)

#### Parameters

| Name | Type |
| :-------- | :------- |
| Name | Type |
| :------ | :------ |
| `chainId` | `string` |

#### Returns
Expand All @@ -194,4 +194,4 @@ feeDenom: the denomination of the fee to be paid for transactions.

#### Defined in

[chain/chain.ts:66](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L66)
[chain/chain.ts:66](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L66)
6 changes: 3 additions & 3 deletions packages/nibijs/docs/classes/MsgFactory.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@

#### Defined in

[msg/index.ts:6](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/index.ts#L6)
[msg/index.ts:6](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/index.ts#L6)

---
___

### spot

**spot**: typeof [`SpotMsgFactory`](SpotMsgFactory.md) = `SpotMsgFactory`

#### Defined in

[msg/index.ts:5](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/index.ts#L5)
[msg/index.ts:5](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/index.ts#L5)
40 changes: 20 additions & 20 deletions packages/nibijs/docs/classes/NibiruQueryClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,19 @@

#### Parameters

| Name | Type |
| :----------- | :---------------------- |
| `tmClient` | `Tendermint37Client` |
| `options` | `StargateClientOptions` |
| `wasmClient` | `CosmWasmClient` |
| Name | Type |
| :------ | :------ |
| `tmClient` | `Tendermint37Client` |
| `options` | `StargateClientOptions` |
| `wasmClient` | `CosmWasmClient` |

#### Overrides

StargateClient.constructor

#### Defined in

[query/query.ts:56](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/query.ts#L56)
[query/query.ts:56](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/query.ts#L56)

## Properties

Expand All @@ -55,17 +55,17 @@ StargateClient.constructor

#### Defined in

[query/query.ts:44](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/query.ts#L44)
[query/query.ts:44](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/query.ts#L44)

---
___

### wasmClient

`Readonly` **wasmClient**: `CosmWasmClient`

#### Defined in

[query/query.ts:45](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/query.ts#L45)
[query/query.ts:45](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/query.ts#L45)

## Methods

Expand All @@ -75,8 +75,8 @@ StargateClient.constructor

#### Parameters

| Name | Type |
| :------- | :------- |
| Name | Type |
| :------ | :------ |
| `height` | `number` |

#### Returns
Expand All @@ -85,9 +85,9 @@ StargateClient.constructor

#### Defined in

[query/query.ts:80](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/query.ts#L80)
[query/query.ts:80](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/query.ts#L80)

---
___

### waitForNextBlock

Expand All @@ -99,20 +99,20 @@ StargateClient.constructor

#### Defined in

[query/query.ts:88](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/query.ts#L88)
[query/query.ts:88](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/query.ts#L88)

---
___

### connect

`Static` **connect**(`endpoint`, `options?`): `Promise`<[`NibiruQueryClient`](NibiruQueryClient.md)\>

#### Parameters

| Name | Type |
| :--------- | :---------------------- |
| `endpoint` | `string` |
| `options` | `StargateClientOptions` |
| Name | Type |
| :------ | :------ |
| `endpoint` | `string` |
| `options` | `StargateClientOptions` |

#### Returns

Expand All @@ -124,4 +124,4 @@ StargateClient.connect

#### Defined in

[query/query.ts:47](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/query.ts#L47)
[query/query.ts:47](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/query.ts#L47)
44 changes: 22 additions & 22 deletions packages/nibijs/docs/classes/NibiruSigningClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,20 @@

#### Parameters

| Name | Type |
| :--------- | :----------------------------- |
| `tmClient` | `Tendermint37Client` |
| `signer` | `OfflineSigner` |
| `options` | `SigningStargateClientOptions` |
| `wasm` | `SigningCosmWasmClient` |
| Name | Type |
| :------ | :------ |
| `tmClient` | `Tendermint37Client` |
| `signer` | `OfflineSigner` |
| `options` | `SigningStargateClientOptions` |
| `wasm` | `SigningCosmWasmClient` |

#### Overrides

SigningStargateClient.constructor

#### Defined in

[tx/signingClient.ts:41](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signingClient.ts#L41)
[tx/signingClient.ts:41](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signingClient.ts#L41)

## Properties

Expand All @@ -56,17 +56,17 @@ SigningStargateClient.constructor

#### Defined in

[tx/signingClient.ts:38](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signingClient.ts#L38)
[tx/signingClient.ts:38](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signingClient.ts#L38)

---
___

### wasmClient

`Readonly` **wasmClient**: `SigningCosmWasmClient`

#### Defined in

[tx/signingClient.ts:39](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signingClient.ts#L39)
[tx/signingClient.ts:39](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signingClient.ts#L39)

## Methods

Expand All @@ -76,8 +76,8 @@ SigningStargateClient.constructor

#### Parameters

| Name | Type |
| :------- | :------- |
| Name | Type |
| :------ | :------ |
| `height` | `number` |

#### Returns
Expand All @@ -86,9 +86,9 @@ SigningStargateClient.constructor

#### Defined in

[tx/signingClient.ts:94](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signingClient.ts#L94)
[tx/signingClient.ts:94](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signingClient.ts#L94)

---
___

### waitForNextBlock

Expand All @@ -100,21 +100,21 @@ SigningStargateClient.constructor

#### Defined in

[tx/signingClient.ts:102](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signingClient.ts#L102)
[tx/signingClient.ts:102](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signingClient.ts#L102)

---
___

### connectWithSigner

`Static` **connectWithSigner**(`endpoint`, `signer`, `options?`, `wasmOptions?`): `Promise`<[`NibiruSigningClient`](NibiruSigningClient.md)\>

#### Parameters

| Name | Type |
| :------------ | :----------------------------- |
| `endpoint` | `string` |
| `signer` | `OfflineSigner` |
| `options` | `SigningStargateClientOptions` |
| Name | Type |
| :------ | :------ |
| `endpoint` | `string` |
| `signer` | `OfflineSigner` |
| `options` | `SigningStargateClientOptions` |
| `wasmOptions` | `SigningCosmWasmClientOptions` |

#### Returns
Expand All @@ -127,4 +127,4 @@ SigningStargateClient.connectWithSigner

#### Defined in

[tx/signingClient.ts:66](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signingClient.ts#L66)
[tx/signingClient.ts:66](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signingClient.ts#L66)
Loading

0 comments on commit 3e2dcd7

Please sign in to comment.