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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
//! ## Multi-party signing
//!
//! This module contains various definitions that make multi-party signing easier.
//!
//! [`PartyBuilder`] makes it easy to build a transaction for signing with different rules.
//!
//! [`SigningParty`] is the simplest party. It computes a hash every time you want to sign it.
//!
//! [`PreHashedParty`] computes and stores the payload hash so it does not need to be recomputed.
//!
//! Both party types implement the common interface, the [`Party`] trait.

use std::collections::hash_map::Entry;
use std::collections::HashMap;

use rlp::RlpStream;

use crate::access::{
    AccountResponse, BlockHeaderResponse, GetAccountAtLatestBlockRequest,
    GetLatestBlockHeaderRequest,
};
use crate::account::PADDED_TRANSACTION_DOMAIN_TAG;
use crate::algorithms::{FlowHasher, FlowSigner};
use crate::client::GrpcClient;
use crate::error::BoxError;
use crate::prelude::Account;
use crate::protobuf::Seal;
use crate::transaction::rlp::{rlp_encode_transaction_envelope, rlp_encode_transaction_payload};
use crate::transaction::{ProposalKeyE, SignatureE, TransactionE};

/// The `Party` trait. You can get information about the transaction you are signing and sign it by
/// accepting some type that implements this trait.
///
/// This is `Sealed`, which means no foreign types may implement it, and it is not **Object safe**,
/// so no one can create bad behaving trait objects which can make this trait insecure.
pub trait Party<H: FlowHasher>: Sized + private::Sealed {
    ///////////////////
    // INFORMATION

    /// Gets the script of the transaction.
    fn script(&self) -> &str;

    /// Gets the arguments of the transaction.
    fn arguments(&self) -> &[Box<[u8]>];

    /// Gets the reference block of the transaction.
    fn reference_block(&self) -> &[u8];

    /// Gets the gas limit of the transaction.
    fn gas_limit(&self) -> u64;

    /// Gets the address of the proposer of the transaction.
    fn proposer_address(&self) -> &[u8];

    /// Gets the key ID number of the proposal key.
    fn proposal_key_id(&self) -> u64;

    /// Gets the sequence number of the proposal key.
    fn proposer_sequence_number(&self) -> u64;

    /// Gets the address of the payer of the transaction.
    fn payer(&self) -> &[u8];

    /// Gets the addresses of the authorizers of the transaciton.
    fn authorizers(&self) -> &[Box<[u8]>];

    ///////////////////
    // HASHES

    /// Computes the hash of the payload.
    fn payload(&self) -> H;

    /// Computes the hash of the envelope.
    fn envelope(&self) -> H;

    ///////////////////
    // MUTATE/CONVERT

    /// Adds a payload signature.
    fn add_payload_signature(
        &mut self,
        signer_address: Box<[u8]>,
        signer_id: u32,
        signature: [u8; 64],
    );

    /// Creates a [`PartyTransaction`] by feeding this party with envelope signatures.
    fn into_transaction_with_envelope_signatures<SigAddr, Sig>(
        self,
        signatures: impl IntoIterator<Item = SignatureE<SigAddr, Sig>>,
    ) -> PartyTransaction<SigAddr, Sig>;
}

/// After envelope signatures are fed to a party, it turns into a transaction.
///
/// This is the exact type a party will turn in to.
pub type PartyTransaction<SigAddr, Sig> = TransactionE<
    Box<[u8]>,
    Vec<Box<[u8]>>,
    Box<[u8]>,
    Box<[u8]>,
    Box<[u8]>,
    Vec<Box<[u8]>>,
    Vec<SignatureE<Box<[u8]>, [u8; 64]>>,
    Vec<SignatureE<SigAddr, Sig>>,
>;

/// A builder that makes it easy to create new [`SigningParty`] instances.
///
/// ```
/// # use flow_sdk::multi::{PartyBuilder, SigningParty};
/// # use cadence_json::ValueRef;
///
/// let party = PartyBuilder::new()
///     .script("s")
///     .reference_block([0])
///     .gas_limit(123)
///     .proposer_address([1])
///     .proposal_key_id(2)
///     .proposal_key_sequence_number(3)
///     .payer([4])
///     .authorizer([5])
///     .build();
///
/// let party2 = SigningParty::new("s".into(), [].into(), [0].into(), 123, [1].into(), 2, 3, [4].into(), [[5].into()].into());
///
/// assert_eq!(party, party2);
/// ```
#[derive(Clone)]
pub struct PartyBuilder {
    script: Option<Box<str>>,
    arguments: Vec<Box<[u8]>>,
    reference_block: Option<Box<[u8]>>,
    gas_limit: u64,
    proposer_address: Option<Box<[u8]>>,
    proposal_key_id: Option<u64>,
    proposal_key_sequence_number: Option<u64>,
    payer: Option<Box<[u8]>>,
    authorizers: Vec<Box<[u8]>>,
}

impl PartyBuilder {
    /// Creates a new `PartyBuilder` with the default gas limit of `1000`.
    #[inline]
    pub const fn new() -> Self {
        Self {
            script: None,
            arguments: Vec::new(),
            reference_block: None,
            gas_limit: 1000,
            proposer_address: None,
            proposal_key_id: None,
            proposal_key_sequence_number: None,
            payer: None,
            authorizers: Vec::new(),
        }
    }

    /// Sets the script of the transaction.
    pub fn script(mut self, script: impl Into<Box<str>>) -> Self {
        self.script = Some(script.into());
        self
    }

    /// Appends a new argument.
    pub fn argument(self, argument: impl serde::Serialize) -> Self {
        self.argument_raw(serde_json::to_vec(&argument).unwrap())
    }

    /// Appends arguments.
    pub fn arguments(self, arguments: impl IntoIterator<Item = impl serde::Serialize>) -> Self {
        self.arguments_raw(
            arguments
                .into_iter()
                .map(|val| serde_json::to_vec(&val).unwrap()),
        )
    }

    /// Appends a new UTF-8 encoded argument in Cadence JSON interchange format.
    pub fn argument_raw(mut self, argument: impl Into<Box<[u8]>>) -> Self {
        self.arguments.push(argument.into());
        self
    }

    /// Appends raw UTF-8 encoded arguments in Cadence JSON interchange format.
    pub fn arguments_raw(
        mut self,
        arguments: impl IntoIterator<Item = impl Into<Box<[u8]>>>,
    ) -> Self {
        self.arguments.extend(arguments.into_iter().map(Into::into));
        self
    }

    /// Sets the reference block for this transaction.
    pub fn reference_block(mut self, reference_block: impl Into<Box<[u8]>>) -> Self {
        self.reference_block = Some(reference_block.into());
        self
    }

    /// Uses the latest block as the reference block for this transaction.
    pub async fn latest_block_as_reference<
        C: GrpcClient<GetLatestBlockHeaderRequest, BlockHeaderResponse>,
    >(
        mut self,
        client: &mut C,
    ) -> Result<Self, C::Error> {
        self.reference_block = Some(
            client
                .send(GetLatestBlockHeaderRequest { seal: Seal::Sealed })
                .await?
                .0
                .id,
        );
        Ok(self)
    }

    /// Sets the gas limit of this transation.
    pub fn gas_limit(mut self, limit: u64) -> Self {
        self.gas_limit = limit;
        self
    }

    /// Sets the address of the account that proposes this transaction.
    pub fn proposer_address(mut self, addr: impl Into<Box<[u8]>>) -> Self {
        self.proposer_address = Some(addr.into());
        self
    }

    /// Sets the key id of the proposal key of this transaction.
    pub fn proposal_key_id(mut self, id: u64) -> Self {
        self.proposal_key_id = Some(id);
        self
    }

    /// Sets the sequence number of the proposal key of this transaction.
    pub fn proposal_key_sequence_number(mut self, sequence_number: u64) -> Self {
        self.proposal_key_sequence_number = Some(sequence_number);
        self
    }

    /// Sets the address, key id and the sequence number by querying on the network about
    /// a logged-in account.
    pub async fn proposer_account<'a, C, Sk, Sign, Hash>(
        mut self,
        acc: &'a mut Account<C, Sk, Sign, Hash>,
    ) -> Result<Self, BoxError>
    where
        C: GrpcClient<GetAccountAtLatestBlockRequest<&'a [u8]>, AccountResponse>,
        Sign: FlowSigner<SecretKey = Sk>,
        Hash: FlowHasher,
    {
        self.proposer_address = Some(acc.address().into());
        self.proposal_key_id = Some(acc.primary_key_id().into());
        self.proposal_key_sequence_number = Some(acc.primary_key_sequence_number().await?.into());
        Ok(self)
    }

    /// Sets the address of the account that will pay for this transaction.
    pub fn payer(mut self, address: impl Into<Box<[u8]>>) -> Self {
        self.payer = Some(address.into());
        self
    }

    /// Records the address of the account that will pay for this transaction.
    #[inline]
    pub fn payer_account<C, S, Si, H>(self, acc: &Account<C, S, Si, H>) -> Self {
        self.payer(acc.address())
    }

    /// Appends the address of an account which authorizes this transaction.
    pub fn authorizer(mut self, address: impl Into<Box<[u8]>>) -> Self {
        self.authorizers.push(address.into());
        self
    }

    /// Appends the addresses of accounts that authorizes this transaction.
    pub fn authorizers(
        mut self,
        addresses: impl IntoIterator<Item = impl Into<Box<[u8]>>>,
    ) -> Self {
        self.authorizers
            .extend(addresses.into_iter().map(Into::into));
        self
    }

    /// Appends the address of an account which authorizers this transaction.
    #[inline]
    pub fn authorizer_account<C, S, Si, H>(self, acc: &Account<C, S, Si, H>) -> Self {
        self.authorizer(acc.address())
    }

    /// Appends the addresses of accounts that authorizes this transaction.
    #[inline]
    pub fn authorizer_accounts<'a, C: 'a, S: 'a, Si: 'a, H: 'a>(
        self,
        acc: impl IntoIterator<Item = &'a Account<C, S, Si, H>>,
    ) -> Self {
        self.authorizers(acc.into_iter().map(Account::address))
    }

    /// Builds a [`SigningParty`] from this builder, assuming all fields have been set.
    pub fn build(self) -> SigningParty {
        SigningParty::new(
            self.script.unwrap(),
            self.arguments.into(),
            self.reference_block.unwrap(),
            self.gas_limit,
            self.proposer_address.unwrap(),
            self.proposal_key_id.unwrap(),
            self.proposal_key_sequence_number.unwrap(),
            self.payer.unwrap(),
            self.authorizers.into(),
        )
    }

    /// Builds a [`PreHashedParty`] from this builder, assuming all fields have been set.
    #[inline]
    pub fn build_prehashed<H: FlowHasher>(self) -> PreHashedParty<H> {
        self.build().into_prehashed()
    }
}

impl Default for PartyBuilder {
    #[inline]
    fn default() -> Self {
        Self::new()
    }
}

/// A basic signing party. Contains all the information needed to make signatures.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct SigningParty {
    script: Box<str>,
    arguments: Box<[Box<[u8]>]>,
    reference_block: Box<[u8]>,
    gas_limit: u64,
    proposer_address: Box<[u8]>,
    proposal_key_id: u64,
    proposal_key_sequence_number: u64,
    payer: Box<[u8]>,
    authorizers: Box<[Box<[u8]>]>,
    payload_signatures: Vec<SignatureE<Box<[u8]>, [u8; 64]>>,
    signer_map: HashMap<Box<[u8]>, u32>,
}

impl<H: FlowHasher> Party<H> for SigningParty {
    fn script(&self) -> &str {
        &self.script
    }

    fn arguments(&self) -> &[Box<[u8]>] {
        &self.arguments
    }

    fn reference_block(&self) -> &[u8] {
        &self.reference_block
    }

    fn gas_limit(&self) -> u64 {
        self.gas_limit
    }

    fn proposer_address(&self) -> &[u8] {
        &self.proposer_address
    }

    fn proposal_key_id(&self) -> u64 {
        self.proposal_key_id
    }

    fn proposer_sequence_number(&self) -> u64 {
        self.proposal_key_sequence_number
    }

    fn payer(&self) -> &[u8] {
        &self.payer
    }

    fn authorizers(&self) -> &[Box<[u8]>] {
        &self.authorizers
    }

    fn payload(&self) -> H {
        let mut hasher = H::new();
        hasher.update(&PADDED_TRANSACTION_DOMAIN_TAG);
        let mut stream = RlpStream::new();
        rlp_encode_transaction_payload(
            &mut stream,
            &*self.script,
            self.arguments.iter(),
            self.reference_block.iter(),
            self.gas_limit,
            &self.proposer_address,
            self.proposal_key_id,
            self.proposal_key_sequence_number,
            &self.payer,
            self.authorizers.iter(),
        );
        hasher.update(&stream.out());

        hasher
    }

    fn add_payload_signature(
        &mut self,
        signer_address: Box<[u8]>,
        signer_id: u32,
        signature: [u8; 64],
    ) {
        self.payload_signatures.push(SignatureE {
            address: signer_address,
            key_id: signer_id,
            signature,
        });
    }

    fn envelope(&self) -> H {
        let mut hasher = H::new();
        hasher.update(&PADDED_TRANSACTION_DOMAIN_TAG);
        let mut stream = RlpStream::new();
        rlp_encode_transaction_envelope(
            &mut stream,
            &*self.script,
            self.arguments.iter(),
            &self.reference_block,
            self.gas_limit,
            &self.proposer_address,
            self.proposal_key_id,
            self.proposal_key_sequence_number,
            &self.payer,
            self.authorizers.iter(),
            self.payload_signatures.iter().map(|sig| {
                (
                    *self.signer_map.get(&sig.address).unwrap(),
                    sig.key_id,
                    &sig.signature,
                )
            }),
        );
        hasher.update(&stream.out());
        hasher
    }

    fn into_transaction_with_envelope_signatures<SigAddr, Sig>(
        self,
        signatures: impl IntoIterator<Item = SignatureE<SigAddr, Sig>>,
    ) -> PartyTransaction<SigAddr, Sig> {
        TransactionE {
            script: self.script.into_boxed_bytes(),
            arguments: self.arguments.into(),
            reference_block_id: self.reference_block,
            gas_limit: self.gas_limit,
            proposal_key: ProposalKeyE {
                address: self.proposer_address,
                key_id: self.proposal_key_id as u32,
                sequence_number: self.proposal_key_sequence_number,
            },
            payer: self.payer,
            authorizers: self.authorizers.into(),
            payload_signatures: self.payload_signatures,
            envelope_signatures: signatures.into_iter().collect(),
        }
    }
}

impl SigningParty {
    /// Builds a signer address to signer index map.
    pub fn build_signer_map(
        proposer: &[u8],
        payer: &[u8],
        authorizers: &[impl AsRef<[u8]>],
    ) -> HashMap<Box<[u8]>, u32> {
        let mut map: HashMap<Box<[u8]>, u32> = HashMap::new();
        map.insert(proposer.into(), 0);

        let mut add = |addr: &[u8]| {
            let len = map.len();
            if let Entry::Vacant(entry) = map.entry(addr.into()) {
                entry.insert(len as u32);
            }
        };

        add(payer);

        for authorizer in authorizers {
            add(authorizer.as_ref());
        }

        map
    }

    /// Creates a new [`SigningParty`] with all the data associated to a transaction.
    #[allow(clippy::too_many_arguments)]
    pub fn new(
        script: Box<str>,
        arguments: Box<[Box<[u8]>]>,
        reference_block: Box<[u8]>,
        gas_limit: u64,
        proposer_address: Box<[u8]>,
        proposal_key_id: u64,
        proposal_key_sequence_number: u64,
        payer: Box<[u8]>,
        authorizers: Box<[Box<[u8]>]>,
    ) -> Self {
        let signer_map = Self::build_signer_map(&proposer_address, &payer, &authorizers);
        Self {
            script,
            arguments,
            reference_block,
            gas_limit,
            proposer_address,
            proposal_key_id,
            proposal_key_sequence_number,
            payer,
            authorizers,
            payload_signatures: Vec::new(),
            signer_map,
        }
    }

    /// Computes the payload hash of this party, and turns this into a [`PreHashedParty`].
    pub fn into_prehashed<H: FlowHasher>(self) -> PreHashedParty<H> {
        let payload = self.payload();
        PreHashedParty {
            party: self,
            payload,
        }
    }
}

/// A party that prepopulates hashed payload and sends that around for signing.
///
/// The party only supports one type of hashing algorithm,
/// which means that all entities involved must use the same algorithm.
///
/// Note that this can be a bit less secure than using [`SigningParty`].
/// A malicious attacker may modify the payload using unsafe pointer operations.
#[derive(Clone, PartialEq, Eq)]
pub struct PreHashedParty<H> {
    party: SigningParty,
    payload: H,
}

impl<H: FlowHasher> PreHashedParty<H> {
    /// Creates a new [`PreHashedParty`] with all the data associated to a transaction.
    #[allow(clippy::too_many_arguments)]
    pub fn new(
        script: Box<str>,
        arguments: Box<[Box<[u8]>]>,
        reference_block: Box<[u8]>,
        gas_limit: u64,
        proposer_address: Box<[u8]>,
        proposal_key_id: u64,
        proposal_key_sequence_number: u64,
        payer: Box<[u8]>,
        authorizers: Box<[Box<[u8]>]>,
    ) -> Self {
        let party = SigningParty::new(
            script,
            arguments,
            reference_block,
            gas_limit,
            proposer_address,
            proposal_key_id,
            proposal_key_sequence_number,
            payer,
            authorizers,
        );
        let payload = party.payload();
        Self { party, payload }
    }
}

impl<H: FlowHasher + Clone> Party<H> for PreHashedParty<H> {
    fn payload(&self) -> H {
        self.payload.clone()
    }

    fn add_payload_signature(
        &mut self,
        signer_address: Box<[u8]>,
        signer_id: u32,
        signature: [u8; 64],
    ) {
        <SigningParty as Party<H>>::add_payload_signature(
            &mut self.party,
            signer_address,
            signer_id,
            signature,
        )
    }

    fn envelope(&self) -> H {
        self.party.envelope()
    }

    fn script(&self) -> &str {
        <SigningParty as Party<H>>::script(&self.party)
    }

    fn arguments(&self) -> &[Box<[u8]>] {
        <SigningParty as Party<H>>::arguments(&self.party)
    }

    fn reference_block(&self) -> &[u8] {
        <SigningParty as Party<H>>::reference_block(&self.party)
    }

    fn gas_limit(&self) -> u64 {
        <SigningParty as Party<H>>::gas_limit(&self.party)
    }

    fn proposer_address(&self) -> &[u8] {
        <SigningParty as Party<H>>::proposer_address(&self.party)
    }

    fn proposal_key_id(&self) -> u64 {
        <SigningParty as Party<H>>::proposal_key_id(&self.party)
    }

    fn proposer_sequence_number(&self) -> u64 {
        <SigningParty as Party<H>>::proposer_sequence_number(&self.party)
    }

    fn payer(&self) -> &[u8] {
        <SigningParty as Party<H>>::payer(&self.party)
    }

    fn authorizers(&self) -> &[Box<[u8]>] {
        <SigningParty as Party<H>>::authorizers(&self.party)
    }

    fn into_transaction_with_envelope_signatures<SigAddr, Sig>(
        self,
        signatures: impl IntoIterator<Item = SignatureE<SigAddr, Sig>>,
    ) -> PartyTransaction<SigAddr, Sig> {
        <SigningParty as Party<H>>::into_transaction_with_envelope_signatures(
            self.party, signatures,
        )
    }
}

mod private {
    use crate::algorithms::FlowHasher;

    pub trait Sealed {}
    impl<H: FlowHasher> Sealed for super::PreHashedParty<H> {}
    impl Sealed for super::SigningParty {}
}