Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend sep-06 wallet sdk doc for flutter #521

Merged
merged 1 commit into from
Apr 25, 2024
Merged

Extend sep-06 wallet sdk doc for flutter #521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/building-apps/wallet/component/dart/install.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import { CodeExample } from "@site/src/components/CodeExample";

```dart
// pubspec.yaml
stellar_wallet_flutter_sdk: ^0.2.0
stellar_flutter_sdk: ^1.7.4
stellar_wallet_flutter_sdk: ^0.3.0
stellar_flutter_sdk: ^1.7.7
```

</CodeExample>
Expand Down
140 changes: 139 additions & 1 deletion docs/building-apps/wallet/sep6.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { LanguageSpecific } from "@site/src/components/LanguageSpecific";
import { WalletCodeExample as CodeExample } from "@site/src/components/WalletCodeExample";
import Header from "./component/header.mdx";

<Header WIPLangs={["kotlin", "dart"]} />
<Header WIPLangs={["kotlin"]} />

The [SEP-6] standard defines a way for anchors and wallets to interact on behalf of users. Wallets use this standard to facilitate exchanges between on-chain assets (such as stablecoins) and off-chain assets (such as fiat, or other network assets such as BTC).

Expand All @@ -24,6 +24,10 @@ Let's start with creating a sep6 object, which we'll use for all SEP-6 interacti
const sep6 = anchor.sep6();
```

```dart
var sep6 = anchor.sep6();
```

</CodeExample>

First, let's get information about the anchor's support for [SEP-6]. This request doesn't require authentication, and will return generic info, such as supported currencies, and features supported by the anchor. You can get a full list of returned fields in the [SEP-6 specification](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md#info).
Expand All @@ -34,6 +38,10 @@ First, let's get information about the anchor's support for [SEP-6]. This reques
const info = await sep6.info();
```

```dart
var info = await sep6.info();
```

</CodeExample>

## Start a deposit
Expand Down Expand Up @@ -62,6 +70,13 @@ const deposit = await sep6.deposit({
});
```

```dart
var deposit = await anchor.sep6().deposit(
Sep6DepositParams(assetCode: assetCode, account: accountId),
authToken,
);
```

</CodeExample>

There are several kinds of responses, depending on if the anchor needs more information. All deposits and withdrawals will have these same response types:
Expand Down Expand Up @@ -108,6 +123,12 @@ if (deposit.type === "non_interactive_customer_info_needed") {
}
```

```dart
if (deposit is Sep6MissingKYC) {
print(deposit.fields);
}
```

</CodeExample>

The wallet will need to handle displaying to the user which fields are missing. And then to add those fields, we can use the sep12 class like so.
Expand All @@ -128,6 +149,20 @@ await sep12.add({
});
```

```dart
var sep12 = await anchor.sep12(authToken);

// adding the missing kyc info (sample data)
var sep9Info = {
'family_name': 'smith',
'given_name': 'john',
'address': '123 street',
'tax_id': '123',
};

var addResponse = await sep12.add(sep9Info);
```

</CodeExample>

Then, we can re-call the deposit method like before and it should be successful.
Expand Down Expand Up @@ -160,6 +195,28 @@ await sep12.add({
});
```

```dart
var sep12 = await anchor.sep12(authToken);

var sep9Info = {
'first_name': 'john',
'last_name': 'smith',
'email_address': '[email protected]',
'bank_number': '12345',
'bank_account_number': '12345',
};

var photoIdFront = await Util.readFile('./path/to/image/front');
var photoIdBack = await Util.readFile('./path/to/image/back');

var sep9Files = {
'photo_id_front': photoIdFront,
'photo_id_back': photoIdBack,
};

await sep12.add(sep9Info, sep9Files: sep9Files);
```

</CodeExample>

## Start a withdrawal
Expand All @@ -181,6 +238,18 @@ const resp = await sep6.withdraw({
});
```

```dart
var params = Sep6WithdrawParams(
assetCode: 'SRT',
account: accountId,
type: 'bank_account',
dest: '123',
destExtra: '12345',
);

var resp = await anchor.sep6().withdraw(params, authToken);
```

</CodeExample>

## Get exchange info
Expand All @@ -205,6 +274,16 @@ const resp = await sep6.depositExchange({
});
```

```dart
var params = Sep6DepositExchangeParams(
destinationAssetCode: 'SRT',
sourceAssetId: FiatAssetId('USD'),
amount: '10',
);

var resp = await anchor.sep6().depositExchange(params, authToken);
```

</CodeExample>

The response follows the same types as all the deposits and withdrawals for SEP-6.
Expand All @@ -226,6 +305,17 @@ const resp = await sep6.withdrawExchange({
});
```

```dart
var params = Sep6WithdrawExchangeParams(
sourceAssetCode: 'SRT',
destinationAssetId: FiatAssetId('USD'),
amount: '10',
type: 'bank_account',
);

var resp = await anchor.sep6().withdrawExchange(params, authToken);
```

</CodeExample>

The response follows the same types as all the deposits and withdrawals for SEP-6.
Expand Down Expand Up @@ -253,6 +343,23 @@ const { stop, refresh } = watcher.watchOneTransaction({
});
```

```dart
var watcher = anchor.sep6.watcher();
var result = watcher.watchOneTransaction(authToken, 'transaction id');

result.controller.stream.listen(
(event) {
if (event is StatusChange) {
print('Status changed to ${event.status}. Transaction: ${event.transaction.id}');
} else if (event is ExceptionHandlerExit) {
print('Exception handler exited the job');
} else if (event is StreamControllerClosed) {
print('Stream controller closed. Job is done');
}
}
);
```

</CodeExample>

Alternatively, we can track multiple transactions for the same asset.
Expand All @@ -270,6 +377,23 @@ const { stop, refresh } = watcher.watchAllTransactions({
});
```

```dart
var watcher = anchor.sep6.watcher();
var result = watcher.watchAsset(authToken, asset);

result.controller.stream.listen(
(event) {
if (event is StatusChange) {
print('Status changed to ${event.status}. Transaction: ${event.transaction.id}');
} else if (event is ExceptionHandlerExit) {
print('Exception handler exited the job');
} else if (event is StreamControllerClosed) {
print('Stream controller closed. Job is done');
}
}
);
```

</CodeExample>

### Fetching Transaction
Expand All @@ -284,6 +408,13 @@ const transaction = await anchor
.getTransactionBy({ authToken, id: transactionId });
```

```dart
var transaction = await anchor.sep6().getTransactionBy(
authToken: authToken,
id: transactionId,
);
```

</CodeExample>

It's also possible to fetch transactions by the asset.
Expand All @@ -297,6 +428,13 @@ const transactions = await anchor.sep6().getTransactionsForAsset({
});
```

```dart
var transactions = await anchor.sep6().getTransactionsForAsset(
authToken: authToken,
assetCode: assetCode,
);
```

</CodeExample>

[sep-6]: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md
Expand Down
Loading