This repository has been archived by the owner on Aug 21, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
521b3ff
commit 418a618
Showing
2 changed files
with
55 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
sidebar_position: 2 | ||
title: Soroban Rust Auth SDK | ||
--- | ||
|
||
The `soroban-auth` Rust crate contains the Soroban Rust Auth SDK. It provides | ||
utilities for verifying signatures on invocations of smart contracts. It is | ||
intended for use alongside the [`soroban-sdk`]. | ||
|
||
[`soroban-sdk`]: rust | ||
|
||
:::caution | ||
The `soroban-auth` crate is in early development. Report issues | ||
[here](https://github.com/stellar/rs-soroban-sdk/issues/new/choose). | ||
::: | ||
|
||
## SDK Documentation | ||
|
||
Auth documentation is available at: | ||
https://docs.rs/soroban-auth | ||
|
||
## Subscribe to Releases | ||
|
||
Subscribe to releases on the GitHub repository: | ||
https://github.com/stellar/rs-soroban-sdk | ||
|
||
## Add `soroban-auth` as a Dependency | ||
|
||
Add the following sections to the `Cargo.toml` to import `soroban-auth`. | ||
|
||
```toml | ||
[features] | ||
testutils = ["soroban-auth/testutils"] | ||
|
||
[dependencies] | ||
soroban-auth = "0.0.4" | ||
|
||
[dev_dependencies] | ||
soroban-auth = { version = "0.0.4", features = ["soroban-auth/testutils"] } | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters