Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/neptune service #515

Merged
merged 4 commits into from
Nov 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
193 changes: 97 additions & 96 deletions .gitbook/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,98 +1,99 @@
# Table of contents

* [Getting Started](README.md)
* [Technical Concepts](readme/technical-concepts.md)
* [Application Concepts](readme/application-concepts.md)
* [Assets](readme/assets/README.md)
* [Creating Tokens](readme/assets/creating-tokens.md)
* [Denom Client (deprecated)](readme/assets/denom-client.md)
* [Injective Lists](readme/assets/injective-list.md)
* [Networks](readme/networks.md)
* [CosmJs Support](readme/getting-started-cosmjs.md)
* [Running examples](readme/running-examples.md)
* [Wallet](wallet/README.md)
* [Accounts](wallet/wallet-accounts.md)
* [Wallet Connections](wallet/wallet-connections.md)
* [Wallet Strategy](wallet/wallet-wallet-strategy.md)
* [Offchain (Arbitrary) Data](wallet/offchain-arbitrary-data.md)
* [Querying](querying/README.md)
* [Indexer](querying/querying-api/README.md)
* [Account](querying/querying-api/querying-indexer-account.md)
* [Auction](querying/querying-api/querying-indexer-auction.md)
* [Derivatives](querying/querying-api/querying-indexer-derivatives.md)
* [Explorer](querying/querying-api/querying-indexer-explorer.md)
* [Insurance Funds](querying/querying-api/querying-indexer-insurance-funds.md)
* [Markets](querying/querying-api/querying-indexer-markets.md)
* [Leaderboard](querying/querying-api/querying-indexer-leaderboard.md)
* [Mito](querying/querying-api/querying-indexer-mito.md)
* [Oracle](querying/querying-api/querying-indexer-oracle.md)
* [Portfolio](querying/querying-api/querying-indexer-portfolio.md)
* [Spot](querying/querying-api/querying-indexer-spot.md)
* [Web3Gw Transactions](querying/querying-api/querying-indexer-transaction.md)
* [Streaming](querying/querying-api/streaming/README.md)
* [Account](querying/querying-api/streaming/streaming-indexer-account.md)
* [Auction](querying/querying-api/streaming/streaming-indexer-auction.md)
* [Derivatives](querying/querying-api/streaming/streaming-indexer-derivatives.md)
* [Oracle](querying/querying-api/streaming/streaming-indexer-oracle.md)
* [Portfolio](querying/querying-api/streaming/streaming-indexer-portfolio.md)
* [Spot](querying/querying-api/streaming/streaming-indexer-spot.md)
* [Explorer](querying/querying-api/streaming/streaming-indexer-explorer.md)
* [Chain](querying/querying-chain/README.md)
* [Auction](querying/querying-chain/querying-chain-auction-module.md)
* [Auth](querying/querying-chain/querying-chain-auth-module.md)
* [Bank](querying/querying-chain/querying-chain-bank-module.md)
* [Distribution](querying/querying-chain/querying-chain-distribution.md)
* [Exchange](querying/querying-chain/querying-chain-exchange.md)
* [Governance](querying/querying-chain/querying-chain-governance.md)
* [IBC](querying/querying-chain/querying-chain-ibc.md)
* [Mint](querying/querying-chain/querying-chain-mint.md)
* [Insurance Funds](querying/querying-chain/querying-chain-insurance-funds.md)
* [Oracle](querying/querying-chain/querying-chain-oracle.md)
* [Peggy](querying/querying-chain/querying-chain-peggy.md)
* [Permissions](querying/querying-chain/querying-chain-permissions.md)
* [Staking](querying/querying-chain/querying-chain-staking.md)
* [Tendermint](querying/querying-chain/querying-chain-tendermint.md)
* [Wasm](querying/querying-chain/querying-chain-wasm.md)
* [WasmX](querying/querying-chain/querying-chain-wasmx.md)
* [Token Factory](querying/querying-chain/token-factory.md)
* [Ethereum (GraphQL)](querying/querying-ethereum.md)
* [Transactions](transactions/README.md)
* [Cosmos](transactions/transactions-cosmos/README.md)
* [Ledger through Keplr Wallet](transactions/transactions-cosmos/ledger-through-keplr-wallet.md)
* [Ethereum](transactions/ethereum.md)
* [Ethereum Ledger](transactions/ethereum-ledger.md)
* [MsgBroadcaster](transactions/msgbroadcaster.md)
* [Private Key](transactions/private-key.md)
* [Web3 Gateway](transactions/web3-gateway.md)
* [Core Modules](core-modules/README.md)
* [Auction](core-modules/auction.md)
* [AuthZ](core-modules/authz.md)
* [Bank](core-modules/bank.md)
* [Distribution](core-modules/distribution.md)
* [Exchange](core-modules/exchange.md)
* [Feegrant](core-modules/feegrant.md)
* [Governance](core-modules/governance.md)
* [IBC](core-modules/ibc.md)
* [Insurance](core-modules/insurance.md)
* [Peggy](core-modules/peggy.md)
* [Permissions](core-modules/permissions.md)
* [Staking](core-modules/staking.md)
* [Tokenfactory](core-modules/token-factory.md)
* [Wasm](core-modules/wasm.md)
* [Bridge](bridge/README.md)
* [Ethereum](bridge/ethereum.md)
* [IBC](bridge/ibc.md)
* [Wormhole](bridge/wormhole.md)
* [Contracts](contracts/README.md)
* [Injective Name Service](contracts/injective-name-service.md)
* [Building dApps](building-dapps/README.md)
* [Configuring Nuxt](building-dapps/configuring-nuxt.md)
* [Configuring React](building-dapps/configuring-react.md)
* [dApps Examples](building-dapps/dapps-examples/README.md)
* [Smart Contract](building-dapps/smart-contract.md)
* [DEX](building-dapps/dex.md)
* [Bridge](building-dapps/bridge.md)
* [Simple HTML example with Webpack](building-dapps/dapps-examples/simple-html-example-with-webpack.md)
* [Calculations](calculations/README.md)
* [Min Price Tick Size](calculations/min-price-tick-size.md)
* [Min Quantity Tick Size](calculations/min-quantity-tick-size.md)
- [Getting Started](README.md)
- [Technical Concepts](readme/technical-concepts.md)
- [Application Concepts](readme/application-concepts.md)
- [Assets](readme/assets/README.md)
- [Creating Tokens](readme/assets/creating-tokens.md)
- [Denom Client (deprecated)](readme/assets/denom-client.md)
- [Injective Lists](readme/assets/injective-list.md)
- [Networks](readme/networks.md)
- [CosmJs Support](readme/getting-started-cosmjs.md)
- [Running examples](readme/running-examples.md)
- [Wallet](wallet/README.md)
- [Accounts](wallet/wallet-accounts.md)
- [Wallet Connections](wallet/wallet-connections.md)
- [Wallet Strategy](wallet/wallet-wallet-strategy.md)
- [Offchain (Arbitrary) Data](wallet/offchain-arbitrary-data.md)
- [Querying](querying/README.md)
- [Indexer](querying/querying-api/README.md)
- [Account](querying/querying-api/querying-indexer-account.md)
- [Auction](querying/querying-api/querying-indexer-auction.md)
- [Derivatives](querying/querying-api/querying-indexer-derivatives.md)
- [Explorer](querying/querying-api/querying-indexer-explorer.md)
- [Insurance Funds](querying/querying-api/querying-indexer-insurance-funds.md)
- [Markets](querying/querying-api/querying-indexer-markets.md)
- [Leaderboard](querying/querying-api/querying-indexer-leaderboard.md)
- [Mito](querying/querying-api/querying-indexer-mito.md)
- [Oracle](querying/querying-api/querying-indexer-oracle.md)
- [Portfolio](querying/querying-api/querying-indexer-portfolio.md)
- [Spot](querying/querying-api/querying-indexer-spot.md)
- [Web3Gw Transactions](querying/querying-api/querying-indexer-transaction.md)
- [Streaming](querying/querying-api/streaming/README.md)
- [Account](querying/querying-api/streaming/streaming-indexer-account.md)
- [Auction](querying/querying-api/streaming/streaming-indexer-auction.md)
- [Derivatives](querying/querying-api/streaming/streaming-indexer-derivatives.md)
- [Oracle](querying/querying-api/streaming/streaming-indexer-oracle.md)
- [Portfolio](querying/querying-api/streaming/streaming-indexer-portfolio.md)
- [Spot](querying/querying-api/streaming/streaming-indexer-spot.md)
- [Explorer](querying/querying-api/streaming/streaming-indexer-explorer.md)
- [Chain](querying/querying-chain/README.md)
- [Auction](querying/querying-chain/querying-chain-auction-module.md)
- [Auth](querying/querying-chain/querying-chain-auth-module.md)
- [Bank](querying/querying-chain/querying-chain-bank-module.md)
- [Distribution](querying/querying-chain/querying-chain-distribution.md)
- [Exchange](querying/querying-chain/querying-chain-exchange.md)
- [Governance](querying/querying-chain/querying-chain-governance.md)
- [IBC](querying/querying-chain/querying-chain-ibc.md)
- [Mint](querying/querying-chain/querying-chain-mint.md)
- [Insurance Funds](querying/querying-chain/querying-chain-insurance-funds.md)
- [Oracle](querying/querying-chain/querying-chain-oracle.md)
- [Peggy](querying/querying-chain/querying-chain-peggy.md)
- [Permissions](querying/querying-chain/querying-chain-permissions.md)
- [Staking](querying/querying-chain/querying-chain-staking.md)
- [Tendermint](querying/querying-chain/querying-chain-tendermint.md)
- [Wasm](querying/querying-chain/querying-chain-wasm.md)
- [WasmX](querying/querying-chain/querying-chain-wasmx.md)
- [Token Factory](querying/querying-chain/token-factory.md)
- [Ethereum (GraphQL)](querying/querying-ethereum.md)
- [Transactions](transactions/README.md)
- [Cosmos](transactions/transactions-cosmos/README.md)
- [Ledger through Keplr Wallet](transactions/transactions-cosmos/ledger-through-keplr-wallet.md)
- [Ethereum](transactions/ethereum.md)
- [Ethereum Ledger](transactions/ethereum-ledger.md)
- [MsgBroadcaster](transactions/msgbroadcaster.md)
- [Private Key](transactions/private-key.md)
- [Web3 Gateway](transactions/web3-gateway.md)
- [Core Modules](core-modules/README.md)
- [Auction](core-modules/auction.md)
- [AuthZ](core-modules/authz.md)
- [Bank](core-modules/bank.md)
- [Distribution](core-modules/distribution.md)
- [Exchange](core-modules/exchange.md)
- [Feegrant](core-modules/feegrant.md)
- [Governance](core-modules/governance.md)
- [IBC](core-modules/ibc.md)
- [Insurance](core-modules/insurance.md)
- [Peggy](core-modules/peggy.md)
- [Permissions](core-modules/permissions.md)
- [Staking](core-modules/staking.md)
- [Tokenfactory](core-modules/token-factory.md)
- [Wasm](core-modules/wasm.md)
- [Bridge](bridge/README.md)
- [Ethereum](bridge/ethereum.md)
- [IBC](bridge/ibc.md)
- [Wormhole](bridge/wormhole.md)
- [Contracts](contracts/README.md)
- [Injective Name Service](contracts/injective-name-service.md)
- [Neptune Service](contracts/neptune-service.md)
- [Building dApps](building-dapps/README.md)
- [Configuring Nuxt](building-dapps/configuring-nuxt.md)
- [Configuring React](building-dapps/configuring-react.md)
- [dApps Examples](building-dapps/dapps-examples/README.md)
- [Smart Contract](building-dapps/smart-contract.md)
- [DEX](building-dapps/dex.md)
- [Bridge](building-dapps/bridge.md)
- [Simple HTML example with Webpack](building-dapps/dapps-examples/simple-html-example-with-webpack.md)
- [Calculations](calculations/README.md)
- [Min Price Tick Size](calculations/min-price-tick-size.md)
- [Min Quantity Tick Size](calculations/min-quantity-tick-size.md)
Comment on lines +3 to +99
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Missing documentation file for Neptune Service

The Neptune Service documentation file (contracts/neptune-service.md) referenced in the SUMMARY.md does not exist in the repository, although the feature appears to be implemented based on the presence of Neptune-related TypeScript files in the SDK.

  • The documentation file needs to be created at contracts/neptune-service.md to match the table of contents structure
  • The file should document the Neptune Service functionality that's implemented in:
    • packages/sdk-ts/src/core/modules/wasm/exec-args/ExecArgNeptuneDeposit.ts
    • packages/sdk-ts/src/core/modules/wasm/exec-args/ExecArgNeptuneWithdraw.ts
🔗 Analysis chain

Verify documentation completeness.

The table of contents structure is well-organized and consistently formatted. However, since this is a new service addition, please ensure that the referenced documentation file exists.


Let me verify if the path in the SUMMARY.md is correct and if the documentation exists in a different location.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the Neptune Service documentation file exists
# and contains content

# Check if the file exists and is not empty
if [ -f "contracts/neptune-service.md" ]; then
    echo "Documentation file exists"
    if [ -s "contracts/neptune-service.md" ]; then
        echo "Documentation file contains content"
    else
        echo "Warning: Documentation file is empty"
    fi
else
    echo "Warning: Documentation file does not exist"
fi

Length of output: 136


Script:

#!/bin/bash
# Check the actual location of neptune-service.md
fd neptune-service.md

# Also check if there might be content in docs folder
fd -t f neptune

Length of output: 188

🧰 Tools
🪛 LanguageTool

[duplication] ~62-~62: Possible typo: you repeated a word
Context: ...os/ledger-through-keplr-wallet.md) - Ethereum - [Ethereum Ledger](transactions/ethereum-ledger.md...

(ENGLISH_WORD_REPEAT_RULE)

3 changes: 2 additions & 1 deletion .gitbook/contracts/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contracts

#### [What is CosmWasm?](./#what-is-cosmwasm-)[​](https://docs.injective.network/develop/guides/cosmwasm-dapps/#what-is-cosmwasm) <a href="#user-content-what-is-cosmwasm" id="user-content-what-is-cosmwasm"></a>
#### [What is CosmWasm?](./#what-is-cosmwasm-)[​](https://docs.injective.network/develop/guides/cosmwasm-dapps/#what-is-cosmwasm) <a href="#user-content-what-is-cosmwasm" id="user-content-what-is-cosmwasm"></a>

CosmWasm is a novel smart contracting platform built for the Cosmos ecosystem. You can learn more about CosmWasm [here](https://docs.cosmwasm.com/docs/), or see the [CosmWasm Book](https://book.cosmwasm.com/index.html) for a guide on creating CosmWasm smart contracts.

@@ -9,3 +9,4 @@ CosmWasm is a novel smart contracting platform built for the Cosmos ecosystem. Y
| Topic | Description |
| --------------------------------------------------- | ---------------------- |
| [Injective Name Service](injective-name-service.md) | Injective Name Service |
| [Neptune Service](neptune-service.md) | Injective Name Service |
Loading