diff --git a/package.json b/package.json index 8c71b037..37929dbf 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@nibiruchain/ts-sdk", - "version": "0.2.0", + "version": "0.19.0", "license": "MIT", "private": "true", "workspaces": { diff --git a/packages/indexer-nibi/CHANGELOG.md b/packages/indexer-nibi/CHANGELOG.md index c8042ed7..ee67ced4 100644 --- a/packages/indexer-nibi/CHANGELOG.md +++ b/packages/indexer-nibi/CHANGELOG.md @@ -7,6 +7,10 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline - . +## v0.19.15 + +- Match version and fix publish script + ## v0.19.14 - Match version diff --git a/packages/indexer-nibi/package.json b/packages/indexer-nibi/package.json index 204e79bc..84a622f8 100644 --- a/packages/indexer-nibi/package.json +++ b/packages/indexer-nibi/package.json @@ -1,7 +1,7 @@ { "name": "@nibiruchain/indexer-nibi", "description": "GraphQL API client for the Nibiru Chain indexer (heart-monitor)", - "version": "0.19.14", + "version": "0.19.15", "license": "MIT", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/packages/nibijs/CHANGELOG.md b/packages/nibijs/CHANGELOG.md index ce436d4b..02d43d2a 100644 --- a/packages/nibijs/CHANGELOG.md +++ b/packages/nibijs/CHANGELOG.md @@ -7,6 +7,10 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline - . +## v0.19.15 + +- Match version and fix publish script + ## v0.19.14 - feat: StableSwap diff --git a/packages/nibijs/docs/classes/CustomChain.md b/packages/nibijs/docs/classes/CustomChain.md index db147e8d..45e5a546 100644 --- a/packages/nibijs/docs/classes/CustomChain.md +++ b/packages/nibijs/docs/classes/CustomChain.md @@ -1,4 +1,4 @@ -[NibiJS Documentation - v0.19.14](../intro.md) / [Exports](../modules.md) / CustomChain +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / CustomChain # Class: CustomChain @@ -50,13 +50,13 @@ export const TEST_CHAIN = new CustomChain({ #### Parameters -| Name | Type | -| :------------- | :---------------------------------------------- | +| Name | Type | +| :------ | :------ | | `chainIdParts` | [`ChainIdParts`](../interfaces/ChainIdParts.md) | #### Defined in -[chain/chain.ts:67](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L67) +[chain/chain.ts:67](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L67) ## Properties @@ -72,9 +72,9 @@ chainId: identifier for the chain #### Defined in -[chain/chain.ts:58](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L58) +[chain/chain.ts:58](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L58) ---- +___ ### chainIdParts @@ -82,9 +82,9 @@ chainId: identifier for the chain #### Defined in -[chain/chain.ts:65](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L65) +[chain/chain.ts:65](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L65) ---- +___ ### chainName @@ -98,9 +98,9 @@ chainName: the name of the chain to display to the user #### Defined in -[chain/chain.ts:59](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L59) +[chain/chain.ts:59](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L59) ---- +___ ### endptGrpc @@ -114,9 +114,9 @@ endptGrpc: endpoint for the gRPC gateway. Usually on port 9090. #### Defined in -[chain/chain.ts:62](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L62) +[chain/chain.ts:62](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L62) ---- +___ ### endptRest @@ -130,9 +130,9 @@ endptRest: endpoint for the REST server. Also, the LCD endpoint. #### Defined in -[chain/chain.ts:61](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L61) +[chain/chain.ts:61](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L61) ---- +___ ### endptTm @@ -146,9 +146,9 @@ endptTm: endpoint for the Tendermint RPC server. Usually on port 26657. #### Defined in -[chain/chain.ts:60](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L60) +[chain/chain.ts:60](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L60) ---- +___ ### feeDenom @@ -162,7 +162,7 @@ feeDenom: the denomination of the fee to be paid for transactions. #### Defined in -[chain/chain.ts:63](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L63) +[chain/chain.ts:63](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L63) ## Methods @@ -176,9 +176,9 @@ feeDenom: the denomination of the fee to be paid for transactions. #### Defined in -[chain/chain.ts:77](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L77) +[chain/chain.ts:77](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L77) ---- +___ ### initGrpcEndpoint @@ -190,9 +190,9 @@ feeDenom: the denomination of the fee to be paid for transactions. #### Defined in -[chain/chain.ts:92](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L92) +[chain/chain.ts:92](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L92) ---- +___ ### initRestEndpoint @@ -204,9 +204,9 @@ feeDenom: the denomination of the fee to be paid for transactions. #### Defined in -[chain/chain.ts:87](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L87) +[chain/chain.ts:87](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L87) ---- +___ ### initTendermintEndpoint @@ -218,4 +218,4 @@ feeDenom: the denomination of the fee to be paid for transactions. #### Defined in -[chain/chain.ts:82](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L82) +[chain/chain.ts:82](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L82) diff --git a/packages/nibijs/docs/classes/MsgFactory.md b/packages/nibijs/docs/classes/MsgFactory.md new file mode 100644 index 00000000..4d7828b6 --- /dev/null +++ b/packages/nibijs/docs/classes/MsgFactory.md @@ -0,0 +1,40 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / MsgFactory + +# Class: MsgFactory + +## Table of contents + +### Constructors + +- [constructor](MsgFactory.md#constructor) + +### Properties + +- [perp](MsgFactory.md#perp) +- [spot](MsgFactory.md#spot) + +## Constructors + +### constructor + +• **new MsgFactory**() + +## Properties + +### perp + +• **perp**: typeof [`PerpMsgFactory`](PerpMsgFactory.md) = `PerpMsgFactory` + +#### Defined in + +[msg/index.ts:7](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/index.ts#L7) + +___ + +### spot + +• **spot**: typeof [`SpotMsgFactory`](SpotMsgFactory.md) = `SpotMsgFactory` + +#### Defined in + +[msg/index.ts:5](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/index.ts#L5) diff --git a/packages/nibijs/docs/classes/NibiruQueryClient.md b/packages/nibijs/docs/classes/NibiruQueryClient.md index dca90875..3c9e27b8 100644 --- a/packages/nibijs/docs/classes/NibiruQueryClient.md +++ b/packages/nibijs/docs/classes/NibiruQueryClient.md @@ -1,4 +1,4 @@ -[NibiJS Documentation - v0.19.14](../intro.md) / [Exports](../modules.md) / NibiruQueryClient +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / NibiruQueryClient # Class: NibiruQueryClient @@ -33,11 +33,11 @@ #### Parameters -| Name | Type | -| :----------- | :---------------------- | -| `tmClient` | `Tendermint34Client` | -| `options` | `StargateClientOptions` | -| `wasmClient` | `CosmWasmClient` | +| Name | Type | +| :------ | :------ | +| `tmClient` | `Tendermint34Client` | +| `options` | `StargateClientOptions` | +| `wasmClient` | `CosmWasmClient` | #### Overrides @@ -45,7 +45,7 @@ StargateClient.constructor #### Defined in -[query/query.ts:56](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/query/query.ts#L56) +[query/query.ts:56](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/query/query.ts#L56) ## Properties @@ -55,9 +55,9 @@ StargateClient.constructor #### Defined in -[query/query.ts:44](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/query/query.ts#L44) +[query/query.ts:44](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/query/query.ts#L44) ---- +___ ### wasmClient @@ -65,7 +65,7 @@ StargateClient.constructor #### Defined in -[query/query.ts:45](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/query/query.ts#L45) +[query/query.ts:45](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/query/query.ts#L45) ## Methods @@ -75,8 +75,8 @@ StargateClient.constructor #### Parameters -| Name | Type | -| :------- | :------- | +| Name | Type | +| :------ | :------ | | `height` | `number` | #### Returns @@ -85,9 +85,9 @@ StargateClient.constructor #### Defined in -[query/query.ts:80](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/query/query.ts#L80) +[query/query.ts:80](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/query/query.ts#L80) ---- +___ ### waitForNextBlock @@ -99,9 +99,9 @@ StargateClient.constructor #### Defined in -[query/query.ts:88](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/query/query.ts#L88) +[query/query.ts:88](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/query/query.ts#L88) ---- +___ ### connect @@ -109,10 +109,10 @@ StargateClient.constructor #### Parameters -| Name | Type | -| :--------- | :---------------------- | -| `endpoint` | `string` | -| `options` | `StargateClientOptions` | +| Name | Type | +| :------ | :------ | +| `endpoint` | `string` | +| `options` | `StargateClientOptions` | #### Returns @@ -124,4 +124,4 @@ StargateClient.connect #### Defined in -[query/query.ts:47](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/query/query.ts#L47) +[query/query.ts:47](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/query/query.ts#L47) diff --git a/packages/nibijs/docs/classes/NibiruSigningClient.md b/packages/nibijs/docs/classes/NibiruSigningClient.md index 9c7fc580..09fd36b5 100644 --- a/packages/nibijs/docs/classes/NibiruSigningClient.md +++ b/packages/nibijs/docs/classes/NibiruSigningClient.md @@ -1,4 +1,4 @@ -[NibiJS Documentation - v0.19.14](../intro.md) / [Exports](../modules.md) / NibiruSigningClient +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / NibiruSigningClient # Class: NibiruSigningClient @@ -33,12 +33,12 @@ #### Parameters -| Name | Type | -| :--------- | :----------------------------- | -| `tmClient` | `Tendermint34Client` | -| `signer` | `OfflineSigner` | -| `options` | `SigningStargateClientOptions` | -| `wasm` | `SigningCosmWasmClient` | +| Name | Type | +| :------ | :------ | +| `tmClient` | `Tendermint34Client` | +| `signer` | `OfflineSigner` | +| `options` | `SigningStargateClientOptions` | +| `wasm` | `SigningCosmWasmClient` | #### Overrides @@ -46,7 +46,7 @@ SigningStargateClient.constructor #### Defined in -[tx/signingClient.ts:64](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signingClient.ts#L64) +[tx/signingClient.ts:64](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signingClient.ts#L64) ## Properties @@ -56,9 +56,9 @@ SigningStargateClient.constructor #### Defined in -[tx/signingClient.ts:37](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signingClient.ts#L37) +[tx/signingClient.ts:37](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signingClient.ts#L37) ---- +___ ### wasmClient @@ -66,7 +66,7 @@ SigningStargateClient.constructor #### Defined in -[tx/signingClient.ts:38](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signingClient.ts#L38) +[tx/signingClient.ts:38](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signingClient.ts#L38) ## Methods @@ -76,8 +76,8 @@ SigningStargateClient.constructor #### Parameters -| Name | Type | -| :------- | :------- | +| Name | Type | +| :------ | :------ | | `height` | `number` | #### Returns @@ -86,9 +86,9 @@ SigningStargateClient.constructor #### Defined in -[tx/signingClient.ts:89](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signingClient.ts#L89) +[tx/signingClient.ts:89](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signingClient.ts#L89) ---- +___ ### waitForNextBlock @@ -100,9 +100,9 @@ SigningStargateClient.constructor #### Defined in -[tx/signingClient.ts:97](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signingClient.ts#L97) +[tx/signingClient.ts:97](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signingClient.ts#L97) ---- +___ ### connectWithSigner @@ -110,11 +110,11 @@ SigningStargateClient.constructor #### Parameters -| Name | Type | -| :------------ | :----------------------------- | -| `endpoint` | `string` | -| `signer` | `OfflineSigner` | -| `options` | `SigningStargateClientOptions` | +| Name | Type | +| :------ | :------ | +| `endpoint` | `string` | +| `signer` | `OfflineSigner` | +| `options` | `SigningStargateClientOptions` | | `wasmOptions` | `SigningCosmWasmClientOptions` | #### Returns @@ -127,4 +127,4 @@ SigningStargateClient.connectWithSigner #### Defined in -[tx/signingClient.ts:40](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signingClient.ts#L40) +[tx/signingClient.ts:40](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signingClient.ts#L40) diff --git a/packages/nibijs/docs/classes/PerpMsgFactory.md b/packages/nibijs/docs/classes/PerpMsgFactory.md new file mode 100644 index 00000000..a931d609 --- /dev/null +++ b/packages/nibijs/docs/classes/PerpMsgFactory.md @@ -0,0 +1,156 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / PerpMsgFactory + +# Class: PerpMsgFactory + +## Table of contents + +### Constructors + +- [constructor](PerpMsgFactory.md#constructor) + +### Methods + +- [addMargin](PerpMsgFactory.md#addmargin) +- [closePosition](PerpMsgFactory.md#closeposition) +- [donateToPerpEF](PerpMsgFactory.md#donatetoperpef) +- [liquidate](PerpMsgFactory.md#liquidate) +- [openPosition](PerpMsgFactory.md#openposition) +- [removeMargin](PerpMsgFactory.md#removemargin) + +## Constructors + +### constructor + +• **new PerpMsgFactory**() + +## Methods + +### addMargin + +▸ `Static` **addMargin**(`msg`): [`TxMessage`](../interfaces/TxMessage.md) + +Returns a 'TxMessage' for adding margin to a position + +**`Static`** + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `msg` | `MsgAddMargin` | Message to add margin | + +#### Returns + +[`TxMessage`](../interfaces/TxMessage.md) + +- formatted version of MsgAddMargin + +#### Defined in + +[msg/perp.ts:134](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L134) + +___ + +### closePosition + +▸ `Static` **closePosition**(`msg`): [`TxMessage`](../interfaces/TxMessage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `MsgClosePosition` | + +#### Returns + +[`TxMessage`](../interfaces/TxMessage.md) + +#### Defined in + +[msg/perp.ts:171](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L171) + +___ + +### donateToPerpEF + +▸ `Static` **donateToPerpEF**(`msg`): [`TxMessage`](../interfaces/TxMessage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `MsgDonateToEcosystemFund` | + +#### Returns + +[`TxMessage`](../interfaces/TxMessage.md) + +#### Defined in + +[msg/perp.ts:178](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L178) + +___ + +### liquidate + +▸ `Static` **liquidate**(`msg`): [`TxMessage`](../interfaces/TxMessage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `MsgMultiLiquidate` | + +#### Returns + +[`TxMessage`](../interfaces/TxMessage.md) + +#### Defined in + +[msg/perp.ts:141](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L141) + +___ + +### openPosition + +▸ `Static` **openPosition**(`msg`): [`TxMessage`](../interfaces/TxMessage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `Object` | +| `msg.baseAssetAmountLimit?` | `number` | +| `msg.goLong` | `boolean` | +| `msg.leverage` | `number` | +| `msg.pair` | `string` | +| `msg.quoteAssetAmount` | `number` | +| `msg.sender` | `string` | + +#### Returns + +[`TxMessage`](../interfaces/TxMessage.md) + +#### Defined in + +[msg/perp.ts:148](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L148) + +___ + +### removeMargin + +▸ `Static` **removeMargin**(`msg`): [`TxMessage`](../interfaces/TxMessage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `MsgRemoveMargin` | + +#### Returns + +[`TxMessage`](../interfaces/TxMessage.md) + +#### Defined in + +[msg/perp.ts:120](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L120) diff --git a/packages/nibijs/docs/classes/SpotMsgFactory.md b/packages/nibijs/docs/classes/SpotMsgFactory.md new file mode 100644 index 00000000..201bae8d --- /dev/null +++ b/packages/nibijs/docs/classes/SpotMsgFactory.md @@ -0,0 +1,102 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / SpotMsgFactory + +# Class: SpotMsgFactory + +## Table of contents + +### Constructors + +- [constructor](SpotMsgFactory.md#constructor) + +### Methods + +- [createPool](SpotMsgFactory.md#createpool) +- [exitPool](SpotMsgFactory.md#exitpool) +- [joinPool](SpotMsgFactory.md#joinpool) +- [swapAssets](SpotMsgFactory.md#swapassets) + +## Constructors + +### constructor + +• **new SpotMsgFactory**() + +## Methods + +### createPool + +▸ `Static` **createPool**(`msg`): [`TxMessage`](../interfaces/TxMessage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `MsgCreatePool` | + +#### Returns + +[`TxMessage`](../interfaces/TxMessage.md) + +#### Defined in + +[msg/spot.ts:73](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L73) + +___ + +### exitPool + +▸ `Static` **exitPool**(`msg`): [`TxMessage`](../interfaces/TxMessage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `MsgExitPool` | + +#### Returns + +[`TxMessage`](../interfaces/TxMessage.md) + +#### Defined in + +[msg/spot.ts:93](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L93) + +___ + +### joinPool + +▸ `Static` **joinPool**(`msg`): [`TxMessage`](../interfaces/TxMessage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `MsgJoinPool` | + +#### Returns + +[`TxMessage`](../interfaces/TxMessage.md) + +#### Defined in + +[msg/spot.ts:86](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L86) + +___ + +### swapAssets + +▸ `Static` **swapAssets**(`msg`): [`TxMessage`](../interfaces/TxMessage.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `msg` | `MsgSwapAssets` | + +#### Returns + +[`TxMessage`](../interfaces/TxMessage.md) + +#### Defined in + +[msg/spot.ts:100](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L100) diff --git a/packages/nibijs/docs/enums/BECH32_PREFIX.md b/packages/nibijs/docs/enums/BECH32_PREFIX.md index 055b5396..3e3ebe22 100644 --- a/packages/nibijs/docs/enums/BECH32_PREFIX.md +++ b/packages/nibijs/docs/enums/BECH32_PREFIX.md @@ -1,86 +1,86 @@ -[NibiJS Documentation - v0.19.14](../intro.md) / [Exports](../modules.md) / BECH32_PREFIX +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / BECH32\_PREFIX -# Enumeration: BECH32_PREFIX +# Enumeration: BECH32\_PREFIX ## Table of contents ### Enumeration Members - [ADDR](BECH32_PREFIX.md#addr) -- [ADDR_VAL](BECH32_PREFIX.md#addr_val) -- [ADDR_VALCONS](BECH32_PREFIX.md#addr_valcons) +- [ADDR\_VAL](BECH32_PREFIX.md#addr_val) +- [ADDR\_VALCONS](BECH32_PREFIX.md#addr_valcons) - [PUB](BECH32_PREFIX.md#pub) -- [PUB_VAL](BECH32_PREFIX.md#pub_val) -- [PUB_VALCONS](BECH32_PREFIX.md#pub_valcons) +- [PUB\_VAL](BECH32_PREFIX.md#pub_val) +- [PUB\_VALCONS](BECH32_PREFIX.md#pub_valcons) ## Enumeration Members ### ADDR -• **ADDR** = `"nibi"` +• **ADDR** = ``"nibi"`` ADDR defines the Bech32 prefix of an account address #### Defined in -[tx/signer.ts:12](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signer.ts#L12) +[tx/signer.ts:12](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signer.ts#L12) ---- +___ -### ADDR_VAL +### ADDR\_VAL -• **ADDR_VAL** = `"nibivaloper"` +• **ADDR\_VAL** = ``"nibivaloper"`` ADDR_VAL defines the Bech32 prefix of an validator's operator address #### Defined in -[tx/signer.ts:14](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signer.ts#L14) +[tx/signer.ts:14](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signer.ts#L14) ---- +___ -### ADDR_VALCONS +### ADDR\_VALCONS -• **ADDR_VALCONS** = `"nibivalcons"` +• **ADDR\_VALCONS** = ``"nibivalcons"`` ADDR_VALCONS defines the Bech32 prefix of a consensus node address #### Defined in -[tx/signer.ts:16](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signer.ts#L16) +[tx/signer.ts:16](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signer.ts#L16) ---- +___ ### PUB -• **PUB** = `"nibipub"` +• **PUB** = ``"nibipub"`` PUB defines the Bech32 prefix of an account's public key #### Defined in -[tx/signer.ts:18](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signer.ts#L18) +[tx/signer.ts:18](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signer.ts#L18) ---- +___ -### PUB_VAL +### PUB\_VAL -• **PUB_VAL** = `"nibivaloperpub"` +• **PUB\_VAL** = ``"nibivaloperpub"`` PUB_VAL defines the Bech32 prefix of an validator's operator public key #### Defined in -[tx/signer.ts:20](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signer.ts#L20) +[tx/signer.ts:20](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signer.ts#L20) ---- +___ -### PUB_VALCONS +### PUB\_VALCONS -• **PUB_VALCONS** = `"nibivalconspub"` +• **PUB\_VALCONS** = ``"nibivalconspub"`` PUB_VALCONS defines the Bech32 prefix of a consensus node public key #### Defined in -[tx/signer.ts:22](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signer.ts#L22) +[tx/signer.ts:22](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signer.ts#L22) diff --git a/packages/nibijs/docs/enums/Signer.md b/packages/nibijs/docs/enums/Signer.md index d1ba880b..64d1b589 100644 --- a/packages/nibijs/docs/enums/Signer.md +++ b/packages/nibijs/docs/enums/Signer.md @@ -1,4 +1,4 @@ -[NibiJS Documentation - v0.19.14](../intro.md) / [Exports](../modules.md) / Signer +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / Signer # Enumeration: Signer @@ -13,18 +13,18 @@ ### Direct -• **Direct** = `"direct"` +• **Direct** = ``"direct"`` #### Defined in -[tx/signer.ts:71](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signer.ts#L71) +[tx/signer.ts:71](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signer.ts#L71) ---- +___ ### Keplr -• **Keplr** = `"keplr"` +• **Keplr** = ``"keplr"`` #### Defined in -[tx/signer.ts:70](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signer.ts#L70) +[tx/signer.ts:70](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signer.ts#L70) diff --git a/packages/nibijs/docs/interfaces/Attribute.md b/packages/nibijs/docs/interfaces/Attribute.md index 2f78a3d7..12d440f1 100644 --- a/packages/nibijs/docs/interfaces/Attribute.md +++ b/packages/nibijs/docs/interfaces/Attribute.md @@ -1,4 +1,4 @@ -[NibiJS Documentation - v0.19.14](../intro.md) / [Exports](../modules.md) / Attribute +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / Attribute # Interface: Attribute @@ -17,9 +17,9 @@ #### Defined in -[chain/types.ts:53](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/types.ts#L53) +[chain/types.ts:53](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/types.ts#L53) ---- +___ ### value @@ -27,4 +27,4 @@ #### Defined in -[chain/types.ts:54](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/types.ts#L54) +[chain/types.ts:54](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/types.ts#L54) diff --git a/packages/nibijs/docs/interfaces/Chain.md b/packages/nibijs/docs/interfaces/Chain.md index c5c124b5..15b3594e 100644 --- a/packages/nibijs/docs/interfaces/Chain.md +++ b/packages/nibijs/docs/interfaces/Chain.md @@ -1,4 +1,4 @@ -[NibiJS Documentation - v0.19.14](../intro.md) / [Exports](../modules.md) / Chain +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / Chain # Interface: Chain @@ -40,9 +40,9 @@ chainId: identifier for the chain #### Defined in -[chain/chain.ts:22](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L22) +[chain/chain.ts:22](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L22) ---- +___ ### chainName @@ -52,9 +52,9 @@ chainName: the name of the chain to display to the user #### Defined in -[chain/chain.ts:24](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L24) +[chain/chain.ts:24](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L24) ---- +___ ### endptGrpc @@ -64,9 +64,9 @@ endptGrpc: endpoint for the gRPC gateway. Usually on port 9090. #### Defined in -[chain/chain.ts:20](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L20) +[chain/chain.ts:20](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L20) ---- +___ ### endptRest @@ -76,9 +76,9 @@ endptRest: endpoint for the REST server. Also, the LCD endpoint. #### Defined in -[chain/chain.ts:18](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L18) +[chain/chain.ts:18](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L18) ---- +___ ### endptTm @@ -88,9 +88,9 @@ endptTm: endpoint for the Tendermint RPC server. Usually on port 26657. #### Defined in -[chain/chain.ts:16](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L16) +[chain/chain.ts:16](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L16) ---- +___ ### feeDenom @@ -100,4 +100,4 @@ feeDenom: the denomination of the fee to be paid for transactions. #### Defined in -[chain/chain.ts:26](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L26) +[chain/chain.ts:26](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L26) diff --git a/packages/nibijs/docs/interfaces/ChainIdParts.md b/packages/nibijs/docs/interfaces/ChainIdParts.md index 6a30c888..3aab1768 100644 --- a/packages/nibijs/docs/interfaces/ChainIdParts.md +++ b/packages/nibijs/docs/interfaces/ChainIdParts.md @@ -1,4 +1,4 @@ -[NibiJS Documentation - v0.19.14](../intro.md) / [Exports](../modules.md) / ChainIdParts +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / ChainIdParts # Interface: ChainIdParts @@ -18,9 +18,9 @@ #### Defined in -[chain/chain.ts:42](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L42) +[chain/chain.ts:42](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L42) ---- +___ ### prefix @@ -28,9 +28,9 @@ #### Defined in -[chain/chain.ts:40](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L40) +[chain/chain.ts:40](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L40) ---- +___ ### shortName @@ -38,4 +38,4 @@ #### Defined in -[chain/chain.ts:41](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L41) +[chain/chain.ts:41](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L41) diff --git a/packages/nibijs/docs/interfaces/CoinMap.md b/packages/nibijs/docs/interfaces/CoinMap.md index 514137b6..2f597812 100644 --- a/packages/nibijs/docs/interfaces/CoinMap.md +++ b/packages/nibijs/docs/interfaces/CoinMap.md @@ -1,4 +1,4 @@ -[NibiJS Documentation - v0.19.14](../intro.md) / [Exports](../modules.md) / CoinMap +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / CoinMap # Interface: CoinMap diff --git a/packages/nibijs/docs/interfaces/Event.md b/packages/nibijs/docs/interfaces/Event.md index b743f7ee..4538cb8e 100644 --- a/packages/nibijs/docs/interfaces/Event.md +++ b/packages/nibijs/docs/interfaces/Event.md @@ -1,4 +1,4 @@ -[NibiJS Documentation - v0.19.14](../intro.md) / [Exports](../modules.md) / Event +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / Event # Interface: Event @@ -17,9 +17,9 @@ #### Defined in -[chain/types.ts:49](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/types.ts#L49) +[chain/types.ts:49](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/types.ts#L49) ---- +___ ### type @@ -27,4 +27,4 @@ #### Defined in -[chain/types.ts:48](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/types.ts#L48) +[chain/types.ts:48](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/types.ts#L48) diff --git a/packages/nibijs/docs/interfaces/MsgAddMarginEncodeObject.md b/packages/nibijs/docs/interfaces/MsgAddMarginEncodeObject.md new file mode 100644 index 00000000..481b7dc3 --- /dev/null +++ b/packages/nibijs/docs/interfaces/MsgAddMarginEncodeObject.md @@ -0,0 +1,44 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / MsgAddMarginEncodeObject + +# Interface: MsgAddMarginEncodeObject + +## Hierarchy + +- `EncodeObject` + + ↳ **`MsgAddMarginEncodeObject`** + +## Table of contents + +### Properties + +- [typeUrl](MsgAddMarginEncodeObject.md#typeurl) +- [value](MsgAddMarginEncodeObject.md#value) + +## Properties + +### typeUrl + +• `Readonly` **typeUrl**: `string` + +#### Overrides + +EncodeObject.typeUrl + +#### Defined in + +[msg/perp.ts:34](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L34) + +___ + +### value + +• `Readonly` **value**: `Partial`<`MsgAddMargin`\> + +#### Overrides + +EncodeObject.value + +#### Defined in + +[msg/perp.ts:35](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L35) diff --git a/packages/nibijs/docs/interfaces/MsgClosePositionEncodeObject.md b/packages/nibijs/docs/interfaces/MsgClosePositionEncodeObject.md new file mode 100644 index 00000000..d4da28f4 --- /dev/null +++ b/packages/nibijs/docs/interfaces/MsgClosePositionEncodeObject.md @@ -0,0 +1,44 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / MsgClosePositionEncodeObject + +# Interface: MsgClosePositionEncodeObject + +## Hierarchy + +- `EncodeObject` + + ↳ **`MsgClosePositionEncodeObject`** + +## Table of contents + +### Properties + +- [typeUrl](MsgClosePositionEncodeObject.md#typeurl) +- [value](MsgClosePositionEncodeObject.md#value) + +## Properties + +### typeUrl + +• `Readonly` **typeUrl**: `string` + +#### Overrides + +EncodeObject.typeUrl + +#### Defined in + +[msg/perp.ts:90](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L90) + +___ + +### value + +• `Readonly` **value**: `Partial`<`MsgClosePosition`\> + +#### Overrides + +EncodeObject.value + +#### Defined in + +[msg/perp.ts:91](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L91) diff --git a/packages/nibijs/docs/interfaces/MsgCreatePoolEncodeObject.md b/packages/nibijs/docs/interfaces/MsgCreatePoolEncodeObject.md new file mode 100644 index 00000000..4fbd51d0 --- /dev/null +++ b/packages/nibijs/docs/interfaces/MsgCreatePoolEncodeObject.md @@ -0,0 +1,44 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / MsgCreatePoolEncodeObject + +# Interface: MsgCreatePoolEncodeObject + +## Hierarchy + +- `EncodeObject` + + ↳ **`MsgCreatePoolEncodeObject`** + +## Table of contents + +### Properties + +- [typeUrl](MsgCreatePoolEncodeObject.md#typeurl) +- [value](MsgCreatePoolEncodeObject.md#value) + +## Properties + +### typeUrl + +• `Readonly` **typeUrl**: `string` + +#### Overrides + +EncodeObject.typeUrl + +#### Defined in + +[msg/spot.ts:27](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L27) + +___ + +### value + +• `Readonly` **value**: `Partial`<`MsgCreatePool`\> + +#### Overrides + +EncodeObject.value + +#### Defined in + +[msg/spot.ts:28](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L28) diff --git a/packages/nibijs/docs/interfaces/MsgDonateToEcosystemFundEncodeObject.md b/packages/nibijs/docs/interfaces/MsgDonateToEcosystemFundEncodeObject.md new file mode 100644 index 00000000..deaca4ee --- /dev/null +++ b/packages/nibijs/docs/interfaces/MsgDonateToEcosystemFundEncodeObject.md @@ -0,0 +1,44 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / MsgDonateToEcosystemFundEncodeObject + +# Interface: MsgDonateToEcosystemFundEncodeObject + +## Hierarchy + +- `EncodeObject` + + ↳ **`MsgDonateToEcosystemFundEncodeObject`** + +## Table of contents + +### Properties + +- [typeUrl](MsgDonateToEcosystemFundEncodeObject.md#typeurl) +- [value](MsgDonateToEcosystemFundEncodeObject.md#value) + +## Properties + +### typeUrl + +• `Readonly` **typeUrl**: `string` + +#### Overrides + +EncodeObject.typeUrl + +#### Defined in + +[msg/perp.ts:104](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L104) + +___ + +### value + +• `Readonly` **value**: `Partial`<`MsgDonateToEcosystemFund`\> + +#### Overrides + +EncodeObject.value + +#### Defined in + +[msg/perp.ts:105](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L105) diff --git a/packages/nibijs/docs/interfaces/MsgExitPoolEncodeObject.md b/packages/nibijs/docs/interfaces/MsgExitPoolEncodeObject.md new file mode 100644 index 00000000..b52b895e --- /dev/null +++ b/packages/nibijs/docs/interfaces/MsgExitPoolEncodeObject.md @@ -0,0 +1,44 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / MsgExitPoolEncodeObject + +# Interface: MsgExitPoolEncodeObject + +## Hierarchy + +- `EncodeObject` + + ↳ **`MsgExitPoolEncodeObject`** + +## Table of contents + +### Properties + +- [typeUrl](MsgExitPoolEncodeObject.md#typeurl) +- [value](MsgExitPoolEncodeObject.md#value) + +## Properties + +### typeUrl + +• `Readonly` **typeUrl**: `string` + +#### Overrides + +EncodeObject.typeUrl + +#### Defined in + +[msg/spot.ts:49](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L49) + +___ + +### value + +• `Readonly` **value**: `Partial`<`MsgExitPool`\> + +#### Overrides + +EncodeObject.value + +#### Defined in + +[msg/spot.ts:50](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L50) diff --git a/packages/nibijs/docs/interfaces/MsgJoinPoolEncodeObject.md b/packages/nibijs/docs/interfaces/MsgJoinPoolEncodeObject.md new file mode 100644 index 00000000..fdacbdd6 --- /dev/null +++ b/packages/nibijs/docs/interfaces/MsgJoinPoolEncodeObject.md @@ -0,0 +1,44 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / MsgJoinPoolEncodeObject + +# Interface: MsgJoinPoolEncodeObject + +## Hierarchy + +- `EncodeObject` + + ↳ **`MsgJoinPoolEncodeObject`** + +## Table of contents + +### Properties + +- [typeUrl](MsgJoinPoolEncodeObject.md#typeurl) +- [value](MsgJoinPoolEncodeObject.md#value) + +## Properties + +### typeUrl + +• `Readonly` **typeUrl**: `string` + +#### Overrides + +EncodeObject.typeUrl + +#### Defined in + +[msg/spot.ts:38](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L38) + +___ + +### value + +• `Readonly` **value**: `Partial`<`MsgJoinPool`\> + +#### Overrides + +EncodeObject.value + +#### Defined in + +[msg/spot.ts:39](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L39) diff --git a/packages/nibijs/docs/interfaces/MsgMultiLiquidateEncodeObject.md b/packages/nibijs/docs/interfaces/MsgMultiLiquidateEncodeObject.md new file mode 100644 index 00000000..791ccfff --- /dev/null +++ b/packages/nibijs/docs/interfaces/MsgMultiLiquidateEncodeObject.md @@ -0,0 +1,44 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / MsgMultiLiquidateEncodeObject + +# Interface: MsgMultiLiquidateEncodeObject + +## Hierarchy + +- `EncodeObject` + + ↳ **`MsgMultiLiquidateEncodeObject`** + +## Table of contents + +### Properties + +- [typeUrl](MsgMultiLiquidateEncodeObject.md#typeurl) +- [value](MsgMultiLiquidateEncodeObject.md#value) + +## Properties + +### typeUrl + +• `Readonly` **typeUrl**: `string` + +#### Overrides + +EncodeObject.typeUrl + +#### Defined in + +[msg/perp.ts:62](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L62) + +___ + +### value + +• `Readonly` **value**: `Partial`<`MsgMultiLiquidate`\> + +#### Overrides + +EncodeObject.value + +#### Defined in + +[msg/perp.ts:63](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L63) diff --git a/packages/nibijs/docs/interfaces/MsgOpenPositionEncodeObject.md b/packages/nibijs/docs/interfaces/MsgOpenPositionEncodeObject.md new file mode 100644 index 00000000..f88aaf27 --- /dev/null +++ b/packages/nibijs/docs/interfaces/MsgOpenPositionEncodeObject.md @@ -0,0 +1,44 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / MsgOpenPositionEncodeObject + +# Interface: MsgOpenPositionEncodeObject + +## Hierarchy + +- `EncodeObject` + + ↳ **`MsgOpenPositionEncodeObject`** + +## Table of contents + +### Properties + +- [typeUrl](MsgOpenPositionEncodeObject.md#typeurl) +- [value](MsgOpenPositionEncodeObject.md#value) + +## Properties + +### typeUrl + +• `Readonly` **typeUrl**: `string` + +#### Overrides + +EncodeObject.typeUrl + +#### Defined in + +[msg/perp.ts:76](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L76) + +___ + +### value + +• `Readonly` **value**: `Partial`<`MsgOpenPosition`\> + +#### Overrides + +EncodeObject.value + +#### Defined in + +[msg/perp.ts:77](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L77) diff --git a/packages/nibijs/docs/interfaces/MsgRemoveMarginEncodeObject.md b/packages/nibijs/docs/interfaces/MsgRemoveMarginEncodeObject.md new file mode 100644 index 00000000..bc9d7d0e --- /dev/null +++ b/packages/nibijs/docs/interfaces/MsgRemoveMarginEncodeObject.md @@ -0,0 +1,44 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / MsgRemoveMarginEncodeObject + +# Interface: MsgRemoveMarginEncodeObject + +## Hierarchy + +- `EncodeObject` + + ↳ **`MsgRemoveMarginEncodeObject`** + +## Table of contents + +### Properties + +- [typeUrl](MsgRemoveMarginEncodeObject.md#typeurl) +- [value](MsgRemoveMarginEncodeObject.md#value) + +## Properties + +### typeUrl + +• `Readonly` **typeUrl**: `string` + +#### Overrides + +EncodeObject.typeUrl + +#### Defined in + +[msg/perp.ts:48](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L48) + +___ + +### value + +• `Readonly` **value**: `Partial`<`MsgRemoveMargin`\> + +#### Overrides + +EncodeObject.value + +#### Defined in + +[msg/perp.ts:49](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L49) diff --git a/packages/nibijs/docs/interfaces/MsgSwapAssetsEncodeObject.md b/packages/nibijs/docs/interfaces/MsgSwapAssetsEncodeObject.md new file mode 100644 index 00000000..8c30d075 --- /dev/null +++ b/packages/nibijs/docs/interfaces/MsgSwapAssetsEncodeObject.md @@ -0,0 +1,44 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / MsgSwapAssetsEncodeObject + +# Interface: MsgSwapAssetsEncodeObject + +## Hierarchy + +- `EncodeObject` + + ↳ **`MsgSwapAssetsEncodeObject`** + +## Table of contents + +### Properties + +- [typeUrl](MsgSwapAssetsEncodeObject.md#typeurl) +- [value](MsgSwapAssetsEncodeObject.md#value) + +## Properties + +### typeUrl + +• `Readonly` **typeUrl**: `string` + +#### Overrides + +EncodeObject.typeUrl + +#### Defined in + +[msg/spot.ts:60](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L60) + +___ + +### value + +• `Readonly` **value**: `Partial`<`MsgSwapAssets`\> + +#### Overrides + +EncodeObject.value + +#### Defined in + +[msg/spot.ts:61](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L61) diff --git a/packages/nibijs/docs/interfaces/MsgTypeUrls.md b/packages/nibijs/docs/interfaces/MsgTypeUrls.md new file mode 100644 index 00000000..5cab549b --- /dev/null +++ b/packages/nibijs/docs/interfaces/MsgTypeUrls.md @@ -0,0 +1,7 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / MsgTypeUrls + +# Interface: MsgTypeUrls + +## Indexable + +▪ [msg: `string`]: `string` diff --git a/packages/nibijs/docs/interfaces/TxLog.md b/packages/nibijs/docs/interfaces/TxLog.md index 6353243d..958153e2 100644 --- a/packages/nibijs/docs/interfaces/TxLog.md +++ b/packages/nibijs/docs/interfaces/TxLog.md @@ -1,4 +1,4 @@ -[NibiJS Documentation - v0.19.14](../intro.md) / [Exports](../modules.md) / TxLog +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / TxLog # Interface: TxLog @@ -16,4 +16,4 @@ #### Defined in -[chain/types.ts:58](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/types.ts#L58) +[chain/types.ts:58](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/types.ts#L58) diff --git a/packages/nibijs/docs/interfaces/TxMessage.md b/packages/nibijs/docs/interfaces/TxMessage.md new file mode 100644 index 00000000..567a15cc --- /dev/null +++ b/packages/nibijs/docs/interfaces/TxMessage.md @@ -0,0 +1,19 @@ +[NibiJS Documentation - v0.19.15](../intro.md) / [Exports](../modules.md) / TxMessage + +# Interface: TxMessage + +TxMessage: a message contained within a transaction. + +**`Field`** + +typeUrl: registered identifier for the proto message + +**`Field`** + +value: proto-able message body + +## Hierarchy + +- `EncodeObject` + + ↳ **`TxMessage`** diff --git a/packages/nibijs/docs/intro.md b/packages/nibijs/docs/intro.md index b68fe96e..f70f8f9d 100644 --- a/packages/nibijs/docs/intro.md +++ b/packages/nibijs/docs/intro.md @@ -1,4 +1,4 @@ -NibiJS Documentation - v0.19.14 / [Exports](modules.md) +NibiJS Documentation - v0.19.15 / [Exports](modules.md)

@@ -22,20 +22,23 @@ The official TypeScript SDK for the Nibiru blockchain - - + + - The NibiJS (`@nibiruchain/nibijs`) package makes it possible to interact with Nibiru from a Node.js or browser environment. `nibijs` provides simple abstractions for core data structures, serialization, key management, API requests, and the submission of transactions. -The `nibijs` source code can be found in the ["packages" directory](https://github.com/NibiruChain/ts-sdk/tree/main/packages). The types and classes generated from Nibiru's `.proto` files are inside a separate `npm` package called `@nibiruchain/protojs`. +The `nibijs` source code can be found in the ["packages" directory](https://github.com/NibiruChain/ts-sdk/tree/main/packages). The types and classes generated from Nibiru's `.proto` files are inside a separate `npm` package called `@nibiruchain/protojs`. #### Table of Contents - [Installation](#installation) - [Usage](#usage) + - [Example: Creating a wallet](#example-creating-a-wallet) + - [Example: Querying](#example-querying) + - [Example: Sending funds](#example-sending-funds) + - [Example: Transaction with arbitrary messages](#example-transaction-with-arbitrary-messages) - [Codebase structure](#codebase-structure) - [Development Quick Start](#development-quick-start) - [🔓 License](#-license) @@ -61,7 +64,8 @@ The entrypoint for `nibijs` is the `Sdk` object, which is meant to mimic the roo #### Example: Creating a wallet ```js -import { newRandomWallet, WalletHD } from "@nibiruchain/nibijs/dist/tx" +import { newRandomWallet, WalletHD } from "@nibiruchain/nibijs" + const wallet: WalletHD = await newRandomWallet() const [{ address }] = await wallet.getAccounts() @@ -73,37 +77,62 @@ console.log("address: ", address) #### Example: Querying ```js -import { Testnet, newSdk } from "@nibiruchain/nibijs" -const sdk = newSdk(Testnet, myMnemonic) +import { + IncentivizedTestent, + NibiruQueryClient, + NibiruSigningClient, +} from "@nibiruchain/nibijs" + +const TEST_CHAIN = IncentivizedTestent(1) +const queryClient = await NibiruQueryClient.connect(TEST_CHAIN.endptTm) -const balances = await sdk.query.bank.allBalances(address) -console.log("balances: %o", balances) +const perpParamsResp = await queryClient.nibiruExtensions.perp.params() +console.log("perpParams: %o", perpParamsResp) -const allPools = await sdk.query.vpool.allPools() +const allPools = await queryClient.nibiruExtensions.vpool.allPools() console.log("allPools: %o", allPools) const blockHeight = 1 -const block = sdk.tmClient.block(blockHeight) +const block = await queryClient.getBlock(blockHeight) ``` #### Example: Sending funds ```js -import { Testnet, newSdk, newCoins, Coin } from "@nibiruchain/nibijs" -const sdk = newSdk(Testnet, myMnemonic) +import { + Coin, + NibiruSigningClient, + newCoins, + newSignerFromMnemonic, +} from "@nibiruchain/nibijs" + +const signer = await newSignerFromMnemonic(mnemonic!) +const signingClient = await NibiruSigningClient.connectWithSigner( + TEST_CHAIN.endptTm, + signer, +) +const [{ address: fromAddr }] = await signer.getAccounts() + const tokens: Coin[] = newCoins(5, "unibi") const toAddr: string = "..." // bech32 address of the receiving party -let txResp = sdk.tx.sendTokens(toAddr, tokens) +const txResp = await signingClient.sendTokens(fromAddr, toAddr, tokens, "auto") ``` #### Example: Transaction with arbitrary messages ```js -import { Testnet, newSdk, newCoins, Coin, DeliverTxResponse } from "@nibiruchain/nibijs" -import { Msg } from "@nibiruchain/nibijs/msg" - -const sdk = newSdk(Testnet, myMnemonic) -let msgs: TxMessage[] = [ +import { IncentivizedTestent, NibiruSigningClient, newCoin } from "@nibiruchain/nibijs" +import { Msg, TxMessage } from "@nibiruchain/nibijs/dist/msg" + +const signer = await newSignerFromMnemonic(mnemonic!) +signer.getAccounts() +const signingClient = await NibiruSigningClient.connectWithSigner( + TEST_CHAIN.endptTm, + signer, +) +const [{ address: fromAddr }] = await signer.getAccounts() +const pair = "ubtc:unusd" +const msgs: TxMessage[] = [ Msg.perp.openPosition({ tokenPair: pair, baseAssetAmountLimit: 0, @@ -117,8 +146,14 @@ let msgs: TxMessage[] = [ tokenPair: pair, margin: newCoin("20", "unusd"), }), + Msg.perp.removeMargin({ + tokenPair: pair, + sender: fromAddr, + margin: newCoin("5", "unusd"), + }), + // final margin value of 10 (open) + 20 (add) - 5 (remove) = 25 ] -let txResp: DeliverTxResponse = await sdk.tx.signAndBroadcast(...msgs) +const txResp = await signingClient.signAndBroadcast(fromAddr, msgs, "auto") ``` ## Codebase structure @@ -135,8 +170,8 @@ let txResp: DeliverTxResponse = await sdk.tx.signAndBroadcast(...msgs) --- - @@ -145,18 +180,21 @@ TODO 1. First install yarn. - ```sh - npm install -g yarn - ``` + ```sh + npm install -g yarn + ``` 2. Then, install package dependencies. At the root of the repository, run - ```sh - yarn - ``` + + ```sh + yarn + ``` + 3. Lastly, compile the code in each package. - ```sh - yarn build - ``` + + ```sh + yarn build + ``` See [HACKING.md](https://github.com/NibiruChain/ts-sdk/blob/main/HACKING.md) for the full development guide. It includes instructions on: diff --git a/packages/nibijs/docs/modules.md b/packages/nibijs/docs/modules.md index 63e427a3..dc618124 100644 --- a/packages/nibijs/docs/modules.md +++ b/packages/nibijs/docs/modules.md @@ -1,19 +1,22 @@ -[NibiJS Documentation - v0.19.14](intro.md) / Exports +[NibiJS Documentation - v0.19.15](intro.md) / Exports -# NibiJS Documentation - v0.19.14 +# NibiJS Documentation - v0.19.15 ## Table of contents ### Enumerations -- [BECH32_PREFIX](enums/BECH32_PREFIX.md) +- [BECH32\_PREFIX](enums/BECH32_PREFIX.md) - [Signer](enums/Signer.md) ### Classes - [CustomChain](classes/CustomChain.md) +- [MsgFactory](classes/MsgFactory.md) - [NibiruQueryClient](classes/NibiruQueryClient.md) - [NibiruSigningClient](classes/NibiruSigningClient.md) +- [PerpMsgFactory](classes/PerpMsgFactory.md) +- [SpotMsgFactory](classes/SpotMsgFactory.md) ### Interfaces @@ -22,7 +25,19 @@ - [ChainIdParts](interfaces/ChainIdParts.md) - [CoinMap](interfaces/CoinMap.md) - [Event](interfaces/Event.md) +- [MsgAddMarginEncodeObject](interfaces/MsgAddMarginEncodeObject.md) +- [MsgClosePositionEncodeObject](interfaces/MsgClosePositionEncodeObject.md) +- [MsgCreatePoolEncodeObject](interfaces/MsgCreatePoolEncodeObject.md) +- [MsgDonateToEcosystemFundEncodeObject](interfaces/MsgDonateToEcosystemFundEncodeObject.md) +- [MsgExitPoolEncodeObject](interfaces/MsgExitPoolEncodeObject.md) +- [MsgJoinPoolEncodeObject](interfaces/MsgJoinPoolEncodeObject.md) +- [MsgMultiLiquidateEncodeObject](interfaces/MsgMultiLiquidateEncodeObject.md) +- [MsgOpenPositionEncodeObject](interfaces/MsgOpenPositionEncodeObject.md) +- [MsgRemoveMarginEncodeObject](interfaces/MsgRemoveMarginEncodeObject.md) +- [MsgSwapAssetsEncodeObject](interfaces/MsgSwapAssetsEncodeObject.md) +- [MsgTypeUrls](interfaces/MsgTypeUrls.md) - [TxLog](interfaces/TxLog.md) +- [TxMessage](interfaces/TxMessage.md) ### Type Aliases @@ -30,9 +45,14 @@ ### Variables -- [INT_MULT](modules.md#int_mult) +- [INT\_MULT](modules.md#int_mult) - [Localnet](modules.md#localnet) +- [Msg](modules.md#msg) +- [PERP\_MSG\_TYPE\_URLS](modules.md#perp_msg_type_urls) +- [SPOT\_MSG\_TYPE\_URLS](modules.md#spot_msg_type_urls) - [nibiruRegistryTypes](modules.md#nibiruregistrytypes) +- [perpTypes](modules.md#perptypes) +- [spotTypes](modules.md#spottypes) ### Functions @@ -46,6 +66,16 @@ - [getRegistry](modules.md#getregistry) - [go](modules.md#go) - [instanceOfChain](modules.md#instanceofchain) +- [isMsgAddMarginEncodeObject](modules.md#ismsgaddmarginencodeobject) +- [isMsgClosePositionEncodeObject](modules.md#ismsgclosepositionencodeobject) +- [isMsgCreatePoolEncodeObject](modules.md#ismsgcreatepoolencodeobject) +- [isMsgDonateToEcosystemFundEncodeObject](modules.md#ismsgdonatetoecosystemfundencodeobject) +- [isMsgExitPoolEncodeObject](modules.md#ismsgexitpoolencodeobject) +- [isMsgJoinPoolEncodeObject](modules.md#ismsgjoinpoolencodeobject) +- [isMsgMultiLiquidateEncodeObject](modules.md#ismsgmultiliquidateencodeobject) +- [isMsgOpenPositionEncodeObject](modules.md#ismsgopenpositionencodeobject) +- [isMsgRemoveMarginEncodeObject](modules.md#ismsgremovemarginencodeobject) +- [isMsgSwapAssetsEncodeObject](modules.md#ismsgswapassetsencodeobject) - [isRestEndptLive](modules.md#isrestendptlive) - [newCoinMapFromCoins](modules.md#newcoinmapfromcoins) - [newRandomWallet](modules.md#newrandomwallet) @@ -64,19 +94,19 @@ #### Defined in -[query/query.ts:29](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/query/query.ts#L29) +[query/query.ts:29](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/query/query.ts#L29) ## Variables -### INT_MULT +### INT\_MULT -• `Const` **INT_MULT**: `1000000` +• `Const` **INT\_MULT**: ``1000000`` #### Defined in -[chain/parse.ts:2](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/parse.ts#L2) +[chain/parse.ts:2](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/parse.ts#L2) ---- +___ ### Localnet @@ -84,9 +114,59 @@ #### Defined in -[chain/chain.ts:98](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L98) +[chain/chain.ts:98](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L98) ---- +___ + +### Msg + +• `Const` **Msg**: [`MsgFactory`](classes/MsgFactory.md) + +#### Defined in + +[msg/index.ts:10](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/index.ts#L10) + +___ + +### PERP\_MSG\_TYPE\_URLS + +• `Const` **PERP\_MSG\_TYPE\_URLS**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `MsgAddMargin` | `string` | +| `MsgClosePosition` | `string` | +| `MsgDonateToEcosystemFund` | `string` | +| `MsgMultiLiquidate` | `string` | +| `MsgOpenPosition` | `string` | +| `MsgRemoveMargin` | `string` | + +#### Defined in + +[msg/perp.ts:15](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L15) + +___ + +### SPOT\_MSG\_TYPE\_URLS + +• `Const` **SPOT\_MSG\_TYPE\_URLS**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `MsgCreatePool` | `string` | +| `MsgExitPool` | `string` | +| `MsgJoinPool` | `string` | +| `MsgSwapAssets` | `string` | + +#### Defined in + +[msg/spot.ts:12](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L12) + +___ ### nibiruRegistryTypes @@ -94,7 +174,27 @@ #### Defined in -[tx/signingClient.ts:30](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signingClient.ts#L30) +[tx/signingClient.ts:30](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signingClient.ts#L30) + +___ + +### perpTypes + +• `Const` **perpTypes**: `ReadonlyArray`<[`string`, `GeneratedType`]\> + +#### Defined in + +[msg/perp.ts:24](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L24) + +___ + +### spotTypes + +• `Const` **spotTypes**: `ReadonlyArray`<[`string`, `GeneratedType`]\> + +#### Defined in + +[msg/spot.ts:19](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L19) ## Functions @@ -104,8 +204,8 @@ #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `chainNumber` | `number` | #### Returns @@ -114,9 +214,9 @@ #### Defined in -[chain/chain.ts:115](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L115) +[chain/chain.ts:115](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L115) ---- +___ ### IncentivizedTestent @@ -124,8 +224,8 @@ #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `chainNumber` | `number` | #### Returns @@ -134,9 +234,9 @@ #### Defined in -[chain/chain.ts:107](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L107) +[chain/chain.ts:107](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L107) ---- +___ ### assert @@ -144,10 +244,10 @@ #### Parameters -| Name | Type | -| :---------- | :-------- | +| Name | Type | +| :------ | :------ | | `condition` | `boolean` | -| `message?` | `string` | +| `message?` | `string` | #### Returns @@ -155,9 +255,9 @@ #### Defined in -[chain/types.ts:27](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/types.ts#L27) +[chain/types.ts:27](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/types.ts#L27) ---- +___ ### fromSdkDec @@ -165,8 +265,8 @@ #### Parameters -| Name | Type | -| :------- | :------- | +| Name | Type | +| :------ | :------ | | `sdkDec` | `string` | #### Returns @@ -175,9 +275,9 @@ #### Defined in -[chain/parse.ts:97](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/parse.ts#L97) +[chain/parse.ts:97](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/parse.ts#L97) ---- +___ ### fromSdkDecSafe @@ -185,8 +285,8 @@ #### Parameters -| Name | Type | -| :------ | :------- | +| Name | Type | +| :------ | :------ | | `inStr` | `string` | #### Returns @@ -195,9 +295,9 @@ #### Defined in -[chain/parse.ts:156](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/parse.ts#L156) +[chain/parse.ts:156](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/parse.ts#L156) ---- +___ ### fromSdkInt @@ -205,8 +305,8 @@ #### Parameters -| Name | Type | -| :------- | :------- | +| Name | Type | +| :------ | :------ | | `intStr` | `string` | #### Returns @@ -215,9 +315,9 @@ #### Defined in -[chain/parse.ts:150](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/parse.ts#L150) +[chain/parse.ts:150](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/parse.ts#L150) ---- +___ ### getKeplr @@ -225,8 +325,8 @@ #### Parameters -| Name | Type | -| :------ | :----------------------------- | +| Name | Type | +| :------ | :------ | | `chain` | [`Chain`](interfaces/Chain.md) | #### Returns @@ -235,9 +335,9 @@ #### Defined in -[wallet/keplr.ts:9](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/wallet/keplr.ts#L9) +[wallet/keplr.ts:9](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/wallet/keplr.ts#L9) ---- +___ ### getRegistry @@ -249,35 +349,35 @@ #### Defined in -[tx/signer.ts:28](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signer.ts#L28) +[tx/signer.ts:28](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signer.ts#L28) ---- +___ ### go -▸ **go**<`T`\>(`promise`): `Promise`<{ `err`: `undefined` \| `Error` ; `res`: `T` \| `undefined` }\> +▸ **go**<`T`\>(`promise`): `Promise`<{ `err`: `undefined` \| `Error` ; `res`: `T` \| `undefined` }\> #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :-------- | :-------------- | +| Name | Type | +| :------ | :------ | | `promise` | `Promise`<`T`\> | #### Returns -`Promise`<{ `err`: `undefined` \| `Error` ; `res`: `T` \| `undefined` }\> +`Promise`<{ `err`: `undefined` \| `Error` ; `res`: `T` \| `undefined` }\> #### Defined in -[chain/types.ts:13](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/types.ts#L13) +[chain/types.ts:13](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/types.ts#L13) ---- +___ ### instanceOfChain @@ -288,8 +388,8 @@ the Chain interface. #### Parameters -| Name | Type | -| :---- | :---- | +| Name | Type | +| :------ | :------ | | `obj` | `any` | #### Returns @@ -298,9 +398,209 @@ obj is Chain #### Defined in -[chain/chain.ts:33](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L33) +[chain/chain.ts:33](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L33) + +___ + +### isMsgAddMarginEncodeObject + +▸ **isMsgAddMarginEncodeObject**(`encodeObject`): encodeObject is MsgAddMarginEncodeObject + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `encodeObject` | `EncodeObject` | + +#### Returns + +encodeObject is MsgAddMarginEncodeObject + +#### Defined in + +[msg/perp.ts:38](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L38) + +___ + +### isMsgClosePositionEncodeObject + +▸ **isMsgClosePositionEncodeObject**(`encodeObject`): encodeObject is MsgClosePositionEncodeObject + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `encodeObject` | `EncodeObject` | + +#### Returns + +encodeObject is MsgClosePositionEncodeObject + +#### Defined in + +[msg/perp.ts:94](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L94) + +___ + +### isMsgCreatePoolEncodeObject + +▸ **isMsgCreatePoolEncodeObject**(`encodeObject`): encodeObject is MsgCreatePoolEncodeObject + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `encodeObject` | `EncodeObject` | + +#### Returns + +encodeObject is MsgCreatePoolEncodeObject + +#### Defined in + +[msg/spot.ts:31](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L31) + +___ + +### isMsgDonateToEcosystemFundEncodeObject + +▸ **isMsgDonateToEcosystemFundEncodeObject**(`encodeObject`): encodeObject is MsgDonateToEcosystemFundEncodeObject + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `encodeObject` | `EncodeObject` | + +#### Returns + +encodeObject is MsgDonateToEcosystemFundEncodeObject + +#### Defined in + +[msg/perp.ts:108](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L108) + +___ + +### isMsgExitPoolEncodeObject + +▸ **isMsgExitPoolEncodeObject**(`encodeObject`): encodeObject is MsgExitPoolEncodeObject + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `encodeObject` | `EncodeObject` | + +#### Returns + +encodeObject is MsgExitPoolEncodeObject + +#### Defined in + +[msg/spot.ts:53](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L53) + +___ + +### isMsgJoinPoolEncodeObject + +▸ **isMsgJoinPoolEncodeObject**(`encodeObject`): encodeObject is MsgJoinPoolEncodeObject + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `encodeObject` | `EncodeObject` | + +#### Returns + +encodeObject is MsgJoinPoolEncodeObject + +#### Defined in + +[msg/spot.ts:42](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L42) + +___ + +### isMsgMultiLiquidateEncodeObject + +▸ **isMsgMultiLiquidateEncodeObject**(`encodeObject`): encodeObject is MsgMultiLiquidateEncodeObject + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `encodeObject` | `EncodeObject` | + +#### Returns + +encodeObject is MsgMultiLiquidateEncodeObject + +#### Defined in + +[msg/perp.ts:66](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L66) + +___ + +### isMsgOpenPositionEncodeObject + +▸ **isMsgOpenPositionEncodeObject**(`encodeObject`): encodeObject is MsgOpenPositionEncodeObject + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `encodeObject` | `EncodeObject` | + +#### Returns + +encodeObject is MsgOpenPositionEncodeObject + +#### Defined in + +[msg/perp.ts:80](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L80) + +___ + +### isMsgRemoveMarginEncodeObject + +▸ **isMsgRemoveMarginEncodeObject**(`encodeObject`): encodeObject is MsgRemoveMarginEncodeObject + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `encodeObject` | `EncodeObject` | + +#### Returns + +encodeObject is MsgRemoveMarginEncodeObject + +#### Defined in + +[msg/perp.ts:52](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/perp.ts#L52) + +___ + +### isMsgSwapAssetsEncodeObject + +▸ **isMsgSwapAssetsEncodeObject**(`encodeObject`): encodeObject is MsgSwapAssetsEncodeObject + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `encodeObject` | `EncodeObject` | + +#### Returns + +encodeObject is MsgSwapAssetsEncodeObject + +#### Defined in + +[msg/spot.ts:64](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/msg/spot.ts#L64) ---- +___ ### isRestEndptLive @@ -308,8 +608,8 @@ obj is Chain #### Parameters -| Name | Type | -| :------ | :----------------------------- | +| Name | Type | +| :------ | :------ | | `chain` | [`Chain`](interfaces/Chain.md) | #### Returns @@ -318,9 +618,9 @@ obj is Chain #### Defined in -[chain/chain.ts:134](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L134) +[chain/chain.ts:134](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L134) ---- +___ ### newCoinMapFromCoins @@ -328,8 +628,8 @@ obj is Chain #### Parameters -| Name | Type | -| :------ | :---------------- | +| Name | Type | +| :------ | :------ | | `coins` | readonly `Coin`[] | #### Returns @@ -338,9 +638,9 @@ obj is Chain #### Defined in -[chain/types.ts:39](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/types.ts#L39) +[chain/types.ts:39](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/types.ts#L39) ---- +___ ### newRandomWallet @@ -352,10 +652,10 @@ Generates a new wallet with a BIP39 mnemonic of length 24. #### Parameters -| Name | Type | Default value | Description | -| :-------- | :---------------------------------------- | :------------------- | :--------------------------------------------------------------------- | -| `length?` | `12` \| `15` \| `18` \| `21` \| `24` | `undefined` | (optional) The number of words in the mnemonic (12, 15, 18, 21 or 24). | -| `prefix` | [`BECH32_PREFIX`](enums/BECH32_PREFIX.md) | `BECH32_PREFIX.ADDR` | (optional) Bech32 address prefix. Defaults to "nibi". | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `length?` | ``12`` \| ``15`` \| ``18`` \| ``21`` \| ``24`` | `undefined` | (optional) The number of words in the mnemonic (12, 15, 18, 21 or 24). | +| `prefix` | [`BECH32_PREFIX`](enums/BECH32_PREFIX.md) | `BECH32_PREFIX.ADDR` | (optional) Bech32 address prefix. Defaults to "nibi". | #### Returns @@ -365,9 +665,9 @@ A wallet for protobuf based signing using SIGN_MODE_DIRECT. #### Defined in -[tx/signer.ts:62](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signer.ts#L62) +[tx/signer.ts:62](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signer.ts#L62) ---- +___ ### newSignerFromKeplr @@ -375,9 +675,9 @@ A wallet for protobuf based signing using SIGN_MODE_DIRECT. #### Parameters -| Name | Type | -| :-------- | :------- | -| `keplr` | `Keplr` | +| Name | Type | +| :------ | :------ | +| `keplr` | `Keplr` | | `chainId` | `string` | #### Returns @@ -386,9 +686,9 @@ A wallet for protobuf based signing using SIGN_MODE_DIRECT. #### Defined in -[tx/signer.ts:47](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signer.ts#L47) +[tx/signer.ts:47](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signer.ts#L47) ---- +___ ### newSignerFromMnemonic @@ -400,10 +700,10 @@ Creates a wallet from the given BIP39 mnemonic. #### Parameters -| Name | Type | Default value | Description | -| :--------- | :---------------------------------------- | :------------------- | :---------------------------------------------------- | -| `mnemonic` | `string` | `undefined` | | -| `prefix` | [`BECH32_PREFIX`](enums/BECH32_PREFIX.md) | `BECH32_PREFIX.ADDR` | (optional) Bech32 address prefix. Defaults to "nibi". | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `mnemonic` | `string` | `undefined` | | +| `prefix` | [`BECH32_PREFIX`](enums/BECH32_PREFIX.md) | `BECH32_PREFIX.ADDR` | (optional) Bech32 address prefix. Defaults to "nibi". | #### Returns @@ -413,9 +713,9 @@ A wallet for protobuf based signing using SIGN_MODE_DIRECT #### Defined in -[tx/signer.ts:40](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/tx/signer.ts#L40) +[tx/signer.ts:40](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/tx/signer.ts#L40) ---- +___ ### queryChainIdWithRest @@ -423,8 +723,8 @@ A wallet for protobuf based signing using SIGN_MODE_DIRECT #### Parameters -| Name | Type | -| :------ | :----------------------------- | +| Name | Type | +| :------ | :------ | | `chain` | [`Chain`](interfaces/Chain.md) | #### Returns @@ -433,9 +733,9 @@ A wallet for protobuf based signing using SIGN_MODE_DIRECT #### Defined in -[chain/chain.ts:123](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/chain.ts#L123) +[chain/chain.ts:123](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/chain.ts#L123) ---- +___ ### toSdkDec @@ -452,8 +752,8 @@ ref: Reimplementation of cosmos-sdk/types/decimal.go #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `dec` | `string` | #### Returns @@ -462,9 +762,9 @@ ref: Reimplementation of cosmos-sdk/types/decimal.go #### Defined in -[chain/parse.ts:23](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/parse.ts#L23) +[chain/parse.ts:23](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/parse.ts#L23) ---- +___ ### toSdkInt @@ -472,9 +772,9 @@ ref: Reimplementation of cosmos-sdk/types/decimal.go #### Parameters -| Name | Type | -| :--- | :------- | -| `i` | `number` | +| Name | Type | +| :------ | :------ | +| `i` | `number` | #### Returns @@ -482,9 +782,9 @@ ref: Reimplementation of cosmos-sdk/types/decimal.go #### Defined in -[chain/parse.ts:146](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/parse.ts#L146) +[chain/parse.ts:146](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/parse.ts#L146) ---- +___ ### useFaucet @@ -494,16 +794,16 @@ Sends 10 NIBI and 100 NUSD to the given address from the testnet faucet. #### Parameters -| Name | Type | -| :--------------- | :----------------------------------------- | -| `«destructured»` | `Object` | -| › `address` | `string` | -| › `amts?` | `Object` | -| › `amts.nibi` | `number` | -| › `amts.nusd` | `number` | -| › `amts.usdt` | `number` | -| › `chain?` | `string` \| [`Chain`](interfaces/Chain.md) | -| › `faucetUrl?` | `string` | +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `address` | `string` | +| › `amts?` | `Object` | +| › `amts.nibi` | `number` | +| › `amts.nusd` | `number` | +| › `amts.usdt` | `number` | +| › `chain?` | `string` \| [`Chain`](interfaces/Chain.md) | +| › `faucetUrl?` | `string` | #### Returns @@ -511,4 +811,4 @@ Sends 10 NIBI and 100 NUSD to the given address from the testnet faucet. #### Defined in -[chain/useFaucet.ts:7](https://github.com/NibiruChain/ts-sdk/blob/6bec800/packages/nibijs/src/chain/useFaucet.ts#L7) +[chain/useFaucet.ts:7](https://github.com/NibiruChain/ts-sdk/blob/b0f9b4b/packages/nibijs/src/chain/useFaucet.ts#L7) diff --git a/packages/nibijs/package.json b/packages/nibijs/package.json index 430ea602..e6dcce79 100644 --- a/packages/nibijs/package.json +++ b/packages/nibijs/package.json @@ -1,7 +1,7 @@ { "name": "@nibiruchain/nibijs", "description": "The TypeScript SDK for the Nibiru blockchain.", - "version": "0.19.14", + "version": "0.19.15", "license": "MIT", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/packages/protojs/package.json b/packages/protojs/package.json index 6580b647..807591ad 100644 --- a/packages/protojs/package.json +++ b/packages/protojs/package.json @@ -1,7 +1,7 @@ { "name": "@nibiruchain/protojs", "description": "Protobuf-generated types for Nibiru Chain", - "version": "0.19.2", + "version": "0.19.15", "license": "MIT", "main": "dist/index.js", "types": "dist/index.d.ts",