Skip to content

Commit

Permalink
docs: replace docs link (#249)
Browse files Browse the repository at this point in the history
* docs: replace docs link
  • Loading branch information
BarryTong65 authored Jun 11, 2024
1 parent 95a95db commit 5f05795
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion client/api_group.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ type IGroupClient interface {
// Create, Associate payment accounts
// Grant, Revoke the above permissions
//
// # For more details regarding `Group`, please refer to https://docs.bnbchain.org/greenfield-docs/docs/guide/greenfield-blockchain/modules/permission
// # For more details regarding `Group`, please refer to https://github.com/bnb-chain/greenfield/blob/master/docs/modules/permission.md
//
// - ctx: Context variables for the current API call.
//
Expand Down
10 changes: 5 additions & 5 deletions client/api_off_chain_auth.go
Original file line number Diff line number Diff line change
Expand Up @@ -140,17 +140,17 @@ Expiration Time: %s`
// RegisterEDDSAPublicKey - Register EdDSA public key of this client for the given sp address and spEndpoint.
//
// To enable EdDSA authentication, you need to config OffChainAuthOption for the client.
// The overall register process could be referred to https://docs.bnbchain.org/greenfield-docs/docs/guide/storage-provider/modules/authenticator#workflow.
// The overall register process could be referred to https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/modules/authenticator.md#workflow.
//
// The EdDSA registering process is typically used in a website, e.g. https://dcellar.io,
// which obtains a user's signature via a wallet and then posts the user's EdDSA public key to a sp.
//
// Here we also provide an SDK method to implement this process, because sometimes you might want to test if a given SP provides correct EdDSA authentication or not.
// It also helps if you want implement it on a non-browser environment.
//
// - spAddress: The sp operator address, to which this API will register client's EdDSA public key. It can be found via https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/storage-providers .
// - spAddress: The sp operator address, to which this API will register client's EdDSA public key. It can be found via https://greenfield-chain.bnbchain.org/openapi#/Query/StorageProviders .
//
// - spEndpoint: The sp endpoint, to which this API will register client's EdDSA public key. It can be found via https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/storage-providers .
// - spEndpoint: The sp endpoint, to which this API will register client's EdDSA public key. It can be found via https://greenfield-chain.bnbchain.org/openapi#/Query/StorageProviders .
//
// - ret1: The register result when invoking SP UpdateUserPublicKey API.
//
Expand Down Expand Up @@ -192,15 +192,15 @@ func (c *Client) RegisterEDDSAPublicKey(spAddress string, spEndpoint string) (st
// RegisterEDDSAPublicKeyV2 - Register EdDSA public key of this client for the given sp address and spEndpoint.
//
// To enable EdDSA authentication, you need to config OffChainAuthOptionV2 for the client.
// The overall register process could be referred to https://docs.bnbchain.org/greenfield-docs/docs/guide/storage-provider/modules/authenticator#workflow.
// The overall register process could be referred to https://github.com/bnb-chain/greenfield-storage-provider/blob/master/docs/modules/authenticator.md#workflow.
//
// The EdDSA registering process is typically used in a website, e.g. https://dcellar.io,
// which obtains a user's signature via a wallet and then posts the user's EdDSA public key to a sp.
//
// Here we also provide an SDK method to implement this process, because sometimes you might want to test if a given SP provides correct EdDSA authentication or not.
// It also helps if you want implement it on a non-browser environment.
//
// - spEndpoint: The sp endpoint, to which this API will register client's EdDSA public key. It can be found via https://docs.bnbchain.org/greenfield-docs/docs/greenfield-api/storage-providers .
// - spEndpoint: The sp endpoint, to which this API will register client's EdDSA public key. It can be found via https://greenfield-chain.bnbchain.org/openapi#/Query/StorageProviders .
//
// - ret1: The register result when invoking SP UpdateUserPublicKey API.
//
Expand Down

0 comments on commit 5f05795

Please sign in to comment.