Skip to content

Commit

Permalink
Merge branch 'release/10' into platform-agnostic-sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
soerenbf committed Oct 3, 2023
2 parents db46bcd + f0942d2 commit c4b4b77
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 15 deletions.
10 changes: 5 additions & 5 deletions .markdown-linkcheck.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"ignorePatterns": [
{
"pattern": "classes/Common_GRPC_Client.ConcordiumGRPCClient.html"
}
]
"ignorePatterns": [
{
"pattern": "classes/grpc.ConcordiumGRPCClient.html"
}
]
}
4 changes: 2 additions & 2 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -167,9 +167,9 @@ MD035:
style: "consistent"

# MD036/no-emphasis-as-heading/no-emphasis-as-header - Emphasis used instead of a heading
MD036:
MD036: false
# Punctuation characters
punctuation: ".,;:!?。,;:!?"
# punctuation: ".,;:!?。,;:!?"

# MD037/no-space-in-emphasis - Spaces inside emphasis markers
MD037: true
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/cis2-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This document describes the helper class for working with CIS-2 contracts
## CIS2Contract

The CIS2Contract class wraps the
[ConcordiumGRPCClient](../classes/index.ConcordiumGRPCClient.html),
[ConcordiumGRPCClient](../classes/grpc.ConcordiumGRPCClient.html),
defining an interface matching the [CIS-2
standard](https://proposals.concordium.software/CIS/cis-2.html).

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ This is the documentation for the Concordium Javascript SDK. Here we cover
the JS wrappers for interacting with the Concordium nodes.

Most functionality is provideded by the
[GRPC-Client](../classes/index.ConcordiumGRPCClient.html)
[GRPC-Client](../classes/grpc.ConcordiumGRPCClient.html)
however there exists additional helper functions, for example to help with
creating {@page transactions.md transactions}, or {@page identity-proofs.md
creating identity proof statements}, or {@page utility-functions.md general
Expand Down
6 changes: 4 additions & 2 deletions docs/pages/misc-pages/grpc-v1.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
> :warning: **This explains behaviour of the deprecated v1 concordium client**:
check out [the documentation the v2 client](../../classes/index.ConcordiumGRPCClient.html)
check out [the documentation the v2 client](../../classes/grpc.ConcordiumGRPCClient.html)

This describes the JSON-RPC client, which can interact with the [Concordium
JSON-RPC server](https://github.com/Concordium/concordium-json-rpc)
Expand Down Expand Up @@ -47,7 +47,9 @@ interface as the grpc v1 node client:
- [getModuleSource](#getmodulesource)
<!--toc:end-->

## GRPCv1-Client (only accessible prior to version 10)
## GRPCv1-Client

_Only accessible prior to version 10_

The ConcordiumNodeClient defines the interface to be used to send and receive
data from a concordium-node.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/utility-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ and does not give any guarantees for whether the contract adheres to the
standard it claims to implement. The function returns `undefined` if the
contract does not support CIS-0.

This requires a [`ConcordiumGRPCClient`](../classes/index.ConcordiumGRPCClient.html).
This requires a [`ConcordiumGRPCClient`](../classes/grpc.ConcordiumGRPCClient.html).

```ts
const client = ...; // `ConcordiumGRPCClient`
Expand Down
4 changes: 2 additions & 2 deletions packages/sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The SDK provides a gRPC client, which can interact with the [Concordium
Node](https://github.com/Concordium/concordium-node) using gRPC-web.

For an overview of the endpoints, [click
here](https://developer.concordium.software/concordium-node-sdk-js/classes/index.ConcordiumGRPCClient.html).
here](https://developer.concordium.software/concordium-node-sdk-js/classes/grpc.ConcordiumGRPCClient.html).

To create a client, the `ConcordiumGRPCWebClient` class can be used. It
requires the address and port of the concordium node.
Expand Down Expand Up @@ -50,7 +50,7 @@ The SDK provides a gRPC client, which can interact with the [Concordium
Node](https://github.com/Concordium/concordium-node) using gRPC.

For an overview of the endpoints, [click
here](https://developer.concordium.software/concordium-node-sdk-js/classes/index.ConcordiumGRPCClient.html).
here](https://developer.concordium.software/concordium-node-sdk-js/classes/grpc.ConcordiumGRPCClient.html).

To create a client, the `ConcordiumGRPCNodeClient` class can be used. It
requires the address and port of the concordium node.
Expand Down
1 change: 0 additions & 1 deletion packages/sdk/test/client/resources/expectedJsons.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import {
AccountAddress,
AccountCreationSummary,
AccountInfo,
AccountInfoBaker,
AccountInfoDelegator,
AccountInfoSimple,
Expand Down

0 comments on commit c4b4b77

Please sign in to comment.