4.4 存款/提款逻辑测试

riyad

在本课中，我们将编写一些有趣的测试。

首先，我们要更新之前编写的合约的初始化过程，因为我们引入了一个新变量，它应该存储在 c4 存储器中。

如果您现在尝试运行我们的测试 - yarn test 您可以看到测试将失败。您还将看到发生在我们合约上的交易跟踪，其中一个交易的错误代码为 9. Have a look at the exit codes documentation.

9 - Cell下溢。从片断基元读取数据时，试图读取的位或引用数超过总数。

更新我们的合约包装器

首先，让我们更新我们的合约包装器，以便它能意识到 c4 存储中的第三个参数。也就是说，我们将更新 MainContractConfig 和 mainContractConfigToCell 函数

1. // ...library imports
   3 K& [1 V: t4 ?1 _
2. 
   ' P# E  U. G5 s2 k/ b/ M8 T
3. export type MainContractConfig = {
   5 _6 ]2 [: M* P* n
4.   number: number;
   
5.   address: Address;
   - m# L2 E3 Q) d5 O5 o* _' s
6.   owner_address: Address;
   . p1 N5 e2 x* ?! u+ o8 F
7. };
   
8. 
   
9. export function mainContractConfigToCell(config: MainContractConfig): Cell {
   2 I$ n3 M0 K+ o% Y0 {! s
10.   return beginCell()
    
11.     .storeUint(config.number, 32)
    
12.     .storeAddress(config.address)
    
13.     .storeAddress(config.owner_address)
    
14.     .endCell();
    - [9 e0 M0 R0 a' L9 h" }. @6 ~
15. }
    7 E# \3 C" C4 S
16. 
    6 i) K$ Z/ |/ `4 K9 F: A, g, _
17. // ...contact wrapper class

复制代码

封装文件中还有一点需要更新-getData 方法，这样它也会返回 owner_address 我们还将创建新方法 getBalance，以测试存款后余额是否增加：

1. async getData(provider: ContractProvider) {
   ' t. s4 ?+ l  y5 ^
2.     const { stack } = await provider.get("get_contract_storage_data", []);
   1 y  k. @+ f' k9 J3 |9 T
3.     return {
   ( f5 l. H4 Q! W: F$ {2 q' C
4.       number: stack.readNumber(),
   
5.       recent_sender: stack.readAddress(),
   
6.       owner_address: stack.readAddress(),
   ' z. O1 |7 t9 q& i+ ?
7.     };
   
8.   }
   
9.   
   
10. async getBalance(provider: ContractProvider) {
    * J! v2 D* r0 n
11.     const { stack } = await provider.get("balance", []);
    
12.     return {
    7 g& r: C' p0 H8 w
13.       number: stack.readNumber(),
    
14.     };
    
15. }

复制代码

1. // ...library imports
   
2. 
     c( @% |6 v0 m/ x* v6 \$ T
3. describe("main.fc contract tests", () => {
   
4.   it("should get the proper most recent sender address", async () => {
   * y$ g7 G0 \5 c2 l% B
5.     const blockchain = await Blockchain.create();
   ' |, _8 L" N. {# V/ {
6.     const codeCell = Cell.fromBoc(Buffer.from(hex, "hex"))[0];
   
7. 
   8 p2 D6 D% B) Z
8.     const initAddress = await blockchain.treasury("initAddress");
     r0 h% h3 H" y$ k/ B3 V: w
9.     const ownerAddress = await blockchain.treasury("ownerAddress");
   
10.    
    
11.     const myContract = blockchain.openContract(
    
12.       await MainContract.createFromConfig(
    " D# N2 n2 L* g
13.         {
    ; D  `! b3 j# ?0 V8 H
14.           number: 0,
    
15.           address: initAddress.address,
    ( V( y4 `; d$ Q4 t( `
16.           owner_address: ownerAddress.address, // now we create myContract from 3 parameters
    & ?" I" z5 d( S% l1 N% o
17.         },
    
18.         codeCell
    " e% \8 G# d0 ]: V
19.       )
    
20.     );
    
21. 
    2 G; J; a6 C& N& y6 S$ ~9 b6 U
22. // ...rest of testing code

复制代码

- u3 a+ _5 w  i4 W: e

我们引入一个新的金库，它实际上将是合约的所有者，只有这个所有者以后才能提取资金。这些更新在 tests/main.spec.ts 中进行：

1. // ...library imports
   3 t( Q/ T1 u- T! C
2. 
   
3. describe("main.fc contract tests", () => {
   
4.   it("should get the proper most recent sender address", async () => {
   ; F+ @5 P- @9 x) w
5.     const blockchain = await Blockchain.create();
   
6.     const codeCell = Cell.fromBoc(Buffer.from(hex, "hex"))[0];
   
7. 
   : F7 |, q1 @0 I8 ?
8.     const initAddress = await blockchain.treasury("initAddress");
   + C6 b% H  I8 A3 L
9.     const ownerAddress = await blockchain.treasury("ownerAddress");
   - |4 d. P. m+ q6 b) [
10.    
    
11.     const myContract = blockchain.openContract(
    ( d& P7 `8 H8 o7 c) ~2 c% C' h
12.       await MainContract.createFromConfig(
    
13.         {
    8 ?0 d' C" ^2 c% @/ Q
14.           number: 0,
    7 O8 A. z0 v) }* j7 q. Z0 u
15.           address: initAddress.address,
    
16.           owner_address: ownerAddress.address, // now we create myContract from 3 parameters
    
17.         },
    
18.         codeCell
    . y8 U6 o- B) w  z: l
19.       )
    8 b* J7 q) w9 q9 t& s; D7 }
20.     );
    
21. 
    
22. // ...rest of testing code

复制代码

现在我们好了。 yarn test 成功通过我们之前编写的测试。

存款测试

让我们在 main.spec.ts 文件中再添加几个测试。

由于我们必须在每次新测试前重新启动合约，因此我们还将把合约启动引入 Jest 的 beforeEach 函数：

1. // We need to additionally import SandboxContract and TreasuryContract
   
2. import { Blockchain, SandboxContract, TreasuryContract } from "@ton/sandbox";
   
3. // ... other library imports
   
4. describe("main.fc contract tests", () => {
   
5.   let blockchain: Blockchain;
   * K% m7 j! p. ~7 D8 P( j! `9 B
6.   let myContract: SandboxContract<MainContract>;
   0 M4 D9 ]& A/ e% L  v1 v: \* l
7.   let initWallet: SandboxContract<TreasuryContract>;
   * Y- h4 E8 I7 J9 A( J5 h
8.   let ownerWallet: SandboxContract<TreasuryContract>;
   
9. 
   " H5 [' Z! k- `
10.   beforeEach(async () => {
    $ |6 C: U/ {0 i# E
11.     blockchain = await Blockchain.create();
    
12.     initWallet = await blockchain.treasury("initWallet");
    ' _- R- M4 t4 s, A/ i
13.     ownerWallet = await blockchain.treasury("ownerWallet");
    ! h9 V: ~1 F8 \4 d# D
14. 
    3 q& M9 K+ B; |0 C9 O: Q
15.     const codeCell = Cell.fromBoc(Buffer.from(hex, "hex"))[0];
    
16. 
    - u3 \9 Q- t- X) U3 e5 z( d
17.     myContract = blockchain.openContract(
    
18.       await MainContract.createFromConfig(
    $ s& J0 G) _8 K* T& P
19.         {
    7 [  W3 m6 R+ G- S, Z
20.           number: 0,
    7 e! K" Y7 L3 d1 F6 D1 ^
21.           address: initWallet.address,
    7 A- }& o7 D& A
22.           owner_address: ownerWallet.address,
    
23.         },
    
24.         codeCell
    8 D* U: h1 ~1 V* J: H! G
25.       )
    # [% g5 x2 ]% D0 D) W5 `" O
26.     );
    
27.   });
    ' D- Q, r, Z2 |: o( G4 u; W3 E
28. 
    9 V7 M5 @1 X, V# k& u
29.   it("should get the proper most recent sender address", async () => {
    , L/ M5 {, ]3 P4 e2 Y, k
30.     const senderWallet = await blockchain.treasury("sender");
    4 O. K  L, T( {) A2 }: v9 m9 L
31. 
    
32.     const sentMessageResult = await myContract.sendIncrement(
    ( b( d# V; K1 K8 b; T( Q
33.       senderWallet.getSender(),
    9 y& ^. X9 y& K; {7 Y8 `# t
34.       toNano("0.05"),
    : H% B$ n0 K" T. X) i8 Z
35.       1
    
36.     );
    
37. 
    
38.     expect(sentMessageResult.transactions).toHaveTransaction({
    
39.       from: senderWallet.address,
    
40.       to: myContract.address,
    , _/ g' y" L, z( h
41.       success: true,
    6 ^# |  S, y8 d+ @5 Q
42.     });
    
43. 
    9 `/ k( C4 d. N, Q
44.     const data = await myContract.getData();
    ) Z, C5 q* e6 H( I+ ]
45. 
    # g; n9 s& Z) ~6 r
46.     expect(data.recent_sender.toString()).toBe(senderWallet.address.toString());
    
47.     expect(data.number).toEqual(1);
    
48.   });
    0 Z+ C% T/ W- F' @  C. `: V# O' T
49.   it("successfully deposits funds", () => {
    
50.     // test logic is coming
    , L! w+ A9 r0 ~4 K
51.   });
    
52.   it("should return deposit funds as no command is sent", () => {
    
53.     // test logic is coming
    
54.   });
    4 o3 \% n8 ]- g. Z
55.   it("successfully withdraws funds on behalf of owner", () => {
    
56.     // test logic is coming
    5 ~2 T" ^% E! I# p
57.   });
    
58.   it("fails to withdraw funds on behalf of non-owner", () => {
    $ Z3 M0 Q2 Q( b5 P% R4 t
59.     // test logic is coming
    8 g/ H/ q& P& e* m3 p2 G: d
60.   });
    . w! J! f& z: b: K5 U! ?7 B4 W* R. W
61.   it("fails to withdraw funds because lack of balance", () => {
    
62.     // test logic is coming
    
63.   });
    
64. });

复制代码

我们只是将第一个测试的部分行移动到了 beforeEach 中，其余的行应留在第一个测试中 it

让我们为存款写一个测试。我们将发送一条 op == 2 的信息，然后检查余额。像往常一样，首先创建一个封装方法，我们将其称为 sendDeposit：

1. async sendDeposit(provider: ContractProvider, sender: Sender, value: bigint) {
   
2.     const msg_body = beginCell()
   
3.       .storeUint(2, 32) // OP code
   
4.       .endCell();
   7 @( Q4 Q8 j$ h  L* a# _2 n
5. 
   
6.     await provider.internal(sender, {
   $ j$ n- Z" b  D- T
7.       value,
   ) g6 I+ c& ?! I# Y2 g8 J; y4 w  e
8.       sendMode: SendMode.PAY_GAS_SEPARATELY,
   
9.       body: msg_body,
   9 d4 M. s2 W/ b
10.     });
    
11.   }

复制代码

我们将不详细介绍这种方法，因为它非常简单--我们只需在信息正文中传递一个操作码。

下面是我们如何使用该方法运行存款测试。

1. it("successfully deposits funds", async () => {
   
2.     const senderWallet = await blockchain.treasury("sender");
   
3. 
   
4.     const depositMessageResult = await myContract.sendDeposit(
   5 y7 |- B0 {3 M* n& [: U; c" l* e0 W
5.       senderWallet.getSender(),
   
6.       toNano("5")
   % c* w/ @& L+ z- Q! x
7.     );
   $ y  q5 y  `/ O+ I: _" S+ u- ~
8. 
   
9.     expect(depositMessageResult.transactions).toHaveTransaction({
   
10.       from: senderWallet.address,
    . p3 k$ _0 s+ |( o' ~4 Q
11.       to: myContract.address,
    
12.       success: true,
    2 n- s/ Z3 H* S# R
13.     });
    , m7 O4 {& I% v* W" M1 ~0 _7 V9 k
14. 
    
15.     const balanceRequest = await myContract.getBalance();
    
16. 
    
17.     expect(balanceRequest.number).toBeGreaterThan(toNano("4.99"));
    
18.   });

复制代码

请注意我们是如何检查合约余额是否大于 4.99 TON的，因为我们知道手续费会损失一些资金。

我们再写一个存款测试，但这次会出现误报。我们将在没有存款操作码的情况下发送资金，并期待返回交易，因为该操作码未知。

和以往一样，我们还有一个包装器：

1. async sendNoCodeDeposit(
   9 U8 _* Z  e8 N
2.     provider: ContractProvider,
   , [, n# G, j' g% f
3.     sender: Sender,
   : j& N) b0 }; F0 f
4.     value: bigint
   
5.   ) {
   * a+ h' `( a  R  ]
6.     const msg_body = beginCell().endCell();
   2 }  j" O( M* Y. W
7. 
   
8.     await provider.internal(sender, {
   . A9 O4 o+ Z. ~0 b0 t. {
9.       value,
   ) v$ ~+ R" w. Y) |& I3 J  w
10.       sendMode: SendMode.PAY_GAS_SEPARATELY,
    
11.       body: msg_body,
    7 o7 H4 x' k3 e, }8 D3 L
12.     });
    
13.   }

复制代码

下面是测试代码：

7 F: }/ ]$ C9 p! z

1. it("should return funds as no command is sent", async () => {
   ) ~( j* u  ~* g' c
2.     const senderWallet = await blockchain.treasury("sender");
   ; Q) _5 s0 c& @) P' N
3. 
   
4.     const depositMessageResult = await myContract.sendNoCodeDeposit(
   
5.       senderWallet.getSender(),
   
6.       toNano("5")
   # C' J( I7 X- M1 M2 ]$ P  k8 |
7.     );
   . {2 N% _8 Y4 V; C, v6 X; d% Z
8. 
   
9.     expect(depositMessageResult.transactions).toHaveTransaction({
   
10.       from: myContract.address,
    # `% r0 j8 r: ?3 n( j5 Q: D
11.       to: senderWallet.address,
    
12.       success: true,
    
13.     });
    ( i+ ?0 S8 h: K( @1 _% s( m
14. 
    
15.     const balanceRequest = await myContract.getBalance();
    - V4 `$ J8 _9 _( @( N  N/ f
16. 
    
17.     expect(balanceRequest.number).toBe(0);
    
18. });

复制代码

提款测试

让我们先创建一个用于提款的新包装器：

1. async sendWithdrawalRequest(
   
2.     provider: ContractProvider,
   9 G& H, \8 D' \  P  Y
3.     sender: Sender,
   ' E6 m/ R9 a3 n) g) B0 B
4.     value: bigint,
   % U; w+ p) P( i' @! c+ @
5.     amount: bigint
   / L% x( e% c5 z8 i, J- `, }
6.   ) {
   
7.     const msg_body = beginCell()
   : T8 n; m6 }8 E; Q  W
8.       .storeUint(3, 32) // OP code
   
9.       .storeCoins(amount)
   
10.       .endCell();
    8 r" C+ ]# w# B7 A9 @
11. 
    
12.     await provider.internal(sender, {
    6 W; B; v* v4 Q7 m( A0 `3 Z0 A
13.       value,
    ( ^, [& `& w- D: k( ], d( w9 |* Q( Z4 h
14.       sendMode: SendMode.PAY_GAS_SEPARATELY,
    - z" M. }' Y% Y7 |
15.       body: msg_body,
    9 o9 t) ]3 G% N" a5 @$ S  d! i
16.     });
    " T% K9 @: ?" Q
17.   }

复制代码

我们输入适当的 msg_body 和所需的提款 amount 。

我们将进行 3 项不同的测试。让我们一起来看看：

1. it("successfully withdraws funds on behalf of owner", async () => {
   
2.     const senderWallet = await blockchain.treasury("sender");
   
3. 
   
4.     await myContract.sendDeposit(senderWallet.getSender(), toNano("5"));
   
5. 
   
6.     const withdrawalRequestResult = await myContract.sendWithdrawalRequest(
   5 y2 D! N: A, |9 {8 A& P$ G4 f
7.       ownerWallet.getSender(),
   
8.       toNano("0.05"),
   
9.       toNano("1")
   # t7 z4 M) A2 x; T9 l1 W; [
10.     );
    . n! P9 Z/ Y! ?& q; T8 y9 k1 _
11. 
    
12.     expect(withdrawalRequestResult.transactions).toHaveTransaction({
    
13.       from: myContract.address,
    ! e; _5 `' f6 Z6 p6 z
14.       to: ownerWallet.address,
    
15.       success: true,
    
16.       value: toNano(1),
    ' H/ ~0 {; h  Z  Y
17.     });
    + W4 J& b% Q& Y: W& F0 \9 a
18.   });

复制代码

要成功提款，我们首先要正确存款。然后我们调用 sendWithdrawalRequest 指定我们要提取 1 Ton。请注意，0.05 Ton只是为了支付费用而指定的信息值。

1. it("fails to withdraw funds on behalf of not-owner", async () => {
   * x8 K4 Y5 c& q* m- K5 V) D& f+ S
2.     const senderWallet = await blockchain.treasury("sender");
   
3. 
   * I# I7 D% T: h6 ~
4.     await myContract.sendDeposit(senderWallet.getSender(), toNano("5"));
   . N# `! c- F# ]6 M2 Q
5. 
   - e& @0 B8 {8 Q' T/ J
6.     const withdrawalRequestResult = await myContract.sendWithdrawalRequest(
   
7.       senderWallet.getSender(),
   9 `7 q/ s* z; M0 u9 }* z) G: L
8.       toNano("0.5"),
   7 o5 K0 {! E+ l! O3 d7 Q
9.       toNano("1")
   
10.     );
    
11. 
    * F+ u0 G9 F  Z& F, `. }
12.     expect(withdrawalRequestResult.transactions).toHaveTransaction({
    ' e3 }; C8 V3 I$ C7 R
13.       from: senderWallet.address,
    5 r) Y8 R* s$ a
14.       to: myContract.address,
    
15.       success: false,
    , T" B9 w; {  p  z! [1 G. T
16.       exitCode: 103,
    
17.     });
    , r5 d6 j7 i# c) k
18.   });

复制代码

在本次测试中，我们代表发送方钱包而不是所有者钱包发送提款请求（两者的区别在于初始化时我们提供的助记词).

还请注意，我们是如何通过 success: false 和具体的失败原因 exitCode： 103. 为了确保我们做得正确，请看一下我们的合约代码，我们有这样一行代码：

1. throw_unless(103, equal_slice_bits(sender_address, owner_address));
   - W9 s( y3 S1 |$ |! u

复制代码

我们进行最后一项测试--由于没有余额，提款失败：

1. it("fails to withdraw funds because lack of balance", async () => {
   
2.     const withdrawalRequestResult = await myContract.sendWithdrawalRequest(
   + n- c$ }6 u" f8 M; t
3.       ownerWallet.getSender(),
   
4.       toNano("0.5"),
   # a; r" l* @) n+ d+ f5 R, i
5.       toNano("1")
   ) F+ P8 V, m( z1 ]
6.     );
   . s2 d( K$ H+ t2 s2 T% e
7. 
   
8.     expect(withdrawalRequestResult.transactions).toHaveTransaction({
   9 H0 @9 A0 i3 E! J1 n( u# B6 v3 R
9.       from: ownerWallet.address,
   - g# B. \& A' F+ J
10.       to: myContract.address,
    
11.       success: false,
    0 \! G3 e8 T. y# a/ J# j8 w: p% M
12.       exitCode: 104,
    
13.     });
    
14.   });

复制代码

1. throw_unless(104, balance >= withdraw_amount);
   . H, t+ k- ]( H: b5 E

复制代码

就是这样

几章之后，我们将学习如何构建网络客户端，以便与合约进行交互。

* c  o, {: d2 }' t) M; Z# i2 s" t
- h- _( T7 j1 y