Skip to content

Commit f9fe1d9

Browse files
committed
rename values_len to num_values
len should be reserved for actual lengths, vs num for a count of (non-byte) elements.
1 parent b1b8606 commit f9fe1d9

File tree

5 files changed

+25
-23
lines changed

5 files changed

+25
-23
lines changed

include/wally_elements.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,20 +71,20 @@ WALLY_CORE_API int wally_ecdh_nonce_hash(
7171
* Generate the final value blinding factor required for blinding a confidential transaction.
7272
*
7373
* :param values: Array of values in satoshi
74-
* :param values_len: Length of ``values``, also the number of elements in all three of the input arrays, which is equal
74+
* :param num_values: Length of ``values``, also the number of elements in all three of the input arrays, which is equal
7575
*| to ``num_inputs`` plus the number of outputs.
7676
* :param num_inputs: Number of elements in the input arrays that represent inputs. The number of outputs is
77-
*| implicitly ``values_len`` - ``num_inputs``.
78-
* :param abf: Array of bytes representing ``values_len`` asset blinding factors.
79-
* :param abf_len: Length of ``abf`` in bytes. Must be ``values_len`` * ``BLINDING_FACTOR_LEN``.
80-
* :param vbf: Array of bytes representing (``values_len`` - 1) value blinding factors.
81-
* :param vbf_len: Length of ``vbf`` in bytes. Must be (``values_len`` - 1) * ``BLINDING_FACTOR_LEN``.
77+
*| implicitly ``num_values`` - ``num_inputs``.
78+
* :param abf: Array of bytes representing ``num_values`` asset blinding factors.
79+
* :param abf_len: Length of ``abf`` in bytes. Must be ``num_values`` * ``BLINDING_FACTOR_LEN``.
80+
* :param vbf: Array of bytes representing (``num_values`` - 1) value blinding factors.
81+
* :param vbf_len: Length of ``vbf`` in bytes. Must be (``num_values`` - 1) * ``BLINDING_FACTOR_LEN``.
8282
* :param bytes_out: Buffer to receive the final value blinding factor.
8383
* FIXED_SIZED_OUTPUT(len, bytes_out, BLINDING_FACTOR_LEN)
8484
*/
8585
WALLY_CORE_API int wally_asset_final_vbf(
8686
const uint64_t *values,
87-
size_t values_len,
87+
size_t num_values,
8888
size_t num_inputs,
8989
const unsigned char *abf,
9090
size_t abf_len,

src/elements.c

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ int wally_asset_generator_from_bytes(const unsigned char *asset, size_t asset_le
101101
return WALLY_OK;
102102
}
103103

104-
int wally_asset_final_vbf(const uint64_t *values, size_t values_len, size_t num_inputs,
104+
int wally_asset_final_vbf(const uint64_t *values, size_t num_values, size_t num_inputs,
105105
const unsigned char *abf, size_t abf_len,
106106
const unsigned char *vbf, size_t vbf_len,
107107
unsigned char *bytes_out, size_t len)
@@ -114,36 +114,36 @@ int wally_asset_final_vbf(const uint64_t *values, size_t values_len, size_t num_
114114
if (!ctx)
115115
return WALLY_ENOMEM;
116116

117-
if (!values || values_len < 2u ||
118-
num_inputs >= values_len ||
119-
!abf || abf_len != (values_len * BLINDING_FACTOR_LEN) ||
120-
!vbf || vbf_len != ((values_len - 1) * BLINDING_FACTOR_LEN) ||
117+
if (!values || num_values < 2u ||
118+
num_inputs >= num_values ||
119+
!abf || abf_len != (num_values * BLINDING_FACTOR_LEN) ||
120+
!vbf || vbf_len != ((num_values - 1) * BLINDING_FACTOR_LEN) ||
121121
!bytes_out || len != ASSET_TAG_LEN)
122122
return WALLY_EINVAL;
123123

124-
abf_p = wally_malloc(values_len * sizeof(unsigned char *));
125-
vbf_p = wally_malloc(values_len * sizeof(unsigned char *));
124+
abf_p = wally_malloc(num_values * sizeof(unsigned char *));
125+
vbf_p = wally_malloc(num_values * sizeof(unsigned char *));
126126

127127
if (!abf_p || !vbf_p) {
128128
ret = WALLY_ENOMEM;
129129
goto cleanup;
130130
}
131131

132-
for (i = 0; i < values_len; i++) {
132+
for (i = 0; i < num_values; i++) {
133133
abf_p[i] = abf + i * BLINDING_FACTOR_LEN;
134134
vbf_p[i] = vbf + i * BLINDING_FACTOR_LEN;
135135
}
136-
vbf_p[values_len - 1] = bytes_out;
136+
vbf_p[num_values - 1] = bytes_out;
137137
wally_clear(bytes_out, len);
138138

139139
if (secp256k1_pedersen_blind_generator_blind_sum(ctx, values, abf_p,
140140
(unsigned char *const *)vbf_p,
141-
values_len, num_inputs))
141+
num_values, num_inputs))
142142
ret = WALLY_OK;
143143

144144
cleanup:
145-
clear_and_free(abf_p, values_len * sizeof(unsigned char *));
146-
clear_and_free(vbf_p, values_len * sizeof(unsigned char *));
145+
clear_and_free(abf_p, num_values * sizeof(unsigned char *));
146+
clear_and_free(vbf_p, num_values * sizeof(unsigned char *));
147147
return ret;
148148
}
149149

src/swig_java/swig.i

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ static jbyteArray create_jintArray(JNIEnv *jenv, const uint32_t* p, size_t len)
301301
%apply(uint32_t *STRING, size_t LENGTH) { (const uint32_t *child_path, size_t child_path_len) }
302302
%apply(uint32_t *STRING, size_t LENGTH) { (uint32_t *child_path_out, size_t child_path_out_len) }
303303
%apply(uint32_t *STRING, size_t LENGTH) { (const uint32_t *sighash, size_t sighash_len) }
304-
%apply(uint64_t *STRING, size_t LENGTH) { (const uint64_t *values, size_t values_len) }
304+
%apply(uint64_t *STRING, size_t LENGTH) { (const uint64_t *values, size_t num_values) }
305305

306306
%typemap(in, numinputs=0) uint32_t *value_out (uint32_t val) {
307307
val = 0; $1 = ($1_ltype)&val;

src/swig_python/swig.i

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ static void destroy_words(PyObject *obj) { (void)obj; }
384384

385385
%py_int_array(uint32_t, 0xffffffffull, child_path, child_path_len)
386386
%py_int_array(uint32_t, 0xffull, sighash, sighash_len)
387-
%py_int_array(uint64_t, 0xffffffffffffffffull, values, values_len)
387+
%py_int_array(uint64_t, 0xffffffffffffffffull, values, num_values)
388388
%py_int_array_out(uint32_t, 0xffffffffull, child_path_out, child_path_out_len)
389389

390390
%py_opaque_struct(ext_key);

tools/build_wrappers.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,10 +138,12 @@ def add_metadata(self, m):
138138
': invalid metadata reference {}'.format(m) + ' refs: ' + str(len(args))
139139
args[0].add_metadata(m)
140140

141+
141142
def is_array(func, arg, n, num_args, types):
142143
return arg.type in types and n != num_args -1 and \
143144
func.args[n + 1].type == u'size_t' and \
144-
func.args[n + 1].name.endswith(u'len')
145+
(func.args[n + 1].name.endswith(u'len') or
146+
func.args[n + 1].name.startswith(u'num_'))
145147

146148

147149
def is_buffer(func, arg, n, num_args):
@@ -494,7 +496,7 @@ def map_args(func):
494496
ts_returns.append(f'{arg.name}: Ref_{arg.struct_name}')
495497
continue
496498

497-
assert False, f'ERROR: Unknown argument type "{arg.type}"'
499+
assert False, f'ERROR: {func.name}: Unknown argument type "{arg.type}" {arg.name}'
498500

499501
return (js_args, ts_args, ts_returns)
500502

0 commit comments

Comments
 (0)