From 3e2dcd7b6554d340273813ad4b6f961614087c9f Mon Sep 17 00:00:00 2001 From: Unique-Divine Date: Tue, 5 Dec 2023 17:29:40 -0600 Subject: [PATCH] docs: rebuild --- packages/nibijs/docs/classes/CustomChain.md | 44 +- packages/nibijs/docs/classes/MsgFactory.md | 6 +- .../nibijs/docs/classes/NibiruQueryClient.md | 40 +- .../docs/classes/NibiruSigningClient.md | 44 +- .../nibijs/docs/classes/PerpMsgFactory.md | 68 +-- .../nibijs/docs/classes/SpotMsgFactory.md | 30 +- packages/nibijs/docs/classes/StableSwap.md | 66 +-- packages/nibijs/docs/enums/BECH32_PREFIX.md | 54 +-- packages/nibijs/docs/enums/Signer.md | 10 +- packages/nibijs/docs/interfaces/ABCIEvent.md | 6 +- packages/nibijs/docs/interfaces/Chain.md | 22 +- .../nibijs/docs/interfaces/ChainIdParts.md | 10 +- .../nibijs/docs/interfaces/EpochsExtension.md | 4 +- .../nibijs/docs/interfaces/EventAttribute.md | 6 +- packages/nibijs/docs/interfaces/EventMap.md | 2 +- .../docs/interfaces/InflationExtension.md | 4 +- .../interfaces/MsgAddMarginEncodeObject.md | 6 +- .../MsgClosePositionEncodeObject.md | 6 +- .../interfaces/MsgCreatePoolEncodeObject.md | 6 +- .../MsgDonateToEcosystemFundEncodeObject.md | 6 +- .../interfaces/MsgExitPoolEncodeObject.md | 6 +- .../interfaces/MsgJoinPoolEncodeObject.md | 6 +- .../MsgMultiLiquidateEncodeObject.md | 6 +- .../interfaces/MsgOpenPositionEncodeObject.md | 6 +- .../interfaces/MsgPartialCloseEncodeObject.md | 6 +- .../interfaces/MsgRemoveMarginEncodeObject.md | 6 +- .../interfaces/MsgSwapAssetsEncodeObject.md | 6 +- .../nibijs/docs/interfaces/OracleExtension.md | 4 +- .../nibijs/docs/interfaces/PageRequest.md | 20 +- .../nibijs/docs/interfaces/PerpExtension.md | 4 +- .../nibijs/docs/interfaces/SpotExtension.md | 4 +- .../nibijs/docs/interfaces/SudoExtension.md | 4 +- packages/nibijs/docs/interfaces/TxLog.md | 2 +- packages/nibijs/docs/modules.md | 442 +++++++++--------- 34 files changed, 481 insertions(+), 481 deletions(-) diff --git a/packages/nibijs/docs/classes/CustomChain.md b/packages/nibijs/docs/classes/CustomChain.md index a0bf90e5..da3681c3 100644 --- a/packages/nibijs/docs/classes/CustomChain.md +++ b/packages/nibijs/docs/classes/CustomChain.md @@ -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/3e4aac2/packages/nibijs/src/chain/chain.ts#L57) +[chain/chain.ts:57](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L57) ## Properties @@ -70,9 +70,9 @@ chainId: identifier for the chain #### Defined in -[chain/chain.ts:48](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L48) +[chain/chain.ts:48](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L48) ---- +___ ### chainIdParts @@ -80,9 +80,9 @@ chainId: identifier for the chain #### Defined in -[chain/chain.ts:55](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L55) +[chain/chain.ts:55](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L55) ---- +___ ### chainName @@ -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/3e4aac2/packages/nibijs/src/chain/chain.ts#L49) +[chain/chain.ts:49](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L49) ---- +___ ### endptGrpc @@ -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/3e4aac2/packages/nibijs/src/chain/chain.ts#L52) +[chain/chain.ts:52](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L52) ---- +___ ### endptRest @@ -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/3e4aac2/packages/nibijs/src/chain/chain.ts#L51) +[chain/chain.ts:51](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L51) ---- +___ ### endptTm @@ -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/3e4aac2/packages/nibijs/src/chain/chain.ts#L50) +[chain/chain.ts:50](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L50) ---- +___ ### feeDenom -• `Readonly` **feeDenom**: `"unibi"` +• `Readonly` **feeDenom**: ``"unibi"`` feeDenom: the denomination of the fee to be paid for transactions. @@ -160,7 +160,7 @@ feeDenom: the denomination of the fee to be paid for transactions. #### Defined in -[chain/chain.ts:53](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L53) +[chain/chain.ts:53](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L53) ## Methods @@ -174,9 +174,9 @@ feeDenom: the denomination of the fee to be paid for transactions. #### Defined in -[chain/chain.ts:76](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L76) +[chain/chain.ts:76](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L76) ---- +___ ### fromChainId @@ -184,8 +184,8 @@ feeDenom: the denomination of the fee to be paid for transactions. #### Parameters -| Name | Type | -| :-------- | :------- | +| Name | Type | +| :------ | :------ | | `chainId` | `string` | #### Returns @@ -194,4 +194,4 @@ feeDenom: the denomination of the fee to be paid for transactions. #### Defined in -[chain/chain.ts:66](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L66) +[chain/chain.ts:66](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L66) diff --git a/packages/nibijs/docs/classes/MsgFactory.md b/packages/nibijs/docs/classes/MsgFactory.md index b7111580..30e2ddf6 100644 --- a/packages/nibijs/docs/classes/MsgFactory.md +++ b/packages/nibijs/docs/classes/MsgFactory.md @@ -27,9 +27,9 @@ #### Defined in -[msg/index.ts:6](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/index.ts#L6) +[msg/index.ts:6](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/index.ts#L6) ---- +___ ### spot @@ -37,4 +37,4 @@ #### Defined in -[msg/index.ts:5](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/index.ts#L5) +[msg/index.ts:5](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/index.ts#L5) diff --git a/packages/nibijs/docs/classes/NibiruQueryClient.md b/packages/nibijs/docs/classes/NibiruQueryClient.md index 6c9cfa6f..583a33ab 100644 --- a/packages/nibijs/docs/classes/NibiruQueryClient.md +++ b/packages/nibijs/docs/classes/NibiruQueryClient.md @@ -33,11 +33,11 @@ #### Parameters -| Name | Type | -| :----------- | :---------------------- | -| `tmClient` | `Tendermint37Client` | -| `options` | `StargateClientOptions` | -| `wasmClient` | `CosmWasmClient` | +| Name | Type | +| :------ | :------ | +| `tmClient` | `Tendermint37Client` | +| `options` | `StargateClientOptions` | +| `wasmClient` | `CosmWasmClient` | #### Overrides @@ -45,7 +45,7 @@ StargateClient.constructor #### Defined in -[query/query.ts:56](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/query.ts#L56) +[query/query.ts:56](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/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/3e4aac2/packages/nibijs/src/query/query.ts#L44) +[query/query.ts:44](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/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/3e4aac2/packages/nibijs/src/query/query.ts#L45) +[query/query.ts:45](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/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/3e4aac2/packages/nibijs/src/query/query.ts#L80) +[query/query.ts:80](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/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/3e4aac2/packages/nibijs/src/query/query.ts#L88) +[query/query.ts:88](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/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/3e4aac2/packages/nibijs/src/query/query.ts#L47) +[query/query.ts:47](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/query.ts#L47) diff --git a/packages/nibijs/docs/classes/NibiruSigningClient.md b/packages/nibijs/docs/classes/NibiruSigningClient.md index 9864c252..dec30196 100644 --- a/packages/nibijs/docs/classes/NibiruSigningClient.md +++ b/packages/nibijs/docs/classes/NibiruSigningClient.md @@ -33,12 +33,12 @@ #### Parameters -| Name | Type | -| :--------- | :----------------------------- | -| `tmClient` | `Tendermint37Client` | -| `signer` | `OfflineSigner` | -| `options` | `SigningStargateClientOptions` | -| `wasm` | `SigningCosmWasmClient` | +| Name | Type | +| :------ | :------ | +| `tmClient` | `Tendermint37Client` | +| `signer` | `OfflineSigner` | +| `options` | `SigningStargateClientOptions` | +| `wasm` | `SigningCosmWasmClient` | #### Overrides @@ -46,7 +46,7 @@ SigningStargateClient.constructor #### Defined in -[tx/signingClient.ts:41](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signingClient.ts#L41) +[tx/signingClient.ts:41](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signingClient.ts#L41) ## Properties @@ -56,9 +56,9 @@ SigningStargateClient.constructor #### Defined in -[tx/signingClient.ts:38](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signingClient.ts#L38) +[tx/signingClient.ts:38](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signingClient.ts#L38) ---- +___ ### wasmClient @@ -66,7 +66,7 @@ SigningStargateClient.constructor #### Defined in -[tx/signingClient.ts:39](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signingClient.ts#L39) +[tx/signingClient.ts:39](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signingClient.ts#L39) ## 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:94](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signingClient.ts#L94) +[tx/signingClient.ts:94](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signingClient.ts#L94) ---- +___ ### waitForNextBlock @@ -100,9 +100,9 @@ SigningStargateClient.constructor #### Defined in -[tx/signingClient.ts:102](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signingClient.ts#L102) +[tx/signingClient.ts:102](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signingClient.ts#L102) ---- +___ ### 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:66](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signingClient.ts#L66) +[tx/signingClient.ts:66](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signingClient.ts#L66) diff --git a/packages/nibijs/docs/classes/PerpMsgFactory.md b/packages/nibijs/docs/classes/PerpMsgFactory.md index b90639e5..09b86ecd 100644 --- a/packages/nibijs/docs/classes/PerpMsgFactory.md +++ b/packages/nibijs/docs/classes/PerpMsgFactory.md @@ -41,8 +41,8 @@ Returns a 'TxMessage' for adding margin to a position #### Parameters -| Name | Type | Description | -| :---- | :------------- | :-------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `msg` | `MsgAddMargin` | Message to add margin | #### Returns @@ -55,9 +55,9 @@ Returns a 'TxMessage' for adding margin to a position #### Defined in -[msg/perp.ts:124](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L124) +[msg/perp.ts:124](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L124) ---- +___ ### closePosition @@ -65,8 +65,8 @@ Returns a 'TxMessage' for adding margin to a position #### Parameters -| Name | Type | -| :---- | :----------------- | +| Name | Type | +| :------ | :------ | | `msg` | `MsgClosePosition` | #### Returns @@ -75,9 +75,9 @@ Returns a 'TxMessage' for adding margin to a position #### Defined in -[msg/perp.ts:161](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L161) +[msg/perp.ts:161](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L161) ---- +___ ### donateToPerpEF @@ -85,8 +85,8 @@ Returns a 'TxMessage' for adding margin to a position #### Parameters -| Name | Type | -| :---- | :------------------------- | +| Name | Type | +| :------ | :------ | | `msg` | `MsgDonateToEcosystemFund` | #### Returns @@ -95,9 +95,9 @@ Returns a 'TxMessage' for adding margin to a position #### Defined in -[msg/perp.ts:175](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L175) +[msg/perp.ts:175](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L175) ---- +___ ### liquidate @@ -105,8 +105,8 @@ Returns a 'TxMessage' for adding margin to a position #### Parameters -| Name | Type | -| :---- | :------------------ | +| Name | Type | +| :------ | :------ | | `msg` | `MsgMultiLiquidate` | #### Returns @@ -115,9 +115,9 @@ Returns a 'TxMessage' for adding margin to a position #### Defined in -[msg/perp.ts:131](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L131) +[msg/perp.ts:131](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L131) ---- +___ ### openPosition @@ -125,15 +125,15 @@ Returns a 'TxMessage' for adding margin to a position #### Parameters -| Name | Type | -| :-------------------------- | :-------- | -| `msg` | `Object` | -| `msg.baseAssetAmountLimit?` | `number` | -| `msg.goLong` | `boolean` | -| `msg.leverage` | `number` | -| `msg.pair` | `string` | -| `msg.quoteAssetAmount` | `number` | -| `msg.sender` | `string` | +| Name | Type | +| :------ | :------ | +| `msg` | `Object` | +| `msg.baseAssetAmountLimit?` | `number` | +| `msg.goLong` | `boolean` | +| `msg.leverage` | `number` | +| `msg.pair` | `string` | +| `msg.quoteAssetAmount` | `number` | +| `msg.sender` | `string` | #### Returns @@ -141,9 +141,9 @@ Returns a 'TxMessage' for adding margin to a position #### Defined in -[msg/perp.ts:138](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L138) +[msg/perp.ts:138](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L138) ---- +___ ### partialClosePosition @@ -151,8 +151,8 @@ Returns a 'TxMessage' for adding margin to a position #### Parameters -| Name | Type | -| :---- | :---------------- | +| Name | Type | +| :------ | :------ | | `msg` | `MsgPartialClose` | #### Returns @@ -161,9 +161,9 @@ Returns a 'TxMessage' for adding margin to a position #### Defined in -[msg/perp.ts:168](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L168) +[msg/perp.ts:168](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L168) ---- +___ ### removeMargin @@ -171,8 +171,8 @@ Returns a 'TxMessage' for adding margin to a position #### Parameters -| Name | Type | -| :---- | :---------------- | +| Name | Type | +| :------ | :------ | | `msg` | `MsgRemoveMargin` | #### Returns @@ -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/3e4aac2/packages/nibijs/src/msg/perp.ts#L110) +[msg/perp.ts:110](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L110) diff --git a/packages/nibijs/docs/classes/SpotMsgFactory.md b/packages/nibijs/docs/classes/SpotMsgFactory.md index 4e27b49c..c5eb949a 100644 --- a/packages/nibijs/docs/classes/SpotMsgFactory.md +++ b/packages/nibijs/docs/classes/SpotMsgFactory.md @@ -29,8 +29,8 @@ #### Parameters -| Name | Type | -| :---- | :-------------- | +| Name | Type | +| :------ | :------ | | `msg` | `MsgCreatePool` | #### Returns @@ -39,9 +39,9 @@ #### Defined in -[msg/spot.ts:61](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L61) +[msg/spot.ts:61](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L61) ---- +___ ### exitPool @@ -49,8 +49,8 @@ #### Parameters -| Name | Type | -| :--------------- | :------------ | +| Name | Type | +| :------ | :------ | | `«destructured»` | `MsgExitPool` | #### Returns @@ -59,9 +59,9 @@ #### Defined in -[msg/spot.ts:91](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L91) +[msg/spot.ts:91](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L91) ---- +___ ### joinPool @@ -69,8 +69,8 @@ #### Parameters -| Name | Type | -| :--------------- | :------------ | +| Name | Type | +| :------ | :------ | | `«destructured»` | `MsgJoinPool` | #### Returns @@ -79,9 +79,9 @@ #### Defined in -[msg/spot.ts:74](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L74) +[msg/spot.ts:74](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L74) ---- +___ ### swapAssets @@ -89,8 +89,8 @@ #### Parameters -| Name | Type | -| :--------------- | :-------------- | +| Name | Type | +| :------ | :------ | | `«destructured»` | `MsgSwapAssets` | #### Returns @@ -99,4 +99,4 @@ #### Defined in -[msg/spot.ts:102](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L102) +[msg/spot.ts:102](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L102) diff --git a/packages/nibijs/docs/classes/StableSwap.md b/packages/nibijs/docs/classes/StableSwap.md index cb04d00a..10ca1e49 100644 --- a/packages/nibijs/docs/classes/StableSwap.md +++ b/packages/nibijs/docs/classes/StableSwap.md @@ -46,15 +46,15 @@ Constructor: #### Parameters -| Name | Type | -| :----------------- | :------------ | -| `Amplification` | `BigNumber` | +| Name | Type | +| :------ | :------ | +| `Amplification` | `BigNumber` | | `totalTokenSupply` | `BigNumber`[] | -| `fee` | `BigNumber` | +| `fee` | `BigNumber` | #### Defined in -[stableswap/stableswap.ts:25](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/stableswap/stableswap.ts#L25) +[stableswap/stableswap.ts:25](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/stableswap/stableswap.ts#L25) ## Properties @@ -64,9 +64,9 @@ Constructor: #### Defined in -[stableswap/stableswap.ts:20](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/stableswap/stableswap.ts#L20) +[stableswap/stableswap.ts:20](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/stableswap/stableswap.ts#L20) ---- +___ ### fee @@ -74,9 +74,9 @@ Constructor: #### Defined in -[stableswap/stableswap.ts:23](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/stableswap/stableswap.ts#L23) +[stableswap/stableswap.ts:23](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/stableswap/stableswap.ts#L23) ---- +___ ### totalTokenSupply @@ -84,9 +84,9 @@ Constructor: #### Defined in -[stableswap/stableswap.ts:21](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/stableswap/stableswap.ts#L21) +[stableswap/stableswap.ts:21](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/stableswap/stableswap.ts#L21) ---- +___ ### totalTokensInPool @@ -94,7 +94,7 @@ Constructor: #### Defined in -[stableswap/stableswap.ts:22](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/stableswap/stableswap.ts#L22) +[stableswap/stableswap.ts:22](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/stableswap/stableswap.ts#L22) ## Methods @@ -105,7 +105,7 @@ Constructor: D() D invariant calculation in non-overflowing integer operations iteratively -A _ sum(x_i) _ n**n + D = A _ D _ n**n + D**(n+1) / (n**n \* prod(x_i)) +A * sum(x_i) * n**n + D = A * D * n**n + D**(n+1) / (n**n * prod(x_i)) #### Returns @@ -117,9 +117,9 @@ StableSwap #### Defined in -[stableswap/stableswap.ts:54](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/stableswap/stableswap.ts#L54) +[stableswap/stableswap.ts:54](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/stableswap/stableswap.ts#L54) ---- +___ ### exchange @@ -129,11 +129,11 @@ exchange() runs a theorhetical Curve StableSwap model to determine impact on tok #### Parameters -| Name | Type | -| :---------- | :---------- | -| `fromIndex` | `number` | -| `toIndex` | `number` | -| `dx` | `BigNumber` | +| Name | Type | +| :------ | :------ | +| `fromIndex` | `number` | +| `toIndex` | `number` | +| `dx` | `BigNumber` | #### Returns @@ -145,9 +145,9 @@ StableSwap #### Defined in -[stableswap/stableswap.ts:143](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/stableswap/stableswap.ts#L143) +[stableswap/stableswap.ts:143](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/stableswap/stableswap.ts#L143) ---- +___ ### xp @@ -165,9 +165,9 @@ StableSwap #### Defined in -[stableswap/stableswap.ts:41](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/stableswap/stableswap.ts#L41) +[stableswap/stableswap.ts:41](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/stableswap/stableswap.ts#L41) ---- +___ ### y @@ -178,18 +178,18 @@ y() Calculate x[j] if one makes x[i] = x Done by solving quadratic equation iteratively. -x*1**2 + x1 * (sum' - (A*n**n - 1) * D / (A _ n**n)) = D ** (n+1)/(n \*\* (2 _ n) \_ prod' \* A) -x_1\*\*2 + b\*x_1 = c + x_1**2 + x1 * (sum' - (A*n**n - 1) * D / (A * n**n)) = D ** (n+1)/(n ** (2 * n) * prod' * A) + x_1**2 + b*x_1 = c -x_1 = (x_1\**2 + c) / (2*x_1 + b) + x_1 = (x_1**2 + c) / (2*x_1 + b) #### Parameters -| Name | Type | -| :---------- | :---------- | -| `fromIndex` | `number` | -| `toIndex` | `number` | -| `x` | `BigNumber` | +| Name | Type | +| :------ | :------ | +| `fromIndex` | `number` | +| `toIndex` | `number` | +| `x` | `BigNumber` | #### Returns @@ -201,4 +201,4 @@ StableSwap #### Defined in -[stableswap/stableswap.ts:104](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/stableswap/stableswap.ts#L104) +[stableswap/stableswap.ts:104](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/stableswap/stableswap.ts#L104) diff --git a/packages/nibijs/docs/enums/BECH32_PREFIX.md b/packages/nibijs/docs/enums/BECH32_PREFIX.md index 30502956..a139f161 100644 --- a/packages/nibijs/docs/enums/BECH32_PREFIX.md +++ b/packages/nibijs/docs/enums/BECH32_PREFIX.md @@ -1,86 +1,86 @@ -[NibiJS Documentation - v0.21.42](../intro.md) / [Exports](../modules.md) / BECH32_PREFIX +[NibiJS Documentation - v0.21.42](../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:6](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signer.ts#L6) +[tx/signer.ts:6](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signer.ts#L6) ---- +___ -### 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:8](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signer.ts#L8) +[tx/signer.ts:8](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signer.ts#L8) ---- +___ -### 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:10](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signer.ts#L10) +[tx/signer.ts:10](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signer.ts#L10) ---- +___ ### PUB -• **PUB** = `"nibipub"` +• **PUB** = ``"nibipub"`` PUB defines the Bech32 prefix of an account's public key #### Defined in -[tx/signer.ts:12](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signer.ts#L12) +[tx/signer.ts:12](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signer.ts#L12) ---- +___ -### 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:14](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signer.ts#L14) +[tx/signer.ts:14](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signer.ts#L14) ---- +___ -### 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:16](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signer.ts#L16) +[tx/signer.ts:16](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signer.ts#L16) diff --git a/packages/nibijs/docs/enums/Signer.md b/packages/nibijs/docs/enums/Signer.md index 13d5d1c2..e3db4297 100644 --- a/packages/nibijs/docs/enums/Signer.md +++ b/packages/nibijs/docs/enums/Signer.md @@ -13,18 +13,18 @@ ### Direct -• **Direct** = `"direct"` +• **Direct** = ``"direct"`` #### Defined in -[tx/signer.ts:52](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signer.ts#L52) +[tx/signer.ts:53](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signer.ts#L53) ---- +___ ### Keplr -• **Keplr** = `"keplr"` +• **Keplr** = ``"keplr"`` #### Defined in -[tx/signer.ts:51](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signer.ts#L51) +[tx/signer.ts:52](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signer.ts#L52) diff --git a/packages/nibijs/docs/interfaces/ABCIEvent.md b/packages/nibijs/docs/interfaces/ABCIEvent.md index 84de696f..07a80e26 100644 --- a/packages/nibijs/docs/interfaces/ABCIEvent.md +++ b/packages/nibijs/docs/interfaces/ABCIEvent.md @@ -23,9 +23,9 @@ key-value strings of arbitrary data. #### Defined in -[tx/event.ts:23](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/event.ts#L23) +[tx/event.ts:23](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/event.ts#L23) ---- +___ ### type @@ -33,4 +33,4 @@ key-value strings of arbitrary data. #### Defined in -[tx/event.ts:22](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/event.ts#L22) +[tx/event.ts:22](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/event.ts#L22) diff --git a/packages/nibijs/docs/interfaces/Chain.md b/packages/nibijs/docs/interfaces/Chain.md index c0e8a968..d33bacc6 100644 --- a/packages/nibijs/docs/interfaces/Chain.md +++ b/packages/nibijs/docs/interfaces/Chain.md @@ -38,9 +38,9 @@ chainId: identifier for the chain #### Defined in -[chain/chain.ts:22](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L22) +[chain/chain.ts:22](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L22) ---- +___ ### chainName @@ -50,9 +50,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/3e4aac2/packages/nibijs/src/chain/chain.ts#L24) +[chain/chain.ts:24](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L24) ---- +___ ### endptGrpc @@ -62,9 +62,9 @@ endptGrpc: endpoint for the gRPC gateway. Usually on port 9090. #### Defined in -[chain/chain.ts:20](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L20) +[chain/chain.ts:20](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L20) ---- +___ ### endptRest @@ -74,9 +74,9 @@ endptRest: endpoint for the REST server. Also, the LCD endpoint. #### Defined in -[chain/chain.ts:18](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L18) +[chain/chain.ts:18](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L18) ---- +___ ### endptTm @@ -86,9 +86,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/3e4aac2/packages/nibijs/src/chain/chain.ts#L16) +[chain/chain.ts:16](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L16) ---- +___ ### feeDenom @@ -98,4 +98,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/3e4aac2/packages/nibijs/src/chain/chain.ts#L26) +[chain/chain.ts:26](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L26) diff --git a/packages/nibijs/docs/interfaces/ChainIdParts.md b/packages/nibijs/docs/interfaces/ChainIdParts.md index 718402ee..2d1a62e6 100644 --- a/packages/nibijs/docs/interfaces/ChainIdParts.md +++ b/packages/nibijs/docs/interfaces/ChainIdParts.md @@ -18,9 +18,9 @@ #### Defined in -[chain/chain.ts:32](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L32) +[chain/chain.ts:32](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L32) ---- +___ ### prefix @@ -28,9 +28,9 @@ #### Defined in -[chain/chain.ts:30](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L30) +[chain/chain.ts:30](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L30) ---- +___ ### shortName @@ -38,4 +38,4 @@ #### Defined in -[chain/chain.ts:31](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L31) +[chain/chain.ts:31](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L31) diff --git a/packages/nibijs/docs/interfaces/EpochsExtension.md b/packages/nibijs/docs/interfaces/EpochsExtension.md index 9bd57ef3..58353a33 100644 --- a/packages/nibijs/docs/interfaces/EpochsExtension.md +++ b/packages/nibijs/docs/interfaces/EpochsExtension.md @@ -12,8 +12,8 @@ ### epochs -• `Readonly` **epochs**: `Readonly`<{ `currentEpoch`: (`args`: { `identifier`: `string` }) => `Promise`<`QueryCurrentEpochResponse`\> ; `epochsInfo`: () => `Promise`<`QueryEpochsInfoResponse`\> }\> +• `Readonly` **epochs**: `Readonly`<{ `currentEpoch`: (`args`: { `identifier`: `string` }) => `Promise`<`QueryCurrentEpochResponse`\> ; `epochsInfo`: () => `Promise`<`QueryEpochsInfoResponse`\> }\> #### Defined in -[query/epochs.ts:11](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/epochs.ts#L11) +[query/epochs.ts:11](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/epochs.ts#L11) diff --git a/packages/nibijs/docs/interfaces/EventAttribute.md b/packages/nibijs/docs/interfaces/EventAttribute.md index 996eb6c4..06b30a5f 100644 --- a/packages/nibijs/docs/interfaces/EventAttribute.md +++ b/packages/nibijs/docs/interfaces/EventAttribute.md @@ -19,9 +19,9 @@ EventAttribute: A single key-value pair of event data for an ABCI event. #### Defined in -[tx/event.ts:5](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/event.ts#L5) +[tx/event.ts:5](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/event.ts#L5) ---- +___ ### value @@ -29,4 +29,4 @@ EventAttribute: A single key-value pair of event data for an ABCI event. #### Defined in -[tx/event.ts:6](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/event.ts#L6) +[tx/event.ts:6](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/event.ts#L6) diff --git a/packages/nibijs/docs/interfaces/EventMap.md b/packages/nibijs/docs/interfaces/EventMap.md index 22044e6a..e1244ad5 100644 --- a/packages/nibijs/docs/interfaces/EventMap.md +++ b/packages/nibijs/docs/interfaces/EventMap.md @@ -41,4 +41,4 @@ export interface EventTransfer extends EventMap { #### Defined in -[tx/event.ts:41](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/event.ts#L41) +[tx/event.ts:41](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/event.ts#L41) diff --git a/packages/nibijs/docs/interfaces/InflationExtension.md b/packages/nibijs/docs/interfaces/InflationExtension.md index 95d18be3..9bca4518 100644 --- a/packages/nibijs/docs/interfaces/InflationExtension.md +++ b/packages/nibijs/docs/interfaces/InflationExtension.md @@ -12,8 +12,8 @@ ### inflation -• `Readonly` **inflation**: `Readonly`<{ `circulatingSupply`: () => `Promise`<`QueryCirculatingSupplyResponse`\> ; `epochMintProvision`: () => `Promise`<`QueryEpochMintProvisionResponse`\> ; `inflationRate`: () => `Promise`<`QueryInflationRateResponse`\> ; `params`: () => `Promise`<`QueryParamsResponse`\> ; `period`: () => `Promise`<`QueryPeriodResponse`\> ; `skippedEpochs`: () => `Promise`<`QuerySkippedEpochsResponse`\> }\> +• `Readonly` **inflation**: `Readonly`<{ `circulatingSupply`: () => `Promise`<`QueryCirculatingSupplyResponse`\> ; `epochMintProvision`: () => `Promise`<`QueryEpochMintProvisionResponse`\> ; `inflationRate`: () => `Promise`<`QueryInflationRateResponse`\> ; `params`: () => `Promise`<`QueryParamsResponse`\> ; `period`: () => `Promise`<`QueryPeriodResponse`\> ; `skippedEpochs`: () => `Promise`<`QuerySkippedEpochsResponse`\> }\> #### Defined in -[query/inflation.ts:19](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/inflation.ts#L19) +[query/inflation.ts:19](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/inflation.ts#L19) diff --git a/packages/nibijs/docs/interfaces/MsgAddMarginEncodeObject.md b/packages/nibijs/docs/interfaces/MsgAddMarginEncodeObject.md index a0a89cbf..08fb8feb 100644 --- a/packages/nibijs/docs/interfaces/MsgAddMarginEncodeObject.md +++ b/packages/nibijs/docs/interfaces/MsgAddMarginEncodeObject.md @@ -27,9 +27,9 @@ EncodeObject.typeUrl #### Defined in -[msg/perp.ts:37](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L37) +[msg/perp.ts:37](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L37) ---- +___ ### value @@ -41,4 +41,4 @@ EncodeObject.value #### Defined in -[msg/perp.ts:38](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L38) +[msg/perp.ts:38](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L38) diff --git a/packages/nibijs/docs/interfaces/MsgClosePositionEncodeObject.md b/packages/nibijs/docs/interfaces/MsgClosePositionEncodeObject.md index b34b87a4..a8354d0d 100644 --- a/packages/nibijs/docs/interfaces/MsgClosePositionEncodeObject.md +++ b/packages/nibijs/docs/interfaces/MsgClosePositionEncodeObject.md @@ -27,9 +27,9 @@ EncodeObject.typeUrl #### Defined in -[msg/perp.ts:73](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L73) +[msg/perp.ts:73](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L73) ---- +___ ### value @@ -41,4 +41,4 @@ EncodeObject.value #### Defined in -[msg/perp.ts:74](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L74) +[msg/perp.ts:74](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L74) diff --git a/packages/nibijs/docs/interfaces/MsgCreatePoolEncodeObject.md b/packages/nibijs/docs/interfaces/MsgCreatePoolEncodeObject.md index b9323d2d..5bfcd2b9 100644 --- a/packages/nibijs/docs/interfaces/MsgCreatePoolEncodeObject.md +++ b/packages/nibijs/docs/interfaces/MsgCreatePoolEncodeObject.md @@ -27,9 +27,9 @@ EncodeObject.typeUrl #### Defined in -[msg/spot.ts:27](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L27) +[msg/spot.ts:27](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L27) ---- +___ ### value @@ -41,4 +41,4 @@ EncodeObject.value #### Defined in -[msg/spot.ts:28](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L28) +[msg/spot.ts:28](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L28) diff --git a/packages/nibijs/docs/interfaces/MsgDonateToEcosystemFundEncodeObject.md b/packages/nibijs/docs/interfaces/MsgDonateToEcosystemFundEncodeObject.md index 64eb6aed..b69f1fb1 100644 --- a/packages/nibijs/docs/interfaces/MsgDonateToEcosystemFundEncodeObject.md +++ b/packages/nibijs/docs/interfaces/MsgDonateToEcosystemFundEncodeObject.md @@ -27,9 +27,9 @@ EncodeObject.typeUrl #### Defined in -[msg/perp.ts:82](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L82) +[msg/perp.ts:82](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L82) ---- +___ ### value @@ -41,4 +41,4 @@ EncodeObject.value #### Defined in -[msg/perp.ts:83](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L83) +[msg/perp.ts:83](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L83) diff --git a/packages/nibijs/docs/interfaces/MsgExitPoolEncodeObject.md b/packages/nibijs/docs/interfaces/MsgExitPoolEncodeObject.md index a7ea6378..fbad139a 100644 --- a/packages/nibijs/docs/interfaces/MsgExitPoolEncodeObject.md +++ b/packages/nibijs/docs/interfaces/MsgExitPoolEncodeObject.md @@ -27,9 +27,9 @@ EncodeObject.typeUrl #### Defined in -[msg/spot.ts:43](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L43) +[msg/spot.ts:43](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L43) ---- +___ ### value @@ -41,4 +41,4 @@ EncodeObject.value #### Defined in -[msg/spot.ts:44](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L44) +[msg/spot.ts:44](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L44) diff --git a/packages/nibijs/docs/interfaces/MsgJoinPoolEncodeObject.md b/packages/nibijs/docs/interfaces/MsgJoinPoolEncodeObject.md index 96c4824e..66c1315f 100644 --- a/packages/nibijs/docs/interfaces/MsgJoinPoolEncodeObject.md +++ b/packages/nibijs/docs/interfaces/MsgJoinPoolEncodeObject.md @@ -27,9 +27,9 @@ EncodeObject.typeUrl #### Defined in -[msg/spot.ts:35](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L35) +[msg/spot.ts:35](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L35) ---- +___ ### value @@ -41,4 +41,4 @@ EncodeObject.value #### Defined in -[msg/spot.ts:36](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L36) +[msg/spot.ts:36](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L36) diff --git a/packages/nibijs/docs/interfaces/MsgMultiLiquidateEncodeObject.md b/packages/nibijs/docs/interfaces/MsgMultiLiquidateEncodeObject.md index 76f3fcae..146f9f74 100644 --- a/packages/nibijs/docs/interfaces/MsgMultiLiquidateEncodeObject.md +++ b/packages/nibijs/docs/interfaces/MsgMultiLiquidateEncodeObject.md @@ -27,9 +27,9 @@ EncodeObject.typeUrl #### Defined in -[msg/perp.ts:55](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L55) +[msg/perp.ts:55](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L55) ---- +___ ### value @@ -41,4 +41,4 @@ EncodeObject.value #### Defined in -[msg/perp.ts:56](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L56) +[msg/perp.ts:56](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L56) diff --git a/packages/nibijs/docs/interfaces/MsgOpenPositionEncodeObject.md b/packages/nibijs/docs/interfaces/MsgOpenPositionEncodeObject.md index 7b7e51f5..0cb43a03 100644 --- a/packages/nibijs/docs/interfaces/MsgOpenPositionEncodeObject.md +++ b/packages/nibijs/docs/interfaces/MsgOpenPositionEncodeObject.md @@ -27,9 +27,9 @@ EncodeObject.typeUrl #### Defined in -[msg/perp.ts:64](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L64) +[msg/perp.ts:64](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L64) ---- +___ ### value @@ -41,4 +41,4 @@ EncodeObject.value #### Defined in -[msg/perp.ts:65](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L65) +[msg/perp.ts:65](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L65) diff --git a/packages/nibijs/docs/interfaces/MsgPartialCloseEncodeObject.md b/packages/nibijs/docs/interfaces/MsgPartialCloseEncodeObject.md index 24eab696..083bbb26 100644 --- a/packages/nibijs/docs/interfaces/MsgPartialCloseEncodeObject.md +++ b/packages/nibijs/docs/interfaces/MsgPartialCloseEncodeObject.md @@ -27,9 +27,9 @@ EncodeObject.typeUrl #### Defined in -[msg/perp.ts:93](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L93) +[msg/perp.ts:93](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L93) ---- +___ ### value @@ -41,4 +41,4 @@ EncodeObject.value #### Defined in -[msg/perp.ts:94](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L94) +[msg/perp.ts:94](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L94) diff --git a/packages/nibijs/docs/interfaces/MsgRemoveMarginEncodeObject.md b/packages/nibijs/docs/interfaces/MsgRemoveMarginEncodeObject.md index bea8474e..ff3e3a7d 100644 --- a/packages/nibijs/docs/interfaces/MsgRemoveMarginEncodeObject.md +++ b/packages/nibijs/docs/interfaces/MsgRemoveMarginEncodeObject.md @@ -27,9 +27,9 @@ EncodeObject.typeUrl #### Defined in -[msg/perp.ts:46](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L46) +[msg/perp.ts:46](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L46) ---- +___ ### value @@ -41,4 +41,4 @@ EncodeObject.value #### Defined in -[msg/perp.ts:47](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L47) +[msg/perp.ts:47](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L47) diff --git a/packages/nibijs/docs/interfaces/MsgSwapAssetsEncodeObject.md b/packages/nibijs/docs/interfaces/MsgSwapAssetsEncodeObject.md index aa876ce6..cb47924e 100644 --- a/packages/nibijs/docs/interfaces/MsgSwapAssetsEncodeObject.md +++ b/packages/nibijs/docs/interfaces/MsgSwapAssetsEncodeObject.md @@ -27,9 +27,9 @@ EncodeObject.typeUrl #### Defined in -[msg/spot.ts:51](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L51) +[msg/spot.ts:51](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L51) ---- +___ ### value @@ -41,4 +41,4 @@ EncodeObject.value #### Defined in -[msg/spot.ts:52](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L52) +[msg/spot.ts:52](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L52) diff --git a/packages/nibijs/docs/interfaces/OracleExtension.md b/packages/nibijs/docs/interfaces/OracleExtension.md index 1b83ead8..892d2738 100644 --- a/packages/nibijs/docs/interfaces/OracleExtension.md +++ b/packages/nibijs/docs/interfaces/OracleExtension.md @@ -12,8 +12,8 @@ ### oracle -• **oracle**: `Readonly`<{ `actives`: () => `Promise`<`QueryActivesResponse`\> ; `aggregatePrevote`: (`oracle`: `string`) => `Promise`<`undefined` \| `AggregateExchangeRatePrevote`\> ; `aggregatePrevotes`: () => `Promise`<`AggregateExchangeRatePrevote`[]\> ; `aggregateVote`: (`oracle`: `string`) => `Promise`<`undefined` \| `AggregateExchangeRateVote`\> ; `aggregateVotes`: () => `Promise`<`AggregateExchangeRateVote`[]\> ; `exchangeRate`: (`pair`: `string`) => `Promise`<`number`\> ; `exchangeRates`: () => `Promise`<`ExchangeRatesMap`\> ; `feeder`: (`oracle`: `string`) => `Promise`<`string`\> ; `missCount`: (`oracle`: `string`) => `Promise`<`number`\> ; `params`: () => `Promise`<`QueryParamsResponse`\> ; `voteTargets`: () => `Promise`<`string`[]\> }\> +• **oracle**: `Readonly`<{ `actives`: () => `Promise`<`QueryActivesResponse`\> ; `aggregatePrevote`: (`oracle`: `string`) => `Promise`<`undefined` \| `AggregateExchangeRatePrevote`\> ; `aggregatePrevotes`: () => `Promise`<`AggregateExchangeRatePrevote`[]\> ; `aggregateVote`: (`oracle`: `string`) => `Promise`<`undefined` \| `AggregateExchangeRateVote`\> ; `aggregateVotes`: () => `Promise`<`AggregateExchangeRateVote`[]\> ; `exchangeRate`: (`pair`: `string`) => `Promise`<`number`\> ; `exchangeRates`: () => `Promise`<`ExchangeRatesMap`\> ; `feeder`: (`oracle`: `string`) => `Promise`<`string`\> ; `missCount`: (`oracle`: `string`) => `Promise`<`number`\> ; `params`: () => `Promise`<`QueryParamsResponse`\> ; `voteTargets`: () => `Promise`<`string`[]\> }\> #### Defined in -[query/oracle.ts:37](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/oracle.ts#L37) +[query/oracle.ts:37](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/oracle.ts#L37) diff --git a/packages/nibijs/docs/interfaces/PageRequest.md b/packages/nibijs/docs/interfaces/PageRequest.md index 935d48a0..f669f251 100644 --- a/packages/nibijs/docs/interfaces/PageRequest.md +++ b/packages/nibijs/docs/interfaces/PageRequest.md @@ -27,16 +27,16 @@ PageRequest • **countTotal**: `boolean` -count_total is set to true to indicate that the result set should include +count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. #### Defined in -[query/spot.ts:252](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/spot.ts#L252) +[query/spot.ts:252](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/spot.ts#L252) ---- +___ ### key @@ -48,9 +48,9 @@ should be set. #### Defined in -[query/spot.ts:234](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/spot.ts#L234) +[query/spot.ts:234](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/spot.ts#L234) ---- +___ ### limit @@ -61,9 +61,9 @@ If left empty it will default to a value to be set by each app. #### Defined in -[query/spot.ts:245](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/spot.ts#L245) +[query/spot.ts:245](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/spot.ts#L245) ---- +___ ### offset @@ -75,9 +75,9 @@ be set. #### Defined in -[query/spot.ts:240](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/spot.ts#L240) +[query/spot.ts:240](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/spot.ts#L240) ---- +___ ### reverse @@ -89,4 +89,4 @@ Since: cosmos-sdk 0.43 #### Defined in -[query/spot.ts:258](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/spot.ts#L258) +[query/spot.ts:258](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/spot.ts#L258) diff --git a/packages/nibijs/docs/interfaces/PerpExtension.md b/packages/nibijs/docs/interfaces/PerpExtension.md index e4aa7d90..f77dd74d 100644 --- a/packages/nibijs/docs/interfaces/PerpExtension.md +++ b/packages/nibijs/docs/interfaces/PerpExtension.md @@ -12,8 +12,8 @@ ### perp -• **perp**: `Readonly`<{ `markets`: () => `Promise`<`QueryMarketsResponse`\> ; `moduleAccounts`: () => `Promise`<`QueryModuleAccountsResponse`\> ; `position`: (`args`: { `pair`: `string` ; `trader`: `string` }) => `Promise`<`QueryPositionResponse`\> ; `positions`: (`args`: { `trader`: `string` }) => `Promise`<`QueryPositionsResponse`\> }\> +• **perp**: `Readonly`<{ `markets`: () => `Promise`<`QueryMarketsResponse`\> ; `moduleAccounts`: () => `Promise`<`QueryModuleAccountsResponse`\> ; `position`: (`args`: { `pair`: `string` ; `trader`: `string` }) => `Promise`<`QueryPositionResponse`\> ; `positions`: (`args`: { `trader`: `string` }) => `Promise`<`QueryPositionsResponse`\> }\> #### Defined in -[query/perp.ts:24](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/perp.ts#L24) +[query/perp.ts:24](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/perp.ts#L24) diff --git a/packages/nibijs/docs/interfaces/SpotExtension.md b/packages/nibijs/docs/interfaces/SpotExtension.md index 1b0e5047..6d78be19 100644 --- a/packages/nibijs/docs/interfaces/SpotExtension.md +++ b/packages/nibijs/docs/interfaces/SpotExtension.md @@ -12,8 +12,8 @@ ### spot -• **spot**: `Readonly`<{ `estimateExitExactAmountIn`: (`poolId`: `number`, `poolSharesIn`: `number`) => `Promise`<`QueryExitExactAmountInResponse`\> ; `estimateExitExactAmountOut`: (`poolId`: `number`) => `Promise`<`QueryExitExactAmountOutResponse`\> ; `estimateJoinExactAmountIn`: (`poolId`: `number`, `tokensIn`: `Coin`[]) => `Promise`<`QueryJoinExactAmountInResponse`\> ; `estimateJoinExactAmountOut`: (`poolId`: `number`) => `Promise`<`QueryJoinExactAmountOutResponse`\> ; `estimateSwapExactAmountIn`: (`poolId`: `number`, `tokenOutDenom`: `string`, `tokenIn?`: `Coin`) => `Promise`<`QuerySwapExactAmountInResponse`\> ; `estimateSwapExactAmountOut`: (`poolId`: `number`, `tokenInDenom`: `string`, `tokenOut?`: `Coin`) => `Promise`<`QuerySwapExactAmountOutResponse`\> ; `numPools`: () => `Promise`<`QueryNumPoolsResponse`\> ; `params`: () => `Promise`<`QueryParamsResponse`\> ; `pool`: (`poolId`: `number`) => `Promise`<`QueryPoolResponse`\> ; `poolNumber`: () => `Promise`<`QueryPoolNumberResponse`\> ; `poolParams`: (`poolId`: `number`) => `Promise`<`QueryPoolParamsResponse`\> ; `pools`: (`pagination?`: [`PageRequest`](PageRequest.md)) => `Promise`<`QueryPoolsResponse`\> ; `spotPrice`: (`poolId`: `number`, `tokenInDenom`: `string`, `tokenOutDenom`: `string`) => `Promise`<`QuerySpotPriceResponse`\> ; `totalLiquidity`: () => `Promise`<`QueryTotalLiquidityResponse`\> ; `totalPoolLiquidity`: (`poolId`: `number`) => `Promise`<`QueryTotalPoolLiquidityResponse`\> ; `totalShares`: (`poolId`: `number`) => `Promise`<`QueryTotalSharesResponse`\> }\> +• **spot**: `Readonly`<{ `estimateExitExactAmountIn`: (`poolId`: `number`, `poolSharesIn`: `number`) => `Promise`<`QueryExitExactAmountInResponse`\> ; `estimateExitExactAmountOut`: (`poolId`: `number`) => `Promise`<`QueryExitExactAmountOutResponse`\> ; `estimateJoinExactAmountIn`: (`poolId`: `number`, `tokensIn`: `Coin`[]) => `Promise`<`QueryJoinExactAmountInResponse`\> ; `estimateJoinExactAmountOut`: (`poolId`: `number`) => `Promise`<`QueryJoinExactAmountOutResponse`\> ; `estimateSwapExactAmountIn`: (`poolId`: `number`, `tokenOutDenom`: `string`, `tokenIn?`: `Coin`) => `Promise`<`QuerySwapExactAmountInResponse`\> ; `estimateSwapExactAmountOut`: (`poolId`: `number`, `tokenInDenom`: `string`, `tokenOut?`: `Coin`) => `Promise`<`QuerySwapExactAmountOutResponse`\> ; `numPools`: () => `Promise`<`QueryNumPoolsResponse`\> ; `params`: () => `Promise`<`QueryParamsResponse`\> ; `pool`: (`poolId`: `number`) => `Promise`<`QueryPoolResponse`\> ; `poolNumber`: () => `Promise`<`QueryPoolNumberResponse`\> ; `poolParams`: (`poolId`: `number`) => `Promise`<`QueryPoolParamsResponse`\> ; `pools`: (`pagination?`: [`PageRequest`](PageRequest.md)) => `Promise`<`QueryPoolsResponse`\> ; `spotPrice`: (`poolId`: `number`, `tokenInDenom`: `string`, `tokenOutDenom`: `string`) => `Promise`<`QuerySpotPriceResponse`\> ; `totalLiquidity`: () => `Promise`<`QueryTotalLiquidityResponse`\> ; `totalPoolLiquidity`: (`poolId`: `number`) => `Promise`<`QueryTotalPoolLiquidityResponse`\> ; `totalShares`: (`poolId`: `number`) => `Promise`<`QueryTotalSharesResponse`\> }\> #### Defined in -[query/spot.ts:58](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/spot.ts#L58) +[query/spot.ts:58](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/spot.ts#L58) diff --git a/packages/nibijs/docs/interfaces/SudoExtension.md b/packages/nibijs/docs/interfaces/SudoExtension.md index 38fa1894..eace6f6e 100644 --- a/packages/nibijs/docs/interfaces/SudoExtension.md +++ b/packages/nibijs/docs/interfaces/SudoExtension.md @@ -12,8 +12,8 @@ ### sudo -• `Readonly` **sudo**: `Readonly`<{ `querySudoers`: () => `Promise`<`QuerySudoersResponse`\> }\> +• `Readonly` **sudo**: `Readonly`<{ `querySudoers`: () => `Promise`<`QuerySudoersResponse`\> }\> #### Defined in -[query/sudo.ts:9](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/sudo.ts#L9) +[query/sudo.ts:9](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/sudo.ts#L9) diff --git a/packages/nibijs/docs/interfaces/TxLog.md b/packages/nibijs/docs/interfaces/TxLog.md index bffaaee1..c5594439 100644 --- a/packages/nibijs/docs/interfaces/TxLog.md +++ b/packages/nibijs/docs/interfaces/TxLog.md @@ -16,4 +16,4 @@ #### Defined in -[chain/types.ts:37](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/types.ts#L37) +[chain/types.ts:37](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/types.ts#L37) diff --git a/packages/nibijs/docs/modules.md b/packages/nibijs/docs/modules.md index cd81788c..eefa3198 100644 --- a/packages/nibijs/docs/modules.md +++ b/packages/nibijs/docs/modules.md @@ -6,7 +6,7 @@ ### Enumerations -- [BECH32_PREFIX](enums/BECH32_PREFIX.md) +- [BECH32\_PREFIX](enums/BECH32_PREFIX.md) - [Signer](enums/Signer.md) ### Classes @@ -56,11 +56,11 @@ ### 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) +- [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) @@ -115,19 +115,19 @@ #### Defined in -[query/query.ts:29](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/query.ts#L29) +[query/query.ts:29](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/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/3e4aac2/packages/nibijs/src/chain/parse.ts#L2) +[chain/parse.ts:2](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/parse.ts#L2) ---- +___ ### Localnet @@ -135,9 +135,9 @@ #### Defined in -[chain/chain.ts:82](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L82) +[chain/chain.ts:82](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L82) ---- +___ ### Msg @@ -145,50 +145,50 @@ #### Defined in -[msg/index.ts:9](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/index.ts#L9) +[msg/index.ts:9](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/index.ts#L9) ---- +___ -### PERP_MSG_TYPE_URLS +### PERP\_MSG\_TYPE\_URLS -• `Const` **PERP_MSG_TYPE_URLS**: `Object` +• `Const` **PERP\_MSG\_TYPE\_URLS**: `Object` #### Type declaration -| Name | Type | -| :------------------------- | :------- | -| `MsgAddMargin` | `string` | -| `MsgClosePosition` | `string` | +| Name | Type | +| :------ | :------ | +| `MsgAddMargin` | `string` | +| `MsgClosePosition` | `string` | | `MsgDonateToEcosystemFund` | `string` | -| `MsgMarketOrder` | `string` | -| `MsgMultiLiquidate` | `string` | -| `MsgPartialClose` | `string` | -| `MsgRemoveMargin` | `string` | +| `MsgMarketOrder` | `string` | +| `MsgMultiLiquidate` | `string` | +| `MsgPartialClose` | `string` | +| `MsgRemoveMargin` | `string` | #### Defined in -[msg/perp.ts:16](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L16) +[msg/perp.ts:16](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L16) ---- +___ -### SPOT_MSG_TYPE_URLS +### SPOT\_MSG\_TYPE\_URLS -• `Const` **SPOT_MSG_TYPE_URLS**: `Object` +• `Const` **SPOT\_MSG\_TYPE\_URLS**: `Object` #### Type declaration -| Name | Type | -| :-------------- | :------- | +| Name | Type | +| :------ | :------ | | `MsgCreatePool` | `string` | -| `MsgExitPool` | `string` | -| `MsgJoinPool` | `string` | +| `MsgExitPool` | `string` | +| `MsgJoinPool` | `string` | | `MsgSwapAssets` | `string` | #### Defined in -[msg/spot.ts:12](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L12) +[msg/spot.ts:12](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L12) ---- +___ ### nibiruRegistryTypes @@ -196,9 +196,9 @@ #### Defined in -[tx/signingClient.ts:31](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signingClient.ts#L31) +[tx/signingClient.ts:31](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signingClient.ts#L31) ---- +___ ### perpTypes @@ -206,9 +206,9 @@ #### Defined in -[msg/perp.ts:26](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L26) +[msg/perp.ts:26](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L26) ---- +___ ### spotTypes @@ -216,7 +216,7 @@ #### Defined in -[msg/spot.ts:19](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L19) +[msg/spot.ts:19](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L19) ## Functions @@ -226,8 +226,8 @@ #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `chainNumber` | `number` | #### Returns @@ -236,9 +236,9 @@ #### Defined in -[chain/chain.ts:98](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L98) +[chain/chain.ts:98](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L98) ---- +___ ### IncentivizedTestnet @@ -246,8 +246,8 @@ #### Parameters -| Name | Type | -| :------------ | :------- | +| Name | Type | +| :------ | :------ | | `chainNumber` | `number` | #### Returns @@ -256,30 +256,30 @@ #### Defined in -[chain/chain.ts:91](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L91) +[chain/chain.ts:91](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L91) ---- +___ ### assert -▸ **assert**(`condition`, `message?`): `string` \| `true` +▸ **assert**(`condition`, `message?`): `string` \| ``true`` #### Parameters -| Name | Type | -| :---------- | :-------- | +| Name | Type | +| :------ | :------ | | `condition` | `boolean` | -| `message?` | `string` | +| `message?` | `string` | #### Returns -`string` \| `true` +`string` \| ``true`` #### Defined in -[chain/types.ts:14](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/types.ts#L14) +[chain/types.ts:14](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/types.ts#L14) ---- +___ ### chainToParts @@ -289,8 +289,8 @@ Converts a Chain object to its constituent parts. #### Parameters -| Name | Type | Description | -| :------ | :----------------------------- | :------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `chain` | [`Chain`](interfaces/Chain.md) | a Chain object | #### Returns @@ -301,9 +301,9 @@ a ChainIdParts object #### Defined in -[chain/chain.ts:129](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L129) +[chain/chain.ts:129](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L129) ---- +___ ### eventToMap @@ -313,8 +313,8 @@ eventToMap: Converts an ABCIEvent into an EventMap. #### Parameters -| Name | Type | -| :------ | :------------------------------------- | +| Name | Type | +| :------ | :------ | | `event` | [`ABCIEvent`](interfaces/ABCIEvent.md) | #### Returns @@ -323,9 +323,9 @@ eventToMap: Converts an ABCIEvent into an EventMap. #### Defined in -[tx/event.ts:44](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/event.ts#L44) +[tx/event.ts:44](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/event.ts#L44) ---- +___ ### faucetUrlFromChain @@ -335,8 +335,8 @@ Constructs a faucet URL from a Chain object. #### Parameters -| Name | Type | Description | -| :------ | :----------------------------- | :------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `chain` | [`Chain`](interfaces/Chain.md) | a Chain object | #### Returns @@ -345,9 +345,9 @@ Constructs a faucet URL from a Chain object. #### Defined in -[chain/useFaucet.ts:59](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/useFaucet.ts#L59) +[chain/useFaucet.ts:59](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/useFaucet.ts#L59) ---- +___ ### findEvent @@ -358,10 +358,10 @@ events of known type are present. #### Parameters -| Name | Type | -| :---------- | :--------------------------------------- | -| `events` | [`ABCIEvent`](interfaces/ABCIEvent.md)[] | -| `eventType` | `string` | +| Name | Type | +| :------ | :------ | +| `events` | [`ABCIEvent`](interfaces/ABCIEvent.md)[] | +| `eventType` | `string` | #### Returns @@ -369,9 +369,9 @@ events of known type are present. #### Defined in -[tx/event.ts:54](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/event.ts#L54) +[tx/event.ts:54](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/event.ts#L54) ---- +___ ### fromSdkDec @@ -394,8 +394,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------- | :------- | +| Name | Type | +| :------ | :------ | | `sdkDec` | `string` | #### Returns @@ -404,14 +404,14 @@ the human-readbale Dec. **`See`** -- TxMessage // from nibijs/src/tx -- toSdkDec + - TxMessage // from nibijs/src/tx + - toSdkDec #### Defined in -[chain/parse.ts:113](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/parse.ts#L113) +[chain/parse.ts:113](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/parse.ts#L113) ---- +___ ### fromSdkInt @@ -419,8 +419,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------- | :------- | +| Name | Type | +| :------ | :------ | | `intStr` | `string` | #### Returns @@ -429,9 +429,9 @@ the human-readbale Dec. #### Defined in -[chain/parse.ts:164](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/parse.ts#L164) +[chain/parse.ts:164](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/parse.ts#L164) ---- +___ ### getRegistry @@ -443,35 +443,35 @@ the human-readbale Dec. #### Defined in -[tx/signer.ts:19](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signer.ts#L19) +[tx/signer.ts:19](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signer.ts#L19) ---- +___ ### go -▸ **go**<`T`\>(`promise`): `Promise`<{ `err`: `undefined` = undefined; `res`: `Awaited`<`T`\> } \| { `err`: `string` ; `res`: `undefined` = undefined }\> +▸ **go**<`T`\>(`promise`): `Promise`<{ `err`: `undefined` = undefined; `res`: `Awaited`<`T`\> } \| { `err`: `string` ; `res`: `undefined` = undefined }\> #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | #### Parameters -| Name | Type | -| :-------- | :-------------- | +| Name | Type | +| :------ | :------ | | `promise` | `Promise`<`T`\> | #### Returns -`Promise`<{ `err`: `undefined` = undefined; `res`: `Awaited`<`T`\> } \| { `err`: `string` ; `res`: `undefined` = undefined }\> +`Promise`<{ `err`: `undefined` = undefined; `res`: `Awaited`<`T`\> } \| { `err`: `string` ; `res`: `undefined` = undefined }\> #### Defined in -[chain/types.ts:6](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/types.ts#L6) +[chain/types.ts:6](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/types.ts#L6) ---- +___ ### isMsgAddMarginEncodeObject @@ -479,8 +479,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------------- | :------------- | +| Name | Type | +| :------ | :------ | | `encodeObject` | `EncodeObject` | #### Returns @@ -489,9 +489,9 @@ the human-readbale Dec. #### Defined in -[msg/perp.ts:41](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L41) +[msg/perp.ts:41](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L41) ---- +___ ### isMsgClosePositionEncodeObject @@ -499,8 +499,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------------- | :------------- | +| Name | Type | +| :------ | :------ | | `encodeObject` | `EncodeObject` | #### Returns @@ -509,9 +509,9 @@ the human-readbale Dec. #### Defined in -[msg/perp.ts:77](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L77) +[msg/perp.ts:77](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L77) ---- +___ ### isMsgCreatePoolEncodeObject @@ -519,8 +519,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------------- | :------------- | +| Name | Type | +| :------ | :------ | | `encodeObject` | `EncodeObject` | #### Returns @@ -529,9 +529,9 @@ the human-readbale Dec. #### Defined in -[msg/spot.ts:31](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L31) +[msg/spot.ts:31](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L31) ---- +___ ### isMsgDonateToEcosystemFundEncodeObject @@ -539,8 +539,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------------- | :------------- | +| Name | Type | +| :------ | :------ | | `encodeObject` | `EncodeObject` | #### Returns @@ -549,9 +549,9 @@ the human-readbale Dec. #### Defined in -[msg/perp.ts:86](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L86) +[msg/perp.ts:86](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L86) ---- +___ ### isMsgExitPoolEncodeObject @@ -559,8 +559,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------------- | :------------- | +| Name | Type | +| :------ | :------ | | `encodeObject` | `EncodeObject` | #### Returns @@ -569,9 +569,9 @@ the human-readbale Dec. #### Defined in -[msg/spot.ts:47](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L47) +[msg/spot.ts:47](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L47) ---- +___ ### isMsgJoinPoolEncodeObject @@ -579,8 +579,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------------- | :------------- | +| Name | Type | +| :------ | :------ | | `encodeObject` | `EncodeObject` | #### Returns @@ -589,9 +589,9 @@ the human-readbale Dec. #### Defined in -[msg/spot.ts:39](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L39) +[msg/spot.ts:39](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L39) ---- +___ ### isMsgMultiLiquidateEncodeObject @@ -599,8 +599,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------------- | :------------- | +| Name | Type | +| :------ | :------ | | `encodeObject` | `EncodeObject` | #### Returns @@ -609,9 +609,9 @@ the human-readbale Dec. #### Defined in -[msg/perp.ts:59](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L59) +[msg/perp.ts:59](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L59) ---- +___ ### isMsgOpenPositionEncodeObject @@ -619,8 +619,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------------- | :------------- | +| Name | Type | +| :------ | :------ | | `encodeObject` | `EncodeObject` | #### Returns @@ -629,9 +629,9 @@ the human-readbale Dec. #### Defined in -[msg/perp.ts:68](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L68) +[msg/perp.ts:68](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L68) ---- +___ ### isMsgPartialCloseEncodeObject @@ -639,8 +639,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------------- | :------------- | +| Name | Type | +| :------ | :------ | | `encodeObject` | `EncodeObject` | #### Returns @@ -649,9 +649,9 @@ the human-readbale Dec. #### Defined in -[msg/perp.ts:97](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L97) +[msg/perp.ts:97](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L97) ---- +___ ### isMsgRemoveMarginEncodeObject @@ -659,8 +659,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------------- | :------------- | +| Name | Type | +| :------ | :------ | | `encodeObject` | `EncodeObject` | #### Returns @@ -669,9 +669,9 @@ the human-readbale Dec. #### Defined in -[msg/perp.ts:50](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/perp.ts#L50) +[msg/perp.ts:50](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/perp.ts#L50) ---- +___ ### isMsgSwapAssetsEncodeObject @@ -679,8 +679,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------------- | :------------- | +| Name | Type | +| :------ | :------ | | `encodeObject` | `EncodeObject` | #### Returns @@ -689,9 +689,9 @@ the human-readbale Dec. #### Defined in -[msg/spot.ts:55](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/msg/spot.ts#L55) +[msg/spot.ts:55](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/msg/spot.ts#L55) ---- +___ ### isRestEndptLive @@ -699,8 +699,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------ | :----------------------------- | +| Name | Type | +| :------ | :------ | | `chain` | [`Chain`](interfaces/Chain.md) | #### Returns @@ -709,9 +709,9 @@ the human-readbale Dec. #### Defined in -[chain/chain.ts:119](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L119) +[chain/chain.ts:119](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L119) ---- +___ ### newCoinMapFromCoins @@ -719,8 +719,8 @@ the human-readbale Dec. #### Parameters -| Name | Type | -| :------ | :---------------- | +| Name | Type | +| :------ | :------ | | `coins` | readonly `Coin`[] | #### Returns @@ -729,9 +729,9 @@ the human-readbale Dec. #### Defined in -[chain/types.ts:28](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/types.ts#L28) +[chain/types.ts:28](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/types.ts#L28) ---- +___ ### newRandomWallet @@ -741,10 +741,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 @@ -756,9 +756,9 @@ A wallet for protobuf based signing using SIGN_MODE_DIRECT. #### Defined in -[tx/signer.ts:45](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signer.ts#L45) +[tx/signer.ts:45](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signer.ts#L45) ---- +___ ### newSignerFromMnemonic @@ -768,10 +768,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 @@ -783,9 +783,9 @@ A wallet for protobuf based signing using SIGN_MODE_DIRECT #### Defined in -[tx/signer.ts:29](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/signer.ts#L29) +[tx/signer.ts:29](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/signer.ts#L29) ---- +___ ### parseEventLogs @@ -796,8 +796,8 @@ from a tx response. #### Parameters -| Name | Type | -| :------- | :------------------ | +| Name | Type | +| :------ | :------ | | `txResp` | `DeliverTxResponse` | #### Returns @@ -813,9 +813,9 @@ const eventLogs = parseEventLogs(txResp) #### Defined in -[tx/event.ts:67](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/tx/event.ts#L67) +[tx/event.ts:67](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/tx/event.ts#L67) ---- +___ ### queryChainIdWithRest @@ -823,8 +823,8 @@ const eventLogs = parseEventLogs(txResp) #### Parameters -| Name | Type | -| :------ | :----------------------------- | +| Name | Type | +| :------ | :------ | | `chain` | [`Chain`](interfaces/Chain.md) | #### Returns @@ -833,9 +833,9 @@ const eventLogs = parseEventLogs(txResp) #### Defined in -[chain/chain.ts:105](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/chain.ts#L105) +[chain/chain.ts:105](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/chain.ts#L105) ---- +___ ### setupEpochsExtension @@ -843,8 +843,8 @@ const eventLogs = parseEventLogs(txResp) #### Parameters -| Name | Type | -| :----- | :------------ | +| Name | Type | +| :------ | :------ | | `base` | `QueryClient` | #### Returns @@ -853,9 +853,9 @@ const eventLogs = parseEventLogs(txResp) #### Defined in -[query/epochs.ts:19](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/epochs.ts#L19) +[query/epochs.ts:19](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/epochs.ts#L19) ---- +___ ### setupInflationExtension @@ -863,8 +863,8 @@ const eventLogs = parseEventLogs(txResp) #### Parameters -| Name | Type | -| :----- | :------------ | +| Name | Type | +| :------ | :------ | | `base` | `QueryClient` | #### Returns @@ -873,9 +873,9 @@ const eventLogs = parseEventLogs(txResp) #### Defined in -[query/inflation.ts:29](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/inflation.ts#L29) +[query/inflation.ts:29](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/inflation.ts#L29) ---- +___ ### setupOracleExtension @@ -883,8 +883,8 @@ const eventLogs = parseEventLogs(txResp) #### Parameters -| Name | Type | -| :----- | :------------ | +| Name | Type | +| :------ | :------ | | `base` | `QueryClient` | #### Returns @@ -893,9 +893,9 @@ const eventLogs = parseEventLogs(txResp) #### Defined in -[query/oracle.ts:91](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/oracle.ts#L91) +[query/oracle.ts:91](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/oracle.ts#L91) ---- +___ ### setupPerpExtension @@ -903,8 +903,8 @@ const eventLogs = parseEventLogs(txResp) #### Parameters -| Name | Type | -| :----- | :------------ | +| Name | Type | +| :------ | :------ | | `base` | `QueryClient` | #### Returns @@ -913,9 +913,9 @@ const eventLogs = parseEventLogs(txResp) #### Defined in -[query/perp.ts:45](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/perp.ts#L45) +[query/perp.ts:45](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/perp.ts#L45) ---- +___ ### setupSpotExtension @@ -923,8 +923,8 @@ const eventLogs = parseEventLogs(txResp) #### Parameters -| Name | Type | -| :----- | :------------ | +| Name | Type | +| :------ | :------ | | `base` | `QueryClient` | #### Returns @@ -933,9 +933,9 @@ const eventLogs = parseEventLogs(txResp) #### Defined in -[query/spot.ts:102](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/spot.ts#L102) +[query/spot.ts:102](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/spot.ts#L102) ---- +___ ### setupSudoExtension @@ -943,8 +943,8 @@ const eventLogs = parseEventLogs(txResp) #### Parameters -| Name | Type | -| :----- | :------------ | +| Name | Type | +| :------ | :------ | | `base` | `QueryClient` | #### Returns @@ -953,9 +953,9 @@ const eventLogs = parseEventLogs(txResp) #### Defined in -[query/sudo.ts:14](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/sudo.ts#L14) +[query/sudo.ts:14](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/sudo.ts#L14) ---- +___ ### toSdkDec @@ -969,19 +969,19 @@ provided than the precision, 18. ref: Reimplementation of cosmos-sdk/types/decimal.go Valid inputs must come in the form: -(-) integer digits (.) fractional digits + (-) integer digits (.) fractional digits Examples of acceptable input include: --123.456 -456.7890 -345 --456789 + -123.456 + 456.7890 + 345 + -456789 CONTRACT - This function does not mutate the input str. #### Parameters -| Name | Type | -| :---- | :------- | +| Name | Type | +| :------ | :------ | | `dec` | `string` | #### Returns @@ -989,7 +989,7 @@ CONTRACT - This function does not mutate the input str. `string` - Protobuf string for an sdk.Dec, which is - represented by its underlying "big.Int". +represented by its underlying "big.Int". **`See`** @@ -1000,9 +1000,9 @@ sdk.Dec protobuf string into a number. #### Defined in -[chain/parse.ts:30](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/parse.ts#L30) +[chain/parse.ts:30](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/parse.ts#L30) ---- +___ ### toSdkInt @@ -1010,9 +1010,9 @@ sdk.Dec protobuf string into a number. #### Parameters -| Name | Type | -| :--- | :------- | -| `i` | `number` | +| Name | Type | +| :------ | :------ | +| `i` | `number` | #### Returns @@ -1020,9 +1020,9 @@ sdk.Dec protobuf string into a number. #### Defined in -[chain/parse.ts:162](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/parse.ts#L162) +[chain/parse.ts:162](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/parse.ts#L162) ---- +___ ### transformPool @@ -1030,8 +1030,8 @@ sdk.Dec protobuf string into a number. #### Parameters -| Name | Type | -| :--- | :----- | +| Name | Type | +| :------ | :------ | | `p?` | `Pool` | #### Returns @@ -1040,9 +1040,9 @@ sdk.Dec protobuf string into a number. #### Defined in -[query/spot.ts:49](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/spot.ts#L49) +[query/spot.ts:49](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/spot.ts#L49) ---- +___ ### transformPoolParams @@ -1050,8 +1050,8 @@ sdk.Dec protobuf string into a number. #### Parameters -| Name | Type | -| :---- | :----------- | +| Name | Type | +| :------ | :------ | | `pp?` | `PoolParams` | #### Returns @@ -1060,9 +1060,9 @@ sdk.Dec protobuf string into a number. #### Defined in -[query/spot.ts:41](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/query/spot.ts#L41) +[query/spot.ts:41](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/query/spot.ts#L41) ---- +___ ### useFaucet @@ -1072,16 +1072,16 @@ Sends 11 NIBI, 100 NUSD, and 100 USDT to the given address from the testnet fauc #### Parameters -| Name | Type | -| :--------------- | :----------------------------- | -| `«destructured»` | `Object` | -| › `address` | `string` | -| › `amts?` | `Object` | -| › `amts.nibi` | `number` | -| › `amts.nusd` | `number` | -| › `amts.usdt` | `number` | -| › `chain` | [`Chain`](interfaces/Chain.md) | -| › `grecaptcha` | `string` | +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `address` | `string` | +| › `amts?` | `Object` | +| › `amts.nibi` | `number` | +| › `amts.nusd` | `number` | +| › `amts.usdt` | `number` | +| › `chain` | [`Chain`](interfaces/Chain.md) | +| › `grecaptcha` | `string` | #### Returns @@ -1089,4 +1089,4 @@ Sends 11 NIBI, 100 NUSD, and 100 USDT to the given address from the testnet fauc #### Defined in -[chain/useFaucet.ts:7](https://github.com/NibiruChain/ts-sdk/blob/3e4aac2/packages/nibijs/src/chain/useFaucet.ts#L7) +[chain/useFaucet.ts:7](https://github.com/NibiruChain/ts-sdk/blob/fe5a329/packages/nibijs/src/chain/useFaucet.ts#L7)