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

feat(nibijs): functions for humans + getTxByHash (exchange integration) #260

Merged
merged 16 commits into from
Dec 12, 2023
Merged

feat(nibijs): functions for humans + getTxByHash (exchange integration) #260

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
b21d7ab
fix(nibijs): NibiruQueryClient must expose methods from the Tendermin…
Unique-Divine Dec 8, 2023
a7389e3
Merge remote-tracking branch 'origin/develop' into realu/dev
Unique-Divine Dec 9, 2023
2993dce
feat(nibijs): functions for humans + getTxByHash
Unique-Divine Dec 10, 2023
d5c3edc
chore(nibijs): build docs
Unique-Divine Dec 10, 2023
c5e1ad7
test(nibijs): fix import
Unique-Divine Dec 10, 2023
77efda7
refactor(nibijs): remove unused fn, 'go', and use Result instead
Unique-Divine Dec 11, 2023
5de3dba
docs(nibijs-result): function docs
Unique-Divine Dec 11, 2023
d3d65d9
test: fix by removing usage of go in test
Unique-Divine Dec 11, 2023
5d0d89b
test: fix inactive chaint est
Unique-Divine Dec 11, 2023
5b7d4fb
test: fix inactive chaint est
Unique-Divine Dec 11, 2023
c08edb6
test: address PR comments
Unique-Divine Dec 11, 2023
0957ec2
chore(nibijs): rebuild docs
Unique-Divine Dec 11, 2023
821a76d
Update packages/nibijs/src/result.ts
Unique-Divine Dec 11, 2023
f607ea4
Merge branch 'realu/dev' of github.com:NibiruChain/ts-sdk into realu/dev
Unique-Divine Dec 11, 2023
9684001
Merge remote-tracking branch 'origin/develop' into realu/dev
Unique-Divine Dec 12, 2023
b566159
fix: initChainId couldn't handle number == 0 case
Unique-Divine Dec 12, 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
20 changes: 10 additions & 10 deletions packages/nibijs/docs/classes/CustomChain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export const TEST_CHAIN = new CustomChain({

#### Defined in

[chain/chain.ts:56](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/chain/chain.ts#L56)
[chain/chain.ts:56](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/chain/chain.ts#L56)

## Properties

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

#### Defined in

[chain/chain.ts:47](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/chain/chain.ts#L47)
[chain/chain.ts:47](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/chain/chain.ts#L47)

---

Expand All @@ -80,7 +80,7 @@ chainId: identifier for the chain

#### Defined in

[chain/chain.ts:54](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/chain/chain.ts#L54)
[chain/chain.ts:54](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/chain/chain.ts#L54)

---

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

#### Defined in

[chain/chain.ts:48](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/chain/chain.ts#L48)
[chain/chain.ts:48](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/chain/chain.ts#L48)

---

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

#### Defined in

[chain/chain.ts:51](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/chain/chain.ts#L51)
[chain/chain.ts:51](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/chain/chain.ts#L51)

---

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

#### Defined in

[chain/chain.ts:50](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/chain/chain.ts#L50)
[chain/chain.ts:50](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/chain/chain.ts#L50)

---

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

#### Defined in

[chain/chain.ts:49](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/chain/chain.ts#L49)
[chain/chain.ts:49](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/chain/chain.ts#L49)

---

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

#### Defined in

[chain/chain.ts:52](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/chain/chain.ts#L52)
[chain/chain.ts:52](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/chain/chain.ts#L52)

## Methods

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

#### Defined in

[chain/chain.ts:75](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/chain/chain.ts#L75)
[chain/chain.ts:75](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/chain/chain.ts#L75)

---

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

#### Defined in

[chain/chain.ts:65](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/chain/chain.ts#L65)
[chain/chain.ts:65](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/chain/chain.ts#L65)
4 changes: 2 additions & 2 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,7 +27,7 @@

#### Defined in

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

---

Expand All @@ -37,4 +37,4 @@

#### Defined in

[msg/index.ts:5](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/msg/index.ts#L5)
[msg/index.ts:5](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/msg/index.ts#L5)
81 changes: 74 additions & 7 deletions packages/nibijs/docs/classes/NibiruQueryClient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ const querier = await NibiruQueryClient.connect(chain.endptTm)

### Methods

- [getTxByHash](NibiruQueryClient.md#gettxbyhash)
- [getTxByHashBytes](NibiruQueryClient.md#gettxbyhashbytes)
- [waitForHeight](NibiruQueryClient.md#waitforheight)
- [waitForNextBlock](NibiruQueryClient.md#waitfornextblock)
- [connect](NibiruQueryClient.md#connect)
Expand All @@ -56,7 +58,7 @@ StargateClient.constructor

#### Defined in

[query/query.ts:63](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/query/query.ts#L63)
[query/query.ts:66](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/query/query.ts#L66)

## Properties

Expand All @@ -66,7 +68,7 @@ StargateClient.constructor

#### Defined in

[query/query.ts:50](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/query/query.ts#L50)
[query/query.ts:53](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/query/query.ts#L53)

---

Expand All @@ -76,7 +78,7 @@ StargateClient.constructor

#### Defined in

[query/query.ts:52](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/query/query.ts#L52)
[query/query.ts:55](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/query/query.ts#L55)

---

Expand All @@ -86,10 +88,75 @@ StargateClient.constructor

#### Defined in

[query/query.ts:51](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/query/query.ts#L51)
[query/query.ts:54](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/query/query.ts#L54)

## Methods

### getTxByHash

▸ **getTxByHash**(`txHashHex`): `Promise`<[`Result`](Result.md)<`TxResponse`\>\>

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 |
| :---------- | :------- |
| `txHashHex` | `string` |

#### Returns

`Promise`<[`Result`](Result.md)<`TxResponse`\>\>

**`Example`**

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

#### Defined in

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

---

### getTxByHashBytes

▸ **getTxByHashBytes**(`txHash`): `Promise`<[`Result`](Result.md)<`TxResponse`\>\>

getTxByHashBytes: Query a transaction (tx) using its SHA-256 tx hash (bytes).
A tx hash uniquely identifies a tx on the blockchain.

#### Parameters

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

#### Returns

`Promise`<[`Result`](Result.md)<`TxResponse`\>\>

**`See`**

getTxByHash - Equivalent query using the hex-encoded tx hash string.

#### Defined in

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

---

### waitForHeight

▸ **waitForHeight**(`height`): `Promise`<`void`\>
Expand All @@ -106,7 +173,7 @@ StargateClient.constructor

#### Defined in

[query/query.ts:89](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/query/query.ts#L89)
[query/query.ts:92](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/query/query.ts#L92)

---

Expand All @@ -120,7 +187,7 @@ StargateClient.constructor

#### Defined in

[query/query.ts:97](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/query/query.ts#L97)
[query/query.ts:100](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/query/query.ts#L100)

---

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

#### Defined in

[query/query.ts:54](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/query/query.ts#L54)
[query/query.ts:57](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/query/query.ts#L57)
12 changes: 6 additions & 6 deletions packages/nibijs/docs/classes/NibiruSigningClient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ SigningStargateClient.constructor

#### Defined in

[tx/signingClient.ts:41](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/tx/signingClient.ts#L41)
[tx/signingClient.ts:41](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/tx/signingClient.ts#L41)

## Properties

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

#### Defined in

[tx/signingClient.ts:38](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/tx/signingClient.ts#L38)
[tx/signingClient.ts:38](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/tx/signingClient.ts#L38)

---

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

#### Defined in

[tx/signingClient.ts:39](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/tx/signingClient.ts#L39)
[tx/signingClient.ts:39](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/tx/signingClient.ts#L39)

## Methods

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

#### Defined in

[tx/signingClient.ts:94](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/tx/signingClient.ts#L94)
[tx/signingClient.ts:94](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/tx/signingClient.ts#L94)

---

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

#### Defined in

[tx/signingClient.ts:102](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/tx/signingClient.ts#L102)
[tx/signingClient.ts:102](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/tx/signingClient.ts#L102)

---

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

#### Defined in

[tx/signingClient.ts:66](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/tx/signingClient.ts#L66)
[tx/signingClient.ts:66](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/tx/signingClient.ts#L66)
14 changes: 7 additions & 7 deletions packages/nibijs/docs/classes/PerpMsgFactory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Returns a 'TxMessage' for adding margin to a position

#### Defined in

[msg/perp.ts:124](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/msg/perp.ts#L124)
[msg/perp.ts:124](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/msg/perp.ts#L124)

---

Expand All @@ -75,7 +75,7 @@ Returns a 'TxMessage' for adding margin to a position

#### Defined in

[msg/perp.ts:161](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/msg/perp.ts#L161)
[msg/perp.ts:161](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/msg/perp.ts#L161)

---

Expand All @@ -95,7 +95,7 @@ Returns a 'TxMessage' for adding margin to a position

#### Defined in

[msg/perp.ts:175](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/msg/perp.ts#L175)
[msg/perp.ts:175](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/msg/perp.ts#L175)

---

Expand All @@ -115,7 +115,7 @@ Returns a 'TxMessage' for adding margin to a position

#### Defined in

[msg/perp.ts:131](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/msg/perp.ts#L131)
[msg/perp.ts:131](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/msg/perp.ts#L131)

---

Expand All @@ -141,7 +141,7 @@ Returns a 'TxMessage' for adding margin to a position

#### Defined in

[msg/perp.ts:138](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/msg/perp.ts#L138)
[msg/perp.ts:138](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/msg/perp.ts#L138)

---

Expand All @@ -161,7 +161,7 @@ Returns a 'TxMessage' for adding margin to a position

#### Defined in

[msg/perp.ts:168](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/msg/perp.ts#L168)
[msg/perp.ts:168](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/msg/perp.ts#L168)

---

Expand All @@ -181,4 +181,4 @@ Returns a 'TxMessage' for adding margin to a position

#### Defined in

[msg/perp.ts:110](https://github.com/NibiruChain/ts-sdk/blob/d2a4311/packages/nibijs/src/msg/perp.ts#L110)
[msg/perp.ts:110](https://github.com/NibiruChain/ts-sdk/blob/2993dce/packages/nibijs/src/msg/perp.ts#L110)
Loading
Loading