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

feat(nibijs): mainnet custom chain function #268

Merged
merged 7 commits into from
Dec 14, 2023
Merged

feat(nibijs): mainnet custom chain function #268

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cacf9b9
feat(nibijs): mainnet custom chain function
Unique-Divine Dec 13, 2023
e4d449a
PR comments
Unique-Divine Dec 13, 2023
3e8da88
coderabbit: Update packages/nibijs/docs/modules.md
Unique-Divine Dec 13, 2023
115d25a
refactor: adding hm & ws to custom chain (#269)
CalicoNino Dec 13, 2023
6e70207
test: faucet fix
CalicoNino Dec 13, 2023
233e9a4
test: empty chain in faucet test
CalicoNino Dec 13, 2023
72b58dd
refactor: endpt hm & ws typo
CalicoNino Dec 13, 2023
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
2 changes: 1 addition & 1 deletion packages/examples/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
48 changes: 24 additions & 24 deletions packages/nibijs/docs/classes/CustomChain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ based on its chain ID.
**`Example`**

```ts
export const TEST_CHAIN = new CustomChain({
export const chain = new CustomChain({
prefix: "nibiru",
shortName: "testnet",
number: 1,
}) // v0.19.2
})
```

## Implements
Expand Down 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/23db897/packages/nibijs/src/chain/chain.ts#L57)
[chain/chain.ts:66](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L66)

## 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/23db897/packages/nibijs/src/chain/chain.ts#L48)
[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:55](https://github.com/NibiruChain/ts-sdk/blob/23db897/packages/nibijs/src/chain/chain.ts#L55)
[chain/chain.ts:64](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L64)

---
___

### 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/23db897/packages/nibijs/src/chain/chain.ts#L49)
[chain/chain.ts:58](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L58)

---
___

### 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/23db897/packages/nibijs/src/chain/chain.ts#L52)
[chain/chain.ts:61](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L61)

---
___

### 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/23db897/packages/nibijs/src/chain/chain.ts#L51)
[chain/chain.ts:60](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L60)

---
___

### 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/23db897/packages/nibijs/src/chain/chain.ts#L50)
[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 @@ -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/23db897/packages/nibijs/src/chain/chain.ts#L53)
[chain/chain.ts:62](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L62)

## Methods

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

#### Defined in

[chain/chain.ts:81](https://github.com/NibiruChain/ts-sdk/blob/23db897/packages/nibijs/src/chain/chain.ts#L81)
[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 All @@ -194,4 +194,4 @@ feeDenom: the denomination of the fee to be paid for transactions.

#### Defined in

[chain/chain.ts:71](https://github.com/NibiruChain/ts-sdk/blob/23db897/packages/nibijs/src/chain/chain.ts#L71)
[chain/chain.ts:80](https://github.com/NibiruChain/ts-sdk/blob/cacf9b9/packages/nibijs/src/chain/chain.ts#L80)
6 changes: 3 additions & 3 deletions packages/nibijs/docs/classes/MsgFactory.md
View file
Open in desktop
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/23db897/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/23db897/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)
64 changes: 31 additions & 33 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,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/23db897/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

Expand All @@ -68,27 +68,27 @@ StargateClient.constructor

#### Defined in

[query/query.ts:53](https://github.com/NibiruChain/ts-sdk/blob/23db897/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/23db897/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/23db897/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

Expand All @@ -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
Expand All @@ -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/23db897/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

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

#### Parameters

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

#### Returns
Expand All @@ -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/23db897/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
Expand All @@ -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/23db897/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

Expand All @@ -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/23db897/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

Expand All @@ -212,4 +210,4 @@ StargateClient.connect

#### Defined in

[query/query.ts:57](https://github.com/NibiruChain/ts-sdk/blob/23db897/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)
Loading