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

Jump to bottom

refactor: adding hm & ws to custom chain #269

Merged
merged 1 commit into from
Dec 13, 2023
Merged

refactor: adding hm & ws to custom chain #269

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 packages/nibijs/docs/classes/CustomChain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ export const chain = new CustomChain({

#### Parameters

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

#### Defined in
Expand All @@ -72,7 +72,7 @@ chainId: identifier for the chain

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

___
---

### chainIdParts

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

[chain/chain.ts:64](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L64)

___
---

### chainName

Expand All @@ -98,7 +98,7 @@ chainName: the name of the chain to display to the user

[chain/chain.ts:58](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L58)

___
---

### endptGrpc

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

[chain/chain.ts:61](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L61)

___
---

### endptRest

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

[chain/chain.ts:60](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L60)

___
---

### endptTm

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

[chain/chain.ts:59](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L59)

___
---

### feeDenom

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

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

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

[chain/chain.ts:90](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L90)

___
---

### fromChainId

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

#### Parameters

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

#### Returns
Expand Down
2 changes: 1 addition & 1 deletion packages/nibijs/docs/classes/MsgFactory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

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

___
---

### spot

Expand Down
46 changes: 24 additions & 22 deletions packages/nibijs/docs/classes/NibiruQuerier.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ const querier = await NibiruQuerier.connect(chain.endptTm)

#### Parameters

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

#### Overrides

Expand All @@ -70,7 +70,7 @@ StargateClient.constructor

[query/query.ts:53](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/query/query.ts#L53)

___
---

### tm

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

[query/query.ts:55](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/query/query.ts#L55)

___
---

### wasmClient

Expand All @@ -100,15 +100,16 @@ getTxByHash: Query a transaction (tx) using its hexadecial encoded tx hash.
A tx hash uniquely identifies a tx on the blockchain.

The hex-encoded tx hash is:

- An unambiguous representation of the SHA-256 cryptographic hash in the
consensus layer.
- Well-suited for human-facing applications, as it is easier to work with
than bytes.

#### Parameters

| Name | Type |
| :------ | :------ |
| Name | Type |
| :---------- | :------- |
| `txHashHex` | `string` |

#### Returns
Expand All @@ -118,15 +119,16 @@ The hex-encoded tx hash is:
**`Example`**

```ts
const txHash = "7A919F2CC9A51B139444F7D8E84A46EEF307E839C6CA914C1A1C594FEF5C1562"
const txHash =
"7A919F2CC9A51B139444F7D8E84A46EEF307E839C6CA914C1A1C594FEF5C1562"
const txRespResult = await getTxByHash(txHash)
```

#### Defined in

[query/query.ts:122](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/query/query.ts#L122)

___
---

### getTxByHashBytes

Expand All @@ -137,8 +139,8 @@ A tx hash uniquely identifies a tx on the blockchain.

#### Parameters

| Name | Type |
| :------ | :------ |
| Name | Type |
| :------- | :----------- |
| `txHash` | `Uint8Array` |

#### Returns
Expand All @@ -153,16 +155,16 @@ getTxByHash - Equivalent query using the hex-encoded tx hash string.

[query/query.ts:136](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/query/query.ts#L136)

___
---

### waitForHeight

▸ **waitForHeight**(`height`): `Promise`<`void`\>

#### Parameters

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

#### Returns
Expand All @@ -173,7 +175,7 @@ ___

[query/query.ts:92](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/query/query.ts#L92)

___
---

### waitForNextBlock

Expand All @@ -187,18 +189,18 @@ ___

[query/query.ts:100](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/query/query.ts#L100)

___
---

### connect

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

#### Parameters

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

#### Returns

Expand Down
32 changes: 16 additions & 16 deletions packages/nibijs/docs/classes/NibiruTxClient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@

#### Parameters

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

#### Overrides

Expand All @@ -58,7 +58,7 @@ SigningStargateClient.constructor

[tx/txClient.ts:38](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/tx/txClient.ts#L38)

___
---

### wasmClient

Expand All @@ -76,8 +76,8 @@ ___

#### Parameters

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

#### Returns
Expand All @@ -88,7 +88,7 @@ ___

[tx/txClient.ts:94](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/tx/txClient.ts#L94)

___
---

### waitForNextBlock

Expand All @@ -102,19 +102,19 @@ ___

[tx/txClient.ts:102](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/tx/txClient.ts#L102)

___
---

### connectWithSigner

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

#### Parameters

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

#### Returns
Expand Down
Loading