Skip to content

Commit

Permalink
update sdk examples lines
Browse files Browse the repository at this point in the history
  • Loading branch information
HananINouman committed May 24, 2024
1 parent 98e9c18 commit 7bdb98f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
11 changes: 7 additions & 4 deletions docs/sdk/classes/Client.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ terms and conditions acceptance success message.

On unverified signature or wrong hash.

An example of how to use acceptObolLatestTermsAndConditions:
[acceptObolLatestTermsAndConditions](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L44)

#### Source

index.ts:59
Expand Down Expand Up @@ -83,7 +86,7 @@ config_hash.
On duplicate entries, missing or wrong cluster keys.

An example of how to use createClusterDefinition:
[createObolCluster](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
[createObolCluster](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L59)

#### Source

Expand Down Expand Up @@ -115,7 +118,7 @@ The cluster definition.
On unauthorized, duplicate entries, missing keys, not found cluster or invalid data.

An example of how to use acceptClusterDefinition:
[acceptClusterDefinition](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
[acceptClusterDefinition](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L106)

#### Source

Expand Down Expand Up @@ -144,7 +147,7 @@ The cluster definition for config hash
On not found config hash.

An example of how to use getClusterDefinition:
[getObolClusterDefinition](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
[getObolClusterDefinition](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L74)

#### Source

Expand Down Expand Up @@ -173,7 +176,7 @@ The matched cluster details (lock) from DB
On not found cluster definition or lock.

An example of how to use getClusterLock:
[getObolClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
[getObolClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L89)

#### Source

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/functions/validateClusterLock.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ boolean result to indicate if lock is valid
on missing keys or values.

An example of how to use validateClusterLock:
[validateClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts)
[validateClusterLock](https://github.com/ObolNetwork/obol-sdk-examples/blob/main/TS-Example/index.ts#L127)

## Source

Expand Down

0 comments on commit 7bdb98f

Please sign in to comment.