-
Notifications
You must be signed in to change notification settings - Fork 35
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
aa0b47d
commit 95555ea
Showing
6 changed files
with
181 additions
and
3 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 |
|---|---|---|
| @@ -1,3 +1,6 @@ | ||
| ## [1.3.4] - 28.July.2022. | ||
| - add SEP-0007 implementation | ||
|
|
||
| ## [1.3.3] - 09.Mai.2022. | ||
| - protocol 19 support | ||
|
|
||
|
|
||
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
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
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,172 @@ | ||
|
|
||
| ### SEP-0007 - URI Scheme to facilitate delegated signing | ||
|
|
||
|
|
||
|
|
||
| URI Scheme to facilitate delegated signing is described in [SEP-0007](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0007.md). This Stellar Ecosystem Proposal introduces a URI Scheme that can be used to generate a URI that will serve as a request to sign a transaction. The URI (request) will typically be signed by the user’s trusted wallet where she stores her secret key(s). | ||
|
|
||
| This SDK provides utility features to facilitate the implementation of SEP-0007 in a Flutter Wallet. These features are implemented in the [URIScheme](https://github.com/Soneso/stellar_flutter_sdk/blob/master/lib/src/sep/0007/URIScheme.dart) class and are described below. | ||
|
|
||
| **Generate a transaction uri** | ||
|
|
||
| ```dart | ||
| String generateSignTransactionURI(String transactionEnvelopeXdrBase64, | ||
| {String? replace, | ||
| String? callback, | ||
| String? publicKey, | ||
| String? chain, | ||
| String? message, | ||
| String? networkPassphrase, | ||
| String? originDomain, | ||
| String? signature}) | ||
| ``` | ||
| This function can be used to generate a URIScheme compliant URL to serve as a request to sign a transaction. | ||
|
|
||
| Example: | ||
|
|
||
| ```dart | ||
| AccountResponse sourceAccount = await sdk.accounts.account(accountId); | ||
| SetOptionsOperationBuilder setOp = SetOptionsOperationBuilder(); | ||
| setOp.setSourceAccount(accountId); | ||
| setOp.setHomeDomain("www.soneso.com"); | ||
| Transaction transaction = | ||
| TransactionBuilder(sourceAccount).addOperation(setOp.build()).build(); | ||
| URIScheme uriScheme = URIScheme(); | ||
| String url = | ||
| uriScheme.generateSignTransactionURI(transaction.toEnvelopeXdrBase64()); | ||
| print(url); | ||
| // web+stellar:tx?xdr=AAAAAgAAAADNQvJCahsRijRFXMHgyGXdar95Wya9ONBFmFGORBZkWAAAAGQABwWpAAAAKwAAAAAAAAAAAAAAAQAAAAEAAAAAzULyQmobEYo0RVzB4Mhl3Wq%2FeVsmvTjQRZhRjkQWZFgAAAAFAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAOd3d3LnNvbmVzby5jb20AAAAAAAAAAAAAAAAAAA%3D%3D | ||
| ``` | ||
|
|
||
| **Generate a pay operation uri** | ||
|
|
||
| ```dart | ||
| String generatePayOperationURI(String destinationAccountId, | ||
| {String? amount, | ||
| String? assetCode, | ||
| String? assetIssuer, | ||
| String? memo, | ||
| String? memoType, | ||
| String? callback, | ||
| String? message, | ||
| String? networkPassphrase, | ||
| String? originDomain, | ||
| String? signature}) | ||
| ``` | ||
|
|
||
| This function can be used to generate a URIScheme compliant URL to serve as a request to pay a specific address with a specific asset, regardless of the source asset used by the payer. | ||
|
|
||
| Example: | ||
|
|
||
| ```dart | ||
| URIScheme uriScheme = URIScheme(); | ||
| String url = uriScheme.generatePayOperationURI(accountId, | ||
| amount: "123.21", | ||
| assetCode: "ANA", | ||
| assetIssuer: | ||
| "GC4HC3AXQDNAMURMHVGMLFGLQELEQBCE4GI7IOKEAWAKBXY7SXXWBTLV"); | ||
| print(url); | ||
| //web+stellar:pay?destination=GDGUF4SCNINRDCRUIVOMDYGIMXOWVP3ZLMTL2OGQIWMFDDSECZSFQMQV&amount=123.21&asset_code=ANA&asset_issuer=GC4HC3AXQDNAMURMHVGMLFGLQELEQBCE4GI7IOKEAWAKBXY7SXXWBTLV | ||
| ``` | ||
|
|
||
| **Check if URI Scheme is valid** | ||
| ```dart | ||
| Future<bool> checkUIRSchemeIsValid(String url) async | ||
| ``` | ||
| Checks if the received SEP-0007 URL is valid; signature and domain must be present and correct for the signer's keypair. | ||
| Returns true if valid, otherwise throws the corresponding URISchemeError. | ||
|
|
||
| Example: | ||
|
|
||
| ```dart | ||
| URIScheme uriScheme = URIScheme(); | ||
| await uriScheme.checkUIRSchemeIsValid(url).then((response) { | ||
| // success | ||
| }).catchError((error) async { | ||
| if (error is URISchemeError && | ||
| error.type == URISchemeError.tomlSignatureMissing){ | ||
| // handle error | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| Possible URISchemeErrors are: | ||
|
|
||
| ```dart | ||
| static const int invalidSignature = 0; | ||
| static const int invalidOriginDomain = 1; | ||
| static const int missingOriginDomain = 2; | ||
| static const int missingSignature = 3; | ||
| static const int tomlNotFoundOrInvalid = 4; | ||
| static const int tomlSignatureMissing = 5; | ||
| ``` | ||
|
|
||
| **Sign URI** | ||
|
|
||
| ```dart | ||
| String signURI(String url, KeyPair signerKeypair) | ||
| ``` | ||
| Signs the URIScheme compliant SEP-0007 url with the signer's key pair. Returns the signed url having the signature parameter attached. | ||
| Be careful with this function, you should validate the url and ask the user for permission before using this function. | ||
|
|
||
| Example: | ||
|
|
||
| ```dart | ||
| print(url); | ||
| // web+stellar:tx?xdr=AAAAAgAAAADNQvJCahsRijRFXMHgyGXdar95Wya9ONBFmFGORBZkWAAAAGQABwWpAAAAKwAAAAAAAAAAAAAAAQAAAAEAAAAAzULyQmobEYo0RVzB4Mhl3Wq%2FeVsmvTjQRZhRjkQWZFgAAAAFAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAOd3d3LnNvbmVzby5jb20AAAAAAAAAAAAAAAAAAA%3D%3D&origin_domain=place.domain.com | ||
| URIScheme uriScheme = URIScheme(); | ||
| url = uriScheme.signURI(url, signerKeyPair); | ||
| print(url); | ||
| // web+stellar:tx?xdr=AAAAAgAAAADNQvJCahsRijRFXMHgyGXdar95Wya9ONBFmFGORBZkWAAAAGQABwWpAAAAKwAAAAAAAAAAAAAAAQAAAAEAAAAAzULyQmobEYo0RVzB4Mhl3Wq%2FeVsmvTjQRZhRjkQWZFgAAAAFAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAOd3d3LnNvbmVzby5jb20AAAAAAAAAAAAAAAAAAA%3D%3D&origin_domain=place.domain.com&signature=bIZ53bPKkNe0OoNK8PGLTnzHS%2FBCMzXTvwv1mc4DWc0XC4%2Bp197AmUB%2FIPL1UZAega7cLYv7%2F%2FaflB7CLGqZCw%3D%3D | ||
| ``` | ||
|
|
||
| **Sign and submit transaction** | ||
|
|
||
| ```dart | ||
| Future<SubmitUriSchemeTransactionResponse> signAndSubmitTransaction( | ||
| String url, KeyPair signerKeyPair, | ||
| {Network? network}) async | ||
| ``` | ||
| Signs the given transaction and submits it to the callback url if available, otherwise it submits it to the stellar network. | ||
| Be careful with this function, you should validate the url and ask the user for permission before using this function. | ||
|
|
||
| Example: | ||
|
|
||
| ```dart | ||
| URIScheme uriScheme = URIScheme(); | ||
| SubmitUriSchemeTransactionResponse response = await uriScheme | ||
| .signAndSubmitTransaction(url, signerKeyPair, network: Network.TESTNET); | ||
| ``` | ||
|
|
||
| ```SubmitUriSchemeTransactionResponse``` has two members: ```submitTransactionResponse``` and ```response```. ```submitTransactionResponse``` is filled if the transaction has been send to the stellar network. ```response``` is filled if the transaction has been sent to the callback. | ||
|
|
||
| ```dart | ||
| class SubmitUriSchemeTransactionResponse { | ||
| SubmitTransactionResponse? | ||
| submitTransactionResponse; // if submitted to stellar | ||
| http.Response? response; // if submitted to callback | ||
| SubmitUriSchemeTransactionResponse( | ||
| this.submitTransactionResponse, this.response); | ||
| } | ||
| ``` | ||
|
|
||
| **Get parameter value** | ||
|
|
||
| ```dart | ||
| String? getParameterValue(String name, String url) | ||
| ``` | ||
|
|
||
| Utility function that returns the value of the given url parameter from the specified SEP-0007 url. | ||
|
|
||
|
|
||
| **More examples** | ||
|
|
||
| You can find more examples in the [SEP-0007 Test Cases](https://github.com/Soneso/stellar_flutter_sdk/blob/master/test/sep0007_test.dart) |
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
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