-
Notifications
You must be signed in to change notification settings - Fork 428
/
create_builder.rs
972 lines (924 loc) · 27.2 KB
/
create_builder.rs
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
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
// Copyright (C) Use Ink (UK) Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use crate::{
call::{
utils::{
EmptyArgumentList,
ReturnType,
Set,
Unset,
},
ExecutionInput,
Selector,
},
ContractEnv,
Environment,
Error,
};
use core::marker::PhantomData;
pub mod state {
//! Type states that tell what state of a instantiation argument has not
//! yet been set properly for a valid construction.
/// Type state for the salt used for contract instantiation.
pub enum Salt {}
}
/// Contracts that can be constructed from an `AccountId`.
///
/// # Note
///
/// This is needed because of conflicting implementations of `From<T> for T`
/// in the generated code of `ink`.
///
/// But it is possible to use `From<AccountId> for T` with [`crate::AccountIdGuard`]
/// bound.
pub trait FromAccountId<T>
where
T: Environment,
{
/// Creates the contract instance from the account ID of the already instantiated
/// contract.
fn from_account_id(account_id: <T as Environment>::AccountId) -> Self;
}
/// Represents any type that can be returned from an `ink!` constructor. The following
/// contract implements the four different return type signatures implementing this trait:
///
/// - `Self`
/// - `Result<Self, Error>`
/// - `Contract`
/// - `Result<Contract, Error>`
///
/// ```rust
/// #[ink::contract]
/// mod contract {
/// #[ink(storage)]
/// pub struct Contract {}
///
/// #[derive(Debug, PartialEq, Eq)]
/// #[ink::scale_derive(Encode, Decode, TypeInfo)]
/// pub enum Error {
/// Foo,
/// }
///
/// impl Contract {
/// #[ink(constructor)]
/// pub fn new_self() -> Self {
/// Self {}
/// }
///
/// #[ink(constructor)]
/// pub fn new_storage_name() -> Contract {
/// Contract {}
/// }
///
/// #[ink(constructor)]
/// pub fn new_result_self() -> Result<Self, Error> {
/// Ok(Self {})
/// }
///
/// #[ink(constructor)]
/// pub fn new_result_storage_name() -> Result<Contract, Error> {
/// Ok(Contract {})
/// }
///
/// #[ink(message)]
/// pub fn message(&self) {}
/// }
/// }
/// ```
///
/// These constructor return signatures are then used by the `ContractRef` codegen for the
/// [`CreateBuilder::returns`] type parameter.
pub trait ConstructorReturnType<C> {
/// Is `true` if `Self` is `Result<C, E>`.
const IS_RESULT: bool = false;
/// The actual return type of the constructor.
/// - If a constructor returns `Self`, then `Output = Self`
/// - If a constructor returns a `Result<Self, E>`, then `Output = Result<Self, E>`
type Output;
/// The error type of the constructor return type.
type Error: scale::Decode;
/// Construct a success value of the `Output` type.
fn ok(value: C) -> Self::Output;
/// Construct an error value of the `Output` type.
///
/// `Result` implementations should return `Some(Err(err))`, otherwise default to
/// `None`.
fn err(_err: Self::Error) -> Option<Self::Output> {
None
}
}
/// Blanket implementation for `ContractRef` types, generated for cross-contract calls.
///
/// In the context of a `ContractRef` inherent, `Self` from a constructor return
/// type will become the type of the `ContractRef`'s type.
impl<C> ConstructorReturnType<C> for C
where
C: ContractEnv + FromAccountId<<C as ContractEnv>::Env>,
{
type Output = C;
type Error = ();
fn ok(value: C) -> Self::Output {
value
}
}
/// Blanket implementation for a `Result<Self>` return type. `Self` in the context
/// of a `ContractRef` inherent becomes the `ContractRef`s type.
impl<C, E> ConstructorReturnType<C> for core::result::Result<C, E>
where
C: ContractEnv + FromAccountId<<C as ContractEnv>::Env>,
E: scale::Decode,
{
const IS_RESULT: bool = true;
type Output = core::result::Result<C, E>;
type Error = E;
fn ok(value: C) -> Self::Output {
Ok(value)
}
fn err(err: Self::Error) -> Option<Self::Output> {
Some(Err(err))
}
}
/// Defines the limit params for the legacy `ext::instantiate_v1` host function,
/// consisting of the `gas_limit` which is equivalent to the `ref_time_limit` in the new
/// `ext::instantiate`.
#[derive(Clone, Debug)]
pub struct LimitParamsV1 {
gas_limit: u64,
}
/// Defines the limit params for the new `ext::instantiate` host function.
#[derive(Clone, Debug)]
pub struct LimitParamsV2<E>
where
E: Environment,
{
ref_time_limit: u64,
proof_size_limit: u64,
storage_deposit_limit: Option<E::Balance>,
}
/// Builds up contract instantiations.
#[derive(Debug)]
pub struct CreateParams<E, ContractRef, Limits, Args, Salt, R>
where
E: Environment,
{
/// The code hash of the created contract.
code_hash: E::Hash,
/// Parameters for weight and storage limits, differs for versions of the instantiate
/// host function.
limits: Limits,
/// The endowment for the instantiated contract.
endowment: E::Balance,
/// The input data for the instantiation.
exec_input: ExecutionInput<Args>,
/// The salt for determining the hash for the contract account ID.
salt_bytes: Salt,
/// The return type of the target contract's constructor method.
_return_type: ReturnType<R>,
/// The type of the reference to the contract returned from the constructor.
_phantom: PhantomData<fn() -> ContractRef>,
}
impl<E, ContractRef, Limits, Args, Salt, R>
CreateParams<E, ContractRef, Limits, Args, Salt, R>
where
E: Environment,
{
/// The code hash of the contract.
#[inline]
pub fn code_hash(&self) -> &E::Hash {
&self.code_hash
}
/// The endowment for the instantiated contract.
#[inline]
pub fn endowment(&self) -> &E::Balance {
&self.endowment
}
/// The raw encoded input data.
#[inline]
pub fn exec_input(&self) -> &ExecutionInput<Args> {
&self.exec_input
}
/// Modify the selector.
///
/// Useful when using the [`CreateParams`] generated as part of the
/// `ContractRef`, but using a custom selector.
pub fn update_selector(&mut self, selector: Selector) {
self.exec_input.update_selector(selector)
}
}
impl<E, ContractRef, Args, Salt, R>
CreateParams<E, ContractRef, LimitParamsV2<E>, Args, Salt, R>
where
E: Environment,
{
/// Gets the `ref_time_limit` part of the weight limit for the contract instantiation.
#[inline]
pub fn ref_time_limit(&self) -> u64 {
self.limits.ref_time_limit
}
/// Gets the `proof_size_limit` part of the weight limit for the contract
/// instantiation.
#[inline]
pub fn proof_size_limit(&self) -> u64 {
self.limits.proof_size_limit
}
/// Gets the `storage_deposit_limit` for the contract instantiation.
#[inline]
pub fn storage_deposit_limit(&self) -> Option<&E::Balance> {
self.limits.storage_deposit_limit.as_ref()
}
}
impl<E, ContractRef, Args, Salt, R>
CreateParams<E, ContractRef, LimitParamsV1, Args, Salt, R>
where
E: Environment,
{
/// The gas limit for the contract instantiation.
#[inline]
pub fn gas_limit(&self) -> u64 {
self.limits.gas_limit
}
}
impl<E, ContractRef, Limits, Args, Salt, R>
CreateParams<E, ContractRef, Limits, Args, Salt, R>
where
E: Environment,
Salt: AsRef<[u8]>,
{
/// The salt for determining the hash for the contract account ID.
#[inline]
pub fn salt_bytes(&self) -> &Salt {
&self.salt_bytes
}
}
impl<E, ContractRef, Args, Salt, R>
CreateParams<E, ContractRef, LimitParamsV2<E>, Args, Salt, R>
where
E: Environment,
ContractRef: FromAccountId<E>,
Args: scale::Encode,
Salt: AsRef<[u8]>,
R: ConstructorReturnType<ContractRef>,
{
/// Instantiates the contract and returns its account ID back to the caller.
///
/// # Panics
///
/// This method panics if it encounters an [`ink::env::Error`][`crate::Error`] or an
/// [`ink::primitives::LangError`][`ink_primitives::LangError`]. If you want to handle
/// those use the [`try_instantiate`][`CreateParams::try_instantiate`] method
/// instead.
#[inline]
pub fn instantiate(&self) -> <R as ConstructorReturnType<ContractRef>>::Output {
crate::instantiate_contract(self)
.unwrap_or_else(|env_error| {
panic!("Cross-contract instantiation failed with {env_error:?}")
})
.unwrap_or_else(|lang_error| {
panic!("Received a `LangError` while instantiating: {lang_error:?}")
})
}
/// Instantiates the contract and returns its account ID back to the caller.
///
/// # Note
///
/// On failure this returns an outer [`ink::env::Error`][`crate::Error`] or inner
/// [`ink::primitives::LangError`][`ink_primitives::LangError`], both of which can be
/// handled by the caller.
#[inline]
pub fn try_instantiate(
&self,
) -> Result<
ink_primitives::ConstructorResult<
<R as ConstructorReturnType<ContractRef>>::Output,
>,
Error,
> {
crate::instantiate_contract(self)
}
}
impl<E, ContractRef, Args, Salt, R>
CreateParams<E, ContractRef, LimitParamsV1, Args, Salt, R>
where
E: Environment,
ContractRef: FromAccountId<E>,
Args: scale::Encode,
Salt: AsRef<[u8]>,
R: ConstructorReturnType<ContractRef>,
{
/// Instantiates the contract and returns its account ID back to the caller.
///
/// # Panics
///
/// This method panics if it encounters an [`ink::env::Error`][`crate::Error`] or an
/// [`ink::primitives::LangError`][`ink_primitives::LangError`]. If you want to handle
/// those use the [`try_instantiate`][`CreateParams::try_instantiate`] method
/// instead.
#[inline]
pub fn instantiate(&self) -> <R as ConstructorReturnType<ContractRef>>::Output {
self.try_instantiate()
.unwrap_or_else(|env_error| {
panic!("Cross-contract instantiation failed with {env_error:?}")
})
.unwrap_or_else(|lang_error| {
panic!("Received a `LangError` while instantiating: {lang_error:?}")
})
}
/// Instantiates the contract and returns its account ID back to the caller.
///
/// # Note
///
/// On failure this returns an outer [`ink::env::Error`][`crate::Error`] or inner
/// [`ink::primitives::LangError`][`ink_primitives::LangError`], both of which can be
/// handled by the caller.
#[inline]
pub fn try_instantiate(
&self,
) -> Result<
ink_primitives::ConstructorResult<
<R as ConstructorReturnType<ContractRef>>::Output,
>,
Error,
> {
crate::instantiate_contract_v1(self)
}
}
/// Builds up contract instantiations.
#[derive(Clone)]
pub struct CreateBuilder<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt, RetType>
where
E: Environment,
{
code_hash: CodeHash,
limits: Limits,
endowment: Endowment,
exec_input: Args,
salt: Salt,
return_type: RetType,
_phantom: PhantomData<fn() -> (E, ContractRef)>,
}
/// Returns a new [`CreateBuilder`] to build up the parameters to a cross-contract
/// instantiation.
///
/// # Example
///
/// **Note:** The shown examples panic because there is currently no cross-calling
/// support in the off-chain testing environment. However, this code
/// should work fine in on-chain environments.
///
/// ## Example 1: Returns Address of Instantiated Contract
///
/// The below example shows instantiation of contract of type `MyContract`.
///
/// The used constructor:
///
/// - has a selector equal to `0xDEADBEEF`
/// - is provided with 4000 units of gas for its execution
/// - is provided with 25 units of transferred value for the new contract instance
/// - receives the following arguments in order 1. an `i32` with value `42` 2. a `bool`
/// with value `true` 3. an array of 32 `u8` with value `0x10`
///
/// ```should_panic
/// # use ::ink_env::{
/// # Environment,
/// # DefaultEnvironment,
/// # call::{build_create, Selector, ExecutionInput, FromAccountId}
/// # };
/// # type Hash = <DefaultEnvironment as Environment>::Hash;
/// #
/// # #[ink::contract]
/// # pub mod contract {
/// # #[ink(storage)]
/// # pub struct MyContract {}
/// #
/// # impl MyContract {
/// # #[ink(constructor)]
/// # pub fn my_constructor() -> Self { Self {} }
/// #
/// # #[ink(message)]
/// # pub fn message(&self) {}
/// # }
/// # }
/// # use contract::MyContractRef;
/// let my_contract: MyContractRef = build_create::<MyContractRef>()
/// .code_hash(Hash::from([0x42; 32]))
/// .endowment(25)
/// .exec_input(
/// ExecutionInput::new(Selector::new(ink::selector_bytes!("my_constructor")))
/// .push_arg(42)
/// .push_arg(true)
/// .push_arg(&[0x10u8; 32]),
/// )
/// .salt_bytes(&[0xDE, 0xAD, 0xBE, 0xEF])
/// .returns::<MyContractRef>()
/// .instantiate();
/// ```
///
/// ## Example 2: Handles Result from Fallible Constructor
///
/// ```should_panic
/// # use ::ink_env::{
/// # Environment,
/// # DefaultEnvironment,
/// # call::{build_create, Selector, ExecutionInput, FromAccountId}
/// # };
/// # type Hash = <DefaultEnvironment as Environment>::Hash;
/// #
/// # #[ink::contract]
/// # pub mod contract {
/// # #[derive(scale::Encode, scale::Decode, Debug)]
/// # #[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]
/// # pub struct ConstructorError;
/// #
/// # #[ink(storage)]
/// # pub struct MyContract {}
/// #
/// # impl MyContract {
/// # #[ink(constructor)]
/// # pub fn my_constructor() -> Result<Self, ConstructorError> {
/// # Ok(Self {})
/// # }
/// #
/// # #[ink(message)]
/// # pub fn message(&self) {}
/// # }
/// # }
/// # use contract::{MyContractRef, ConstructorError};
/// let my_contract: MyContractRef = build_create::<MyContractRef>()
/// .code_hash(Hash::from([0x42; 32]))
/// .endowment(25)
/// .exec_input(
/// ExecutionInput::new(Selector::new(ink::selector_bytes!("my_constructor")))
/// .push_arg(42)
/// .push_arg(true)
/// .push_arg(&[0x10u8; 32]),
/// )
/// .salt_bytes(&[0xDE, 0xAD, 0xBE, 0xEF])
/// .returns::<Result<MyContractRef, ConstructorError>>()
/// .instantiate()
/// .expect("Constructor should have executed successfully.");
/// ```
#[allow(clippy::type_complexity)]
pub fn build_create<ContractRef>() -> CreateBuilder<
<ContractRef as ContractEnv>::Env,
ContractRef,
Unset<<<ContractRef as ContractEnv>::Env as Environment>::Hash>,
Set<LimitParamsV2<<ContractRef as ContractEnv>::Env>>,
Unset<<<ContractRef as ContractEnv>::Env as Environment>::Balance>,
Unset<ExecutionInput<EmptyArgumentList>>,
Unset<state::Salt>,
Unset<ReturnType<()>>,
>
where
ContractRef: ContractEnv,
{
CreateBuilder {
code_hash: Default::default(),
limits: Set(LimitParamsV2 {
ref_time_limit: 0,
proof_size_limit: 0,
storage_deposit_limit: None,
}),
endowment: Default::default(),
exec_input: Default::default(),
salt: Default::default(),
return_type: Default::default(),
_phantom: Default::default(),
}
}
impl<E, ContractRef, Limits, Endowment, Args, Salt, RetType>
CreateBuilder<E, ContractRef, Unset<E::Hash>, Limits, Endowment, Args, Salt, RetType>
where
E: Environment,
{
/// Sets the used code hash for the contract instantiation.
#[inline]
pub fn code_hash(
self,
code_hash: E::Hash,
) -> CreateBuilder<E, ContractRef, Set<E::Hash>, Limits, Endowment, Args, Salt, RetType>
{
CreateBuilder {
code_hash: Set(code_hash),
limits: self.limits,
endowment: self.endowment,
exec_input: self.exec_input,
salt: self.salt,
return_type: self.return_type,
_phantom: Default::default(),
}
}
}
impl<E, ContractRef, CodeHash, Endowment, Args, Salt, RetType>
CreateBuilder<
E,
ContractRef,
CodeHash,
Set<LimitParamsV1>,
Endowment,
Args,
Salt,
RetType,
>
where
E: Environment,
{
/// Sets the maximum allowed gas costs for the contract instantiation.
#[inline]
pub fn gas_limit(self, gas_limit: u64) -> Self {
CreateBuilder {
limits: Set(LimitParamsV1 { gas_limit }),
..self
}
}
}
impl<E, ContractRef, CodeHash, Endowment, Args, Salt, RetType>
CreateBuilder<
E,
ContractRef,
CodeHash,
Set<LimitParamsV2<E>>,
Endowment,
Args,
Salt,
RetType,
>
where
E: Environment,
{
/// Switch to the original `instantiate` host function API, which only allows the
/// `gas_limit` limit parameter (equivalent to the `ref_time_limit` in the latest
/// `instantiate_v2`).
///
/// This method instance is used to allow usage of the generated builder methods
/// for constructors which initialize the builder with the new [`LimitParamsV2`] type.
#[inline]
pub fn instantiate_v1(
self,
) -> CreateBuilder<
E,
ContractRef,
CodeHash,
Set<LimitParamsV1>,
Endowment,
Args,
Salt,
RetType,
> {
CreateBuilder {
code_hash: self.code_hash,
limits: Set(LimitParamsV1 {
gas_limit: self.limits.value().ref_time_limit,
}),
endowment: self.endowment,
exec_input: self.exec_input,
salt: self.salt,
return_type: self.return_type,
_phantom: Default::default(),
}
}
/// Sets the `ref_time_limit` part of the weight limit for the contract instantiation.
#[inline]
pub fn ref_time_limit(self, ref_time_limit: u64) -> Self {
CreateBuilder {
limits: Set(LimitParamsV2 {
ref_time_limit,
..self.limits.value()
}),
..self
}
}
/// Sets the `proof_size_limit` part of the weight limit for the contract
/// instantiation.
#[inline]
pub fn proof_size_limit(self, proof_size_limit: u64) -> Self {
CreateBuilder {
limits: Set(LimitParamsV2 {
proof_size_limit,
..self.limits.value()
}),
..self
}
}
/// Sets the `storage_deposit_limit` for the contract instantiation.
#[inline]
pub fn storage_deposit_limit(self, storage_deposit_limit: E::Balance) -> Self {
CreateBuilder {
limits: Set(LimitParamsV2 {
storage_deposit_limit: Some(storage_deposit_limit),
..self.limits.value()
}),
..self
}
}
}
impl<E, ContractRef, CodeHash, Limits, Args, Salt, RetType>
CreateBuilder<
E,
ContractRef,
CodeHash,
Limits,
Unset<E::Balance>,
Args,
Salt,
RetType,
>
where
E: Environment,
{
/// Sets the value transferred upon the execution of the call.
#[inline]
pub fn endowment(
self,
endowment: E::Balance,
) -> CreateBuilder<
E,
ContractRef,
CodeHash,
Limits,
Set<E::Balance>,
Args,
Salt,
RetType,
> {
CreateBuilder {
code_hash: self.code_hash,
limits: self.limits,
endowment: Set(endowment),
exec_input: self.exec_input,
salt: self.salt,
return_type: self.return_type,
_phantom: Default::default(),
}
}
}
impl<E, ContractRef, CodeHash, Limits, Endowment, Salt, RetType>
CreateBuilder<
E,
ContractRef,
CodeHash,
Limits,
Endowment,
Unset<ExecutionInput<EmptyArgumentList>>,
Salt,
RetType,
>
where
E: Environment,
{
/// Sets the value transferred upon the execution of the call.
#[inline]
pub fn exec_input<Args>(
self,
exec_input: ExecutionInput<Args>,
) -> CreateBuilder<
E,
ContractRef,
CodeHash,
Limits,
Endowment,
Set<ExecutionInput<Args>>,
Salt,
RetType,
> {
CreateBuilder {
code_hash: self.code_hash,
limits: self.limits,
endowment: self.endowment,
exec_input: Set(exec_input),
salt: self.salt,
return_type: self.return_type,
_phantom: Default::default(),
}
}
}
impl<E, ContractRef, CodeHash, Limits, Endowment, Args, RetType>
CreateBuilder<
E,
ContractRef,
CodeHash,
Limits,
Endowment,
Args,
Unset<state::Salt>,
RetType,
>
where
E: Environment,
{
/// Sets the value transferred upon the execution of the call.
#[inline]
pub fn salt_bytes<Salt>(
self,
salt: Salt,
) -> CreateBuilder<
E,
ContractRef,
CodeHash,
Limits,
Endowment,
Args,
Set<Salt>,
RetType,
>
where
Salt: AsRef<[u8]>,
{
CreateBuilder {
code_hash: self.code_hash,
limits: self.limits,
endowment: self.endowment,
exec_input: self.exec_input,
salt: Set(salt),
return_type: self.return_type,
_phantom: Default::default(),
}
}
}
impl<E, ContractRef, CodeHash, Limits, Endowment, Args, Salt>
CreateBuilder<
E,
ContractRef,
CodeHash,
Limits,
Endowment,
Args,
Salt,
Unset<ReturnType<()>>,
>
where
E: Environment,
{
/// Sets the type of the returned value upon the execution of the constructor.
///
/// # Note
///
/// Constructors are not able to return arbitrary values. Instead a successful call to
/// a constructor returns the address at which the contract was instantiated.
///
/// Therefore this must always be a reference (i.e `ContractRef`) to the contract
/// you're trying to instantiate.
#[inline]
pub fn returns<R>(
self,
) -> CreateBuilder<
E,
ContractRef,
CodeHash,
Limits,
Endowment,
Args,
Salt,
Set<ReturnType<R>>,
>
where
ContractRef: FromAccountId<E>,
R: ConstructorReturnType<ContractRef>,
{
CreateBuilder {
code_hash: self.code_hash,
limits: self.limits,
endowment: self.endowment,
exec_input: self.exec_input,
salt: self.salt,
return_type: Set(Default::default()),
_phantom: Default::default(),
}
}
}
impl<E, ContractRef, Limits, Args, Salt, RetType>
CreateBuilder<
E,
ContractRef,
Set<E::Hash>,
Set<Limits>,
Set<E::Balance>,
Set<ExecutionInput<Args>>,
Set<Salt>,
Set<ReturnType<RetType>>,
>
where
E: Environment,
{
/// Finalizes the create builder, allowing it to instantiate a contract.
#[inline]
pub fn params(self) -> CreateParams<E, ContractRef, Limits, Args, Salt, RetType> {
CreateParams {
code_hash: self.code_hash.value(),
limits: self.limits.value(),
endowment: self.endowment.value(),
exec_input: self.exec_input.value(),
salt_bytes: self.salt.value(),
_return_type: Default::default(),
_phantom: Default::default(),
}
}
}
impl<E, ContractRef, Args, Salt, RetType>
CreateBuilder<
E,
ContractRef,
Set<E::Hash>,
Set<LimitParamsV2<E>>,
Set<E::Balance>,
Set<ExecutionInput<Args>>,
Set<Salt>,
Set<ReturnType<RetType>>,
>
where
E: Environment,
ContractRef: FromAccountId<E>,
Args: scale::Encode,
Salt: AsRef<[u8]>,
RetType: ConstructorReturnType<ContractRef>,
{
/// Instantiates the contract and returns its account ID back to the caller.
///
/// # Panics
///
/// This method panics if it encounters an [`ink::env::Error`][`crate::Error`] or an
/// [`ink::primitives::LangError`][`ink_primitives::LangError`]. If you want to handle
/// those use the [`try_instantiate`][`CreateBuilder::try_instantiate`] method
/// instead.
#[inline]
pub fn instantiate(self) -> <RetType as ConstructorReturnType<ContractRef>>::Output {
self.params().instantiate()
}
/// Instantiates the contract and returns its account ID back to the caller.
///
/// # Note
///
/// On failure this returns an outer [`ink::env::Error`][`crate::Error`] or inner
/// [`ink::primitives::LangError`][`ink_primitives::LangError`], both of which can be
/// handled by the caller.
#[inline]
pub fn try_instantiate(
self,
) -> Result<
ink_primitives::ConstructorResult<
<RetType as ConstructorReturnType<ContractRef>>::Output,
>,
Error,
> {
self.params().try_instantiate()
}
}
impl<E, ContractRef, Args, Salt, RetType>
CreateBuilder<
E,
ContractRef,
Set<E::Hash>,
Set<LimitParamsV1>,
Set<E::Balance>,
Set<ExecutionInput<Args>>,
Set<Salt>,
Set<ReturnType<RetType>>,
>
where
E: Environment,
ContractRef: FromAccountId<E>,
Args: scale::Encode,
Salt: AsRef<[u8]>,
RetType: ConstructorReturnType<ContractRef>,
{
/// Instantiates the contract and returns its account ID back to the caller.
///
/// # Panics
///
/// This method panics if it encounters an [`ink::env::Error`][`crate::Error`] or an
/// [`ink::primitives::LangError`][`ink_primitives::LangError`]. If you want to handle
/// those use the [`try_instantiate`][`CreateBuilder::try_instantiate`] method
/// instead.
#[inline]
pub fn instantiate(self) -> <RetType as ConstructorReturnType<ContractRef>>::Output {
self.params().instantiate()
}
/// Instantiates the contract and returns its account ID back to the caller.
///
/// # Note
///
/// On failure this returns an outer [`ink::env::Error`][`crate::Error`] or inner
/// [`ink::primitives::LangError`][`ink_primitives::LangError`], both of which can be
/// handled by the caller.
#[inline]
pub fn try_instantiate(
self,
) -> Result<
ink_primitives::ConstructorResult<
<RetType as ConstructorReturnType<ContractRef>>::Output,
>,
Error,
> {
self.params().try_instantiate()
}
}