1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
//! A wrapper around the asynchronous NBGL [nbgl_useCaseReview](https://github.com/LedgerHQ/ledger-secure-sdk/blob/master/lib_nbgl/src/nbgl_use_case.c#L3874), [nbgl_useCaseReviewBlindSigning](https://github.com/LedgerHQ/ledger-secure-sdk/blob/master/lib_nbgl/src/nbgl_use_case.c#L3915) and [nbgl_useCaseReviewLight](https://github.com/LedgerHQ/ledger-secure-sdk/blob/master/lib_nbgl/src/nbgl_use_case.c#L3953) C API bindings.
//!
//! Used to display transaction review screens.
use super::*;
/// A builder to create and show a review flow.
pub struct NbglReview<'a> {
title: CString,
subtitle: CString,
finish_title: CString,
glyph: Option<&'a NbglGlyph<'a>>,
tx_type: TransactionType,
blind: bool,
light: bool,
}
impl SyncNBGL for NbglReview<'_> {}
impl<'a> NbglReview<'a> {
/// Creates a new review flow builder.
/// # Returns
/// Returns a new instance of `NbglReview`.
pub fn new() -> NbglReview<'a> {
NbglReview {
title: CString::default(),
subtitle: CString::default(),
finish_title: CString::default(),
glyph: None,
tx_type: TransactionType::Transaction,
blind: false,
light: false,
}
}
/// Sets the type of transaction being reviewed.
/// # Arguments
/// * `tx_type` - The type of transaction being reviewed.
/// # Returns
/// Returns the builder itself to allow method chaining.
pub fn tx_type(self, tx_type: TransactionType) -> NbglReview<'a> {
NbglReview { tx_type, ..self }
}
/// Enables blind signing mode for the review.
/// # Returns
/// Returns the builder itself to allow method chaining.
pub fn blind(self) -> NbglReview<'a> {
NbglReview {
blind: true,
..self
}
}
/// Enables light mode for the review.
/// # Returns
/// Returns the builder itself to allow method chaining.
pub fn light(self) -> NbglReview<'a> {
NbglReview {
light: true,
..self
}
}
/// Sets the titles to display at the top and bottom of the page.
/// # Arguments
/// * `title` - The title to display at the top of the page.
/// * `subtitle` - The subtitle to display below the title at the top of the page.
/// * `finish_title` - The title to display at the bottom of the page.
/// # Returns
/// Returns the builder itself to allow method chaining.
pub fn titles(
self,
title: &'a str,
subtitle: &'a str,
finish_title: &'a str,
) -> NbglReview<'a> {
NbglReview {
title: CString::new(title).unwrap(),
subtitle: CString::new(subtitle).unwrap(),
finish_title: CString::new(finish_title).unwrap(),
..self
}
}
/// Sets the icon to display in the center of the page.
/// # Arguments
/// * `glyph` - The icon to display in the center of the page.
/// # Returns
/// Returns the builder itself to allow method chaining.
pub fn glyph(self, glyph: &'a NbglGlyph) -> NbglReview<'a> {
NbglReview {
glyph: Some(glyph),
..self
}
}
/// Shows the review flow with the provided fields on the review pages.
/// # Arguments
/// * `fields` - A slice of `Field` representing the tag/value pairs to display.
/// # Returns
/// Returns `true` if the user approved the transaction, `false` otherwise.
pub fn show(&self, fields: &[Field]) -> bool {
unsafe {
let v: Vec<CField> = fields
.iter()
.map(|f| CField {
name: CString::new(f.name).unwrap(),
value: CString::new(f.value).unwrap(),
})
.collect();
// Fill the tag_value_array with the fields converted to nbgl_contentTagValue_t
let mut tag_value_array: Vec<nbgl_contentTagValue_t> = Vec::new();
for field in v.iter() {
let val = nbgl_contentTagValue_t {
item: field.name.as_ptr() as *const ::core::ffi::c_char,
value: field.value.as_ptr() as *const ::core::ffi::c_char,
..Default::default()
};
tag_value_array.push(val);
}
// Create the tag_value_list with the tag_value_array.
let tag_value_list = nbgl_contentTagValueList_t {
pairs: tag_value_array.as_ptr() as *const nbgl_contentTagValue_t,
nbPairs: fields.len() as u8,
..Default::default()
};
let icon: nbgl_icon_details_t = match self.glyph {
Some(g) => g.into(),
None => nbgl_icon_details_t::default(),
};
// Show the review on the device.
self.ux_sync_init();
match self.blind {
true => {
nbgl_useCaseReviewBlindSigning(
self.tx_type.to_c_type(false),
&tag_value_list as *const nbgl_contentTagValueList_t,
&icon as *const nbgl_icon_details_t,
match self.title.is_empty() {
true => core::ptr::null(),
false => self.title.as_ptr() as *const c_char,
},
match self.subtitle.is_empty() {
true => core::ptr::null(),
false => self.subtitle.as_ptr() as *const c_char,
},
match self.finish_title.is_empty() {
true => core::ptr::null(),
false => self.finish_title.as_ptr() as *const c_char,
},
core::ptr::null(),
Some(choice_callback),
);
}
false => {
if self.light {
nbgl_useCaseReviewLight(
self.tx_type.to_c_type(false),
&tag_value_list as *const nbgl_contentTagValueList_t,
&icon as *const nbgl_icon_details_t,
match self.title.is_empty() {
true => core::ptr::null(),
false => self.title.as_ptr() as *const c_char,
},
match self.subtitle.is_empty() {
true => core::ptr::null(),
false => self.subtitle.as_ptr() as *const c_char,
},
match self.finish_title.is_empty() {
true => core::ptr::null(),
false => self.finish_title.as_ptr() as *const c_char,
},
Some(choice_callback),
);
} else {
nbgl_useCaseReview(
self.tx_type.to_c_type(false),
&tag_value_list as *const nbgl_contentTagValueList_t,
&icon as *const nbgl_icon_details_t,
match self.title.is_empty() {
true => core::ptr::null(),
false => self.title.as_ptr() as *const c_char,
},
match self.subtitle.is_empty() {
true => core::ptr::null(),
false => self.subtitle.as_ptr() as *const c_char,
},
match self.finish_title.is_empty() {
true => core::ptr::null(),
false => self.finish_title.as_ptr() as *const c_char,
},
Some(choice_callback),
);
}
}
}
let sync_ret = self.ux_sync_wait(false);
// Return true if the user approved the transaction, false otherwise.
match sync_ret {
SyncNbgl::UxSyncRetApproved => {
return true;
}
_ => {
return false;
}
}
}
}
}