Skip to content

Commit

Permalink
Update various TOCs
Browse files Browse the repository at this point in the history
  • Loading branch information
Hjort committed Feb 24, 2023
1 parent 7ac3d6b commit ea4d81c
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 79 deletions.
103 changes: 52 additions & 51 deletions docs/gRPC.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,58 +2,59 @@

This document describes the different endpoints for the concordium gRPC V2 client.

- [Concordium Nodejs SDK](#concordium-nodejs-sdk)
**Table of Contents**

- [ConcordiumNodeClient](#concordiumnodeclient)
- [Creating a client](#creating-a-client)
- [Send Account Transaction](#send-account-transaction)
- [Create a new account](#create-a-new-account)
- [getAccountInfo](#getaccountinfo)
- [getNextAccountSequenceNumber](#getnextaccountsequencenumber)
- [getBlockItemStatus](#getblockitemstatus)
- [getConsensusStatus](#getconsensusstatus)
- [getCryptographicParameters](#getcryptographicparameters)
- [getBlockChainParameters](#getblockchainparameters)
- [getPoolInfo](#getpoolinfo)
- [getPassiveDelegationInfo](#getpassivedelegationinfo)
- [getTokenomicsInfo](#gettokenomicsinfo)
- [getInstanceInfo](#getinstanceinfo)
- [invokeContract](#invokecontract)
- [getModuleSource](#getmodulesource)
- [getBlocks](#getblocks)
- [getFinalizedBlocks](#getfinalizedblocks)
- [waitForTransactionFinalization](#waitfortransactionfinalization)
- [getAccountList](#getaccountlist)
- [getModuleList](#getmodulelist)
- [getAncestors](#getancestors)
- [getInstanceState](#getinstancestate)
- [instanceStateLookup](#instancestatelookup)
- [getIdentityProviders](#getidentityproviders)
- [getAnonymityRevokers](#getanonymityrevokers)
- [getBlocksAtHeight](#getblocksatheight)
- [getBlockInfo](#getblockinfo)
- [getBakerList](#getbakerlist)
- [getPoolDelegators](#getpooldelegators)
- [getPoolDelegatorsRewardPeriod](#getpooldelegatorsrewardperiod)
- [getPassiveDelegators](#getpassivedelegators)
- [getPassiveDelegatorsRewardPeriod](#getpassivedelegatorsrewardperiod)
- [getBranches](#getbranches)
- [getElectionInfo](#getelectioninfo)
- [getAccountNonFinalizedTransactions](#getaccountnonfinalizedtransactions)
- [getBlockTransactionEvents](#getblocktransactionevents)
- [getNextUpdateSequenceNumbers](#getnextupdatesequencenumbers)
- [shutdown](#shutdown)
- [peerConnect](#peerconnect)
- [peerDisconnect](#peerdisconnect)
- [getBannedPeers](#getbannedpeers)
- [banPeer](#banpeer)
- [unbanPeer](#unbanpeer)
- [dumpStart](#dumpstart)
- [dumpStop](#dumpstop)
- [getNodeInfo](#getnodeinfo)
- [getPeersInfo](#getpeersinfo)
- [getBlockSpecialEvents](#getblockspecialevents)
- [getBlockPendingUpdates](#getblockpendingupdates)
- [getBlockFinalizationSummary](#getblockfinalizationsummary)
- [Creating a client](#creating-a-client)
- [Send Account Transaction](#send-account-transaction)
- [Create a new account](#create-a-new-account)
- [getAccountInfo](#getaccountinfo)
- [getNextAccountSequenceNumber](#getnextaccountsequencenumber)
- [getBlockItemStatus](#getblockitemstatus)
- [getConsensusStatus](#getconsensusstatus)
- [getCryptographicParameters](#getcryptographicparameters)
- [getBlockChainParameters](#getblockchainparameters)
- [getPoolInfo](#getpoolinfo)
- [getPassiveDelegationInfo](#getpassivedelegationinfo)
- [getTokenomicsInfo](#gettokenomicsinfo)
- [getInstanceInfo](#getinstanceinfo)
- [invokeContract](#invokecontract)
- [getModuleSource](#getmodulesource)
- [getBlocks](#getblocks)
- [getFinalizedBlocks](#getfinalizedblocks)
- [waitForTransactionFinalization](#waitfortransactionfinalization)
- [getAccountList](#getaccountlist)
- [getModuleList](#getmodulelist)
- [getAncestors](#getancestors)
- [getInstanceState](#getinstancestate)
- [instanceStateLookup](#instancestatelookup)
- [getIdentityProviders](#getidentityproviders)
- [getAnonymityRevokers](#getanonymityrevokers)
- [getBlocksAtHeight](#getblocksatheight)
- [getBlockInfo](#getblockinfo)
- [getBakerList](#getbakerlist)
- [getPoolDelegators](#getpooldelegators)
- [getPoolDelegatorsRewardPeriod](#getpooldelegatorsrewardperiod)
- [getPassiveDelegators](#getpassivedelegators)
- [getPassiveDelegatorsRewardPeriod](#getpassivedelegatorsrewardperiod)
- [getBranches](#getbranches)
- [getElectionInfo](#getelectioninfo)
- [getAccountNonFinalizedTransactions](#getaccountnonfinalizedtransactions)
- [getBlockTransactionEvents](#getblocktransactionevents)
- [getNextUpdateSequenceNumbers](#getnextupdatesequencenumbers)
- [shutdown](#shutdown)
- [peerConnect](#peerconnect)
- [peerDisconnect](#peerdisconnect)
- [getBannedPeers](#getbannedpeers)
- [banPeer](#banpeer)
- [unbanPeer](#unbanpeer)
- [dumpStart](#dumpstart)
- [dumpStop](#dumpstop)
- [getNodeInfo](#getnodeinfo)
- [getPeersInfo](#getpeersinfo)
- [getBlockSpecialEvents](#getblockspecialevents)
- [getBlockPendingUpdates](#getblockpendingupdates)
- [getBlockFinalizationSummary](#getblockfinalizationsummary)

# ConcordiumNodeClient

Expand Down
52 changes: 26 additions & 26 deletions docs/grpc-v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,32 @@

> :warning: **This explains behaviour of the deprecated v1 concordium client**: check out [the documentation the v2 client](./gRPC)
- [ConcordiumNodeClient](#concordiumnodeclient)
- [Creating a client](#creating-a-client)
- [Send Account Transaction](#send-account-transaction)
- [Create a new account](#create-a-new-account)
- [Construct IdentityInput for creating credentials](#construct-identityinput-for-creating-credentials)
- [Construct from user-cli output:](#construct-from-user-cli-output)
- [Construct from mobile wallet export:](#construct-from-mobile-wallet-export)
- [getAccountInfo](#getaccountinfo)
- [getNextAccountNonce](#getnextaccountnonce)
- [getTransactionStatus](#gettransactionstatus)
- [getBlockSummary](#getblocksummary)
- [getBlockInfo](#getblockinfo)
- [getBlocksAtHeight](#getblocksatheight)
- [getConsensusStatus](#getconsensusstatus)
- [getCryptographicParameters](#getcryptographicparameters)
- [getIdentityProviders](#getidentityproviders)
- [getAnonymityRevokers](#getanonymityrevokers)
- [getPeerList](#getpeerlist)
- [getBakerList](#getbakerlist)
- [getPoolStatus](#getpoolstatus)
- [getRewardStatus](#getrewardstatus)
- [Check block for transfers with memo](#check-block-for-transfers-with-memo)
- [getInstances](#getinstances)
- [getInstanceInfo](#getinstanceinfo)
- [invokeContract](#invokecontract)
- [getModuleSource](#getModuleSource)
**Table of Contents**
- [Creating a client](#creating-a-client)
- [Send Account Transaction](#send-account-transaction)
- [Create a new account](#create-a-new-account)
- [Construct IdentityInput for creating credentials](#construct-identityinput-for-creating-credentials)
- [Construct from user-cli output](#construct-from-user-cli-output)
- [Construct from mobile wallet export](#construct-from-mobile-wallet-export)
- [getAccountInfo](#getaccountinfo)
- [getNextAccountNonce](#getnextaccountnonce)
- [getTransactionStatus](#gettransactionstatus)
- [getBlockSummary](#getblocksummary)
- [getBlockInfo](#getblockinfo)
- [getBlocksAtHeight](#getblocksatheight)
- [getConsensusStatus](#getconsensusstatus)
- [getCryptographicParameters](#getcryptographicparameters)
- [getIdentityProviders](#getidentityproviders)
- [getAnonymityRevokers](#getanonymityrevokers)
- [getPeerList](#getpeerlist)
- [getBakerList](#getbakerlist)
- [getPoolStatus](#getpoolstatus)
- [getRewardStatus](#getrewardstatus)
- [Check block for transfers with memo](#check-block-for-transfers-with-memo)
- [getInstances](#getinstances)
- [getInstanceInfo](#getinstanceinfo)
- [invokeContract](#invokecontract)
- [getModuleSource](#getmodulesource)

The ConcordiumNodeClient defines the interface to be used to send and receive data from
a concordium-node.
Expand Down
2 changes: 2 additions & 0 deletions packages/common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ This package is the shared library for the nodejs and web SDK's.
- [Create a simple transfer with a memo](#create-a-simple-transfer-with-a-memo)
- [Create a Register data transaction](#create-a-register-data-transaction)
- [Create a configure delegation transaction](#create-a-configure-delegation-transaction)
- [Create a configure baker transaction](#create-a-configure-baker-transaction)
- [Create a credential for an existing account](#create-a-credential-for-an-existing-account)
- [Create an update credentials transaction](#create-an-update-credentials-transaction)
- [Deploy module](#deploy-module)
Expand All @@ -35,6 +36,7 @@ This package is the shared library for the nodejs and web SDK's.
- [Non membership statement](#non-membership-statement)
- [Verify Statement (verifyIdstatement)](#verify-statement-verifyidstatement)
- [Prove Statement (getIdProof)](#prove-statement-getidproof)
- [ConcordiumNodeClient](#concordiumnodeclient)
- [JSON-RPC client](#json-rpc-client)

# Constructing transactions
Expand Down
7 changes: 5 additions & 2 deletions packages/web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,19 @@ Wrappers for interacting with the Concordium node, for the web environment.
[Note that this package contains and exports the functions from the common-sdk, check the readme of that package for an overview of those](../common/README.md).

**Table of Contents**
- [ConcordiumNodeClient](#concordiumnodeclient)
- [JSON-RPC client](#json-rpc-client)
- [Creating a client](#creating-a-client)
- [API Entrypoints](#api-entrypoints)
- [Creating buffers](#creating-buffers)
- [Examples](#examples)
- [SendTransaction.html](#sendtransactionhtml)
- [GetInstanceInfo.html](#getinstanceinfohtml)
- [Alias.html](#aliashtml)
- [GetTransactionStatus.html](#gettransactionstatushtml)
- [GetNonce.html](#getnoncehtml)
- [InvokeContract.html](#invokecontracthtml)
- [GetCryptographicParameters.html](#getcryptographicparametershtml)
- [GetAccountInfo.html](#getaccountinfohtml)
- [GetModuleSource.html](#getmodulesourcehtml)
- [Build](#build)
- [Building for a release](#building-for-a-release)
- [Publishing a release](#publishing-a-release)
Expand Down

0 comments on commit ea4d81c

Please sign in to comment.