PR comments

NibiruChain · Dec 13, 2023 · e4d449a · e4d449a
1 parent cacf9b9
commit e4d449a
Show file tree

Hide file tree

Showing 37 changed files with 598 additions and 602 deletions.
diff --git a/packages/examples/package.json b/packages/examples/package.json
@@ -6,7 +6,7 @@
   "dependencies": {
     "@cosmjs/amino": "^0.32.1",
     "@cosmjs/proto-signing": "^0.32.1",
-    "@nibiruchain/nibijs": "0.21.42"
+    "@nibiruchain/nibijs": "0.21.43"
   },
   "engines": {
     "node": ">=18"

diff --git a/packages/nibijs/docs/classes/CustomChain.md b/packages/nibijs/docs/classes/CustomChain.md
@@ -12,7 +12,7 @@ export const chain = new CustomChain({
   prefix: "nibiru",
   shortName: "testnet",
   number: 1,
-}) // v0.21.43
+})
 ```
 
 ## Implements
@@ -48,13 +48,13 @@ export const chain = new CustomChain({
 
 #### Parameters
 
-| Name           | Type                                            |
-| :------------- | :---------------------------------------------- |
+| Name | Type |
+| :------ | :------ |
 | `chainIdParts` | [`ChainIdParts`](../interfaces/ChainIdParts.md) |
 
 #### Defined in
 
-[chain/chain.ts:66](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/chain/chain.ts#L66)
+[chain/chain.ts:66](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L66)
 
 ## Properties
 
@@ -70,19 +70,19 @@ chainId: identifier for the chain
 
 #### Defined in
 
-[chain/chain.ts:57](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/chain/chain.ts#L57)
+[chain/chain.ts:57](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L57)
 
----
+___
 
 ### chainIdParts
 
 • `Private` `Readonly` **chainIdParts**: [`ChainIdParts`](../interfaces/ChainIdParts.md)
 
 #### Defined in
 
-[chain/chain.ts:64](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/chain/chain.ts#L64)
+[chain/chain.ts:64](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L64)
 
----
+___
 
 ### chainName
 
@@ -96,9 +96,9 @@ chainName: the name of the chain to display to the user
 
 #### Defined in
 
-[chain/chain.ts:58](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/chain/chain.ts#L58)
+[chain/chain.ts:58](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L58)
 
----
+___
 
 ### endptGrpc
 
@@ -112,9 +112,9 @@ endptGrpc: endpoint for the gRPC gateway. Usually on port 9090.
 
 #### Defined in
 
-[chain/chain.ts:61](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/chain/chain.ts#L61)
+[chain/chain.ts:61](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L61)
 
----
+___
 
 ### endptRest
 
@@ -128,9 +128,9 @@ endptRest: endpoint for the REST server. Also, the LCD endpoint.
 
 #### Defined in
 
-[chain/chain.ts:60](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/chain/chain.ts#L60)
+[chain/chain.ts:60](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L60)
 
----
+___
 
 ### endptTm
 
@@ -144,13 +144,13 @@ endptTm: endpoint for the Tendermint RPC server. Usually on port 26657.
 
 #### Defined in
 
-[chain/chain.ts:59](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/chain/chain.ts#L59)
+[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.
 
@@ -160,7 +160,7 @@ feeDenom: the denomination of the fee to be paid for transactions.
 
 #### Defined in
 
-[chain/chain.ts:62](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/chain/chain.ts#L62)
+[chain/chain.ts:62](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L62)
 
 ## Methods
 
@@ -174,18 +174,18 @@ feeDenom: the denomination of the fee to be paid for transactions.
 
 #### Defined in
 
-[chain/chain.ts:90](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/chain/chain.ts#L90)
+[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
@@ -194,4 +194,4 @@ feeDenom: the denomination of the fee to be paid for transactions.
 
 #### Defined in
 
-[chain/chain.ts:80](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/chain/chain.ts#L80)
+[chain/chain.ts:80](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L80)
diff --git a/packages/nibijs/docs/classes/MsgFactory.md b/packages/nibijs/docs/classes/MsgFactory.md
@@ -27,14 +27,14 @@
 
 #### Defined in
 
-[msg/index.ts:6](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/msg/index.ts#L6)
+[msg/index.ts:6](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/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/6e650cb/packages/nibijs/src/msg/index.ts#L5)
+[msg/index.ts:5](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/msg/index.ts#L5)
diff --git a/packages/nibijs/docs/classes/NibiruQuerier.md b/packages/nibijs/docs/classes/NibiruQuerier.md
@@ -46,19 +46,19 @@ 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
 
 StargateClient.constructor
 
 #### Defined in
 
-[query/query.ts:66](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/query/query.ts#L66)
+[query/query.ts:66](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/query/query.ts#L66)
 
 ## Properties
 
@@ -68,27 +68,27 @@ StargateClient.constructor
 
 #### Defined in
 
-[query/query.ts:53](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/query/query.ts#L53)
+[query/query.ts:53](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/query/query.ts#L53)
 
----
+___
 
 ### tm
 
 • `Readonly` **tm**: `Tendermint37Client`
 
 #### Defined in
 
-[query/query.ts:55](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/query/query.ts#L55)
+[query/query.ts:55](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/query/query.ts#L55)
 
----
+___
 
 ### wasmClient
 
 • `Readonly` **wasmClient**: `CosmWasmClient`
 
 #### Defined in
 
-[query/query.ts:54](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/query/query.ts#L54)
+[query/query.ts:54](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/query/query.ts#L54)
 
 ## Methods
 
@@ -100,16 +100,15 @@ 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
@@ -119,16 +118,15 @@ 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/6e650cb/packages/nibijs/src/query/query.ts#L122)
+[query/query.ts:122](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/query/query.ts#L122)
 
----
+___
 
 ### getTxByHashBytes
 
@@ -139,8 +137,8 @@ A tx hash uniquely identifies a tx on the blockchain.
 
 #### Parameters
 
-| Name     | Type         |
-| :------- | :----------- |
+| Name | Type |
+| :------ | :------ |
 | `txHash` | `Uint8Array` |
 
 #### Returns
@@ -153,18 +151,18 @@ getTxByHash - Equivalent query using the hex-encoded tx hash string.
 
 #### Defined in
 
-[query/query.ts:136](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/query/query.ts#L136)
+[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
@@ -173,9 +171,9 @@ getTxByHash - Equivalent query using the hex-encoded tx hash string.
 
 #### Defined in
 
-[query/query.ts:92](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/query/query.ts#L92)
+[query/query.ts:92](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/query/query.ts#L92)
 
----
+___
 
 ### waitForNextBlock
 
@@ -187,20 +185,20 @@ getTxByHash - Equivalent query using the hex-encoded tx hash string.
 
 #### Defined in
 
-[query/query.ts:100](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/query/query.ts#L100)
+[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
 
@@ -212,4 +210,4 @@ StargateClient.connect
 
 #### Defined in
 
-[query/query.ts:57](https://github.com/NibiruChain/ts-sdk/blob/6e650cb/packages/nibijs/src/query/query.ts#L57)
+[query/query.ts:57](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/query/query.ts#L57)