4.4 存款/提款逻辑测试

riyad

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

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

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

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

更新我们的合约包装器

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

1. // ...library imports
   
2. 
   ! M: ~( k+ C3 [6 X5 R
3. export type MainContractConfig = {
   
4.   number: number;
   
5.   address: Address;
   8 s3 J$ J2 b  R4 ^/ g5 @/ c
6.   owner_address: Address;
   7 P7 _* [' L( y' A$ f+ C
7. };
   0 ?: T$ M3 I- [8 L* C
8. 
   
9. export function mainContractConfigToCell(config: MainContractConfig): Cell {
   " `; c2 g1 P. y+ {$ t
10.   return beginCell()
    ; K$ d( \3 a- @3 n; T# e
11.     .storeUint(config.number, 32)
    6 I6 M% n+ d; \' z; D1 c' o$ r% T
12.     .storeAddress(config.address)
    ( Z' j0 C# S( _1 \( P& F- D
13.     .storeAddress(config.owner_address)
    2 m! U4 p& s( t- h! _/ V
14.     .endCell();
    " g& S1 w5 b& t" ~7 H) n6 z
15. }
    
16. 
    
17. // ...contact wrapper class

复制代码

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

' u6 I4 `  L7 i

1. async getData(provider: ContractProvider) {
   6 E* _- b! i7 \) b* L, k6 O. h2 x
2.     const { stack } = await provider.get("get_contract_storage_data", []);
   / {/ G! x* H/ v1 r9 Y1 ^! J
3.     return {
   
4.       number: stack.readNumber(),
   # W& P- Q; J# H; Z6 M
5.       recent_sender: stack.readAddress(),
   * n' g% g" g# G# N% c
6.       owner_address: stack.readAddress(),
   
7.     };
   2 Y0 b* h; H9 X8 _# c, j. ~' f  W" _
8.   }
   ; \8 }8 ]0 M- N
9.   
   3 a7 Y# f- }' ^) j" `
10. async getBalance(provider: ContractProvider) {
    
11.     const { stack } = await provider.get("balance", []);
    # a: P4 H  J  I
12.     return {
    ' [! }- ?" X1 Z: C. ?7 Q) [
13.       number: stack.readNumber(),
    * M& L/ V- A8 R7 g5 m
14.     };
    
15. }

复制代码

1. // ...library imports
   
2. 
   
3. describe("main.fc contract tests", () => {
   
4.   it("should get the proper most recent sender address", async () => {
   * T  q! r! e( f$ ^5 ~5 I' q4 k
5.     const blockchain = await Blockchain.create();
   
6.     const codeCell = Cell.fromBoc(Buffer.from(hex, "hex"))[0];
   
7. 
   
8.     const initAddress = await blockchain.treasury("initAddress");
   
9.     const ownerAddress = await blockchain.treasury("ownerAddress");
   
10.    
    
11.     const myContract = blockchain.openContract(
    2 K/ n( L$ ^/ f4 y) B
12.       await MainContract.createFromConfig(
    2 T$ u; T" \, P0 [* p, M
13.         {
    $ d$ e! [, r" T5 W+ F2 V
14.           number: 0,
    ( C. n' l7 X: w7 ]! W
15.           address: initAddress.address,
    
16.           owner_address: ownerAddress.address, // now we create myContract from 3 parameters
    
17.         },
    
18.         codeCell
    # @) Y1 [1 O) U/ u
19.       )
    
20.     );
    
21. 
      d  [& b- h7 y* a' y
22. // ...rest of testing code

复制代码

4 e5 f3 H3 g% _9 Y2 Y# G( V

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

1. // ...library imports
   
2. 
   
3. describe("main.fc contract tests", () => {
   
4.   it("should get the proper most recent sender address", async () => {
   # n' i7 l5 E& Z
5.     const blockchain = await Blockchain.create();
   
6.     const codeCell = Cell.fromBoc(Buffer.from(hex, "hex"))[0];
   ( ?! ^) H$ ]3 ]0 U$ P: P
7. 
   
8.     const initAddress = await blockchain.treasury("initAddress");
   $ ^1 |) Z9 Y6 g; u0 a
9.     const ownerAddress = await blockchain.treasury("ownerAddress");
   * ]2 a3 f- v& w  j! R6 k" ^+ a+ K
10.    
    # u/ o! H9 K7 E. N- d
11.     const myContract = blockchain.openContract(
      u% I4 C1 T+ Q: m
12.       await MainContract.createFromConfig(
    " i# [) b7 a6 i+ N4 _% o) g
13.         {
    
14.           number: 0,
    
15.           address: initAddress.address,
    - K' {/ \3 S" O) ]  y8 A/ E5 T
16.           owner_address: ownerAddress.address, // now we create myContract from 3 parameters
    
17.         },
    8 v; |4 L7 Q5 P& p
18.         codeCell
    # w- y0 h: o. `% C
19.       )
    
20.     );
    / [0 I, o  ^; H6 `; I8 a9 H; r1 @
21. 
    / i- P/ P* S% A5 G; ^
22. // ...rest of testing code

复制代码

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

存款测试

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

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

1. // We need to additionally import SandboxContract and TreasuryContract
   - J- s) x# k9 z
2. import { Blockchain, SandboxContract, TreasuryContract } from "@ton/sandbox";
   
3. // ... other library imports
   
4. describe("main.fc contract tests", () => {
   
5.   let blockchain: Blockchain;
   * F9 ^8 Y" k9 L) _. v6 l% y
6.   let myContract: SandboxContract<MainContract>;
   ! u# i$ h; I9 U7 w4 _$ u! g
7.   let initWallet: SandboxContract<TreasuryContract>;
   + F" W! d7 H( k" G1 f& h' |7 `; f
8.   let ownerWallet: SandboxContract<TreasuryContract>;
   
9. 
   
10.   beforeEach(async () => {
    
11.     blockchain = await Blockchain.create();
    
12.     initWallet = await blockchain.treasury("initWallet");
    3 y' ~+ B7 D# ^7 T. m% L* `. F
13.     ownerWallet = await blockchain.treasury("ownerWallet");
    
14. 
    
15.     const codeCell = Cell.fromBoc(Buffer.from(hex, "hex"))[0];
    
16. 
    6 l. u8 O- J! B6 Q6 j3 K8 r. d
17.     myContract = blockchain.openContract(
    6 n2 l5 z* Y7 d6 g5 m
18.       await MainContract.createFromConfig(
    
19.         {
    
20.           number: 0,
    ! M3 c& p# k2 q- V4 Y* V
21.           address: initWallet.address,
    , W7 r/ T! M4 H/ n- Y/ `  V
22.           owner_address: ownerWallet.address,
    
23.         },
    / A' H1 a- [8 K) M
24.         codeCell
    
25.       )
    
26.     );
    
27.   });
    
28. 
    
29.   it("should get the proper most recent sender address", async () => {
    
30.     const senderWallet = await blockchain.treasury("sender");
    / u- q7 N6 X" J
31. 
    9 |3 {% B; \4 i- E5 P- r4 A
32.     const sentMessageResult = await myContract.sendIncrement(
    
33.       senderWallet.getSender(),
      _; W% h. e1 I9 r
34.       toNano("0.05"),
    
35.       1
    
36.     );
    
37. 
    
38.     expect(sentMessageResult.transactions).toHaveTransaction({
    6 a" N: J) e- ?* c( I
39.       from: senderWallet.address,
    
40.       to: myContract.address,
    ' B! M3 K: M% S( J# n6 D# T
41.       success: true,
    7 Q" S: ^; \- m$ m, l4 g1 N3 j
42.     });
    ; P* p1 o( @, X) u' G' |% i
43. 
    6 S" i7 r3 W+ v( H& y
44.     const data = await myContract.getData();
    # H4 y8 I. L7 K
45. 
    
46.     expect(data.recent_sender.toString()).toBe(senderWallet.address.toString());
    
47.     expect(data.number).toEqual(1);
    % D' j% [: T) `+ o7 v; k
48.   });
    9 d: p" G3 X" i; K1 b; _
49.   it("successfully deposits funds", () => {
    
50.     // test logic is coming
    3 m9 f/ N! D3 Z, o  O# `, Q8 H5 p
51.   });
    
52.   it("should return deposit funds as no command is sent", () => {
    3 k0 r: I8 i% i" b4 h% \% v. w
53.     // test logic is coming
    % K: D( ]/ I5 w
54.   });
    ) s9 x4 i" v( N  p( F: O
55.   it("successfully withdraws funds on behalf of owner", () => {
    
56.     // test logic is coming
    
57.   });
    
58.   it("fails to withdraw funds on behalf of non-owner", () => {
    
59.     // test logic is coming
    
60.   });
    
61.   it("fails to withdraw funds because lack of balance", () => {
    
62.     // test logic is coming
    ( ]1 W, v+ L. r2 V9 H
63.   });
    9 D8 v5 L7 a; n! C
64. });

复制代码

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

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

1. async sendDeposit(provider: ContractProvider, sender: Sender, value: bigint) {
   8 c' l7 B7 p9 @
2.     const msg_body = beginCell()
   
3.       .storeUint(2, 32) // OP code
   : t9 A% r! O" x( t8 o
4.       .endCell();
   
5. 
   / V2 J, P2 U$ \7 x/ T2 S5 @! D! G/ g; s
6.     await provider.internal(sender, {
   
7.       value,
   
8.       sendMode: SendMode.PAY_GAS_SEPARATELY,
   1 p. m- M2 Y; i7 p
9.       body: msg_body,
   
10.     });
    6 R( |" F, |+ [( o: i: v( k+ h7 H
11.   }

复制代码

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

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

1. it("successfully deposits funds", async () => {
   
2.     const senderWallet = await blockchain.treasury("sender");
   
3. 
   " Y7 }# M' x. P3 K. y7 i
4.     const depositMessageResult = await myContract.sendDeposit(
   
5.       senderWallet.getSender(),
   ) q$ G; ?6 ~5 r* e! c5 H7 c
6.       toNano("5")
   , ]/ T0 u: [7 n2 p) _+ m
7.     );
   
8. 
   
9.     expect(depositMessageResult.transactions).toHaveTransaction({
   & d% H" D5 q' o3 X# X2 m9 y) L3 H8 }
10.       from: senderWallet.address,
      j# k8 a; }2 i0 l) ^
11.       to: myContract.address,
    , Z' s" Q- e* `; u6 [2 j
12.       success: true,
    
13.     });
    
14. 
    % z  N0 `. }) ?8 Q' G* q( p9 E% r
15.     const balanceRequest = await myContract.getBalance();
    
16. 
    . U$ g9 f6 W0 G  K  d* n
17.     expect(balanceRequest.number).toBeGreaterThan(toNano("4.99"));
    0 |2 V* B4 c( P, X
18.   });

复制代码

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

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

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

1. async sendNoCodeDeposit(
   
2.     provider: ContractProvider,
   
3.     sender: Sender,
   : g* L" Z: p. W2 `2 ]7 c$ R* m
4.     value: bigint
   
5.   ) {
   2 e5 k% a. |  }: k' {9 s
6.     const msg_body = beginCell().endCell();
   + k# |- m/ a: J. \# O/ j  v
7. 
   5 G  ^2 z0 z+ J' G* S
8.     await provider.internal(sender, {
   8 L% S* A2 @: ~9 A
9.       value,
   
10.       sendMode: SendMode.PAY_GAS_SEPARATELY,
    
11.       body: msg_body,
    
12.     });
    , P) x3 C( N5 ^" n% F
13.   }

复制代码

下面是测试代码：

1. it("should return funds as no command is sent", async () => {
   
2.     const senderWallet = await blockchain.treasury("sender");
   
3. 
   / R  j6 [9 D) k
4.     const depositMessageResult = await myContract.sendNoCodeDeposit(
   
5.       senderWallet.getSender(),
   # p. R+ F1 Q& p! R# z' O2 l: F& K
6.       toNano("5")
   ; z' k* e3 S# {" M' y+ h
7.     );
   
8. 
   
9.     expect(depositMessageResult.transactions).toHaveTransaction({
   
10.       from: myContract.address,
    
11.       to: senderWallet.address,
    ) E3 {: h' x+ r1 z
12.       success: true,
    ' D1 H, R% b+ M7 I
13.     });
    / Y  m4 `; E1 P1 H$ ^& }
14. 
    ! v, H0 f/ J8 D
15.     const balanceRequest = await myContract.getBalance();
    ! V9 u, P/ i) ?( O9 O4 W" Y
16. 
    
17.     expect(balanceRequest.number).toBe(0);
    ; p2 l; I( Z9 F
18. });

复制代码

提款测试

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

1. async sendWithdrawalRequest(
   : R* O# U2 V. t3 s8 q+ o% F
2.     provider: ContractProvider,
   
3.     sender: Sender,
   
4.     value: bigint,
   
5.     amount: bigint
   
6.   ) {
   9 F, i6 A2 K" |4 w3 v" |, k" e3 I) w9 B
7.     const msg_body = beginCell()
   2 R/ h4 _5 [7 H0 e/ r) C
8.       .storeUint(3, 32) // OP code
   ! W' ~+ g9 T6 Q2 |' m  z' _
9.       .storeCoins(amount)
   : g4 x! V% O" S7 q
10.       .endCell();
    
11. 
    
12.     await provider.internal(sender, {
    ! W) k* ]5 \: h
13.       value,
    
14.       sendMode: SendMode.PAY_GAS_SEPARATELY,
    # c& `# ]/ {& @9 U% o' Q* I
15.       body: msg_body,
    
16.     });
    
17.   }

复制代码

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

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

1. it("successfully withdraws funds on behalf of owner", async () => {
   6 B- ^/ N9 _4 k, P9 ~# c7 }
2.     const senderWallet = await blockchain.treasury("sender");
   
3. 
   
4.     await myContract.sendDeposit(senderWallet.getSender(), toNano("5"));
   0 `6 E, K2 ~  h. ~: f
5. 
   ' ^, Y" y$ [; o/ t+ d
6.     const withdrawalRequestResult = await myContract.sendWithdrawalRequest(
   
7.       ownerWallet.getSender(),
   * I3 p5 p! b, ?) s! j, W
8.       toNano("0.05"),
   
9.       toNano("1")
   
10.     );
    0 J: t/ z8 C! E( V7 J& |
11. 
    . S/ s& l$ b$ J
12.     expect(withdrawalRequestResult.transactions).toHaveTransaction({
    8 ^  m2 Q& E/ G' U
13.       from: myContract.address,
    ( V3 \1 A9 r/ c
14.       to: ownerWallet.address,
    
15.       success: true,
    * z. C6 X- D9 T5 o
16.       value: toNano(1),
    
17.     });
    * F5 ?8 q' @1 T- E) o+ q
18.   });

复制代码

要成功提款，我们首先要正确存款。然后我们调用 sendWithdrawalRequest 指定我们要提取 1 Ton。请注意，0.05 Ton只是为了支付费用而指定的信息值。
8 F- f) R6 w! x) P+ c' D8 A

1. it("fails to withdraw funds on behalf of not-owner", async () => {
   
2.     const senderWallet = await blockchain.treasury("sender");
   3 m9 T$ `6 Z4 N1 C3 ?
3. 
   9 N* x) w; |& h0 Z, Y  o, c9 J: j
4.     await myContract.sendDeposit(senderWallet.getSender(), toNano("5"));
   
5. 
   3 x/ q( Z2 S& B1 \% W
6.     const withdrawalRequestResult = await myContract.sendWithdrawalRequest(
   
7.       senderWallet.getSender(),
   
8.       toNano("0.5"),
   3 R/ j1 L; N; Z7 Y
9.       toNano("1")
   7 x$ E8 Z5 N7 m4 R" r8 F2 \
10.     );
    4 U+ K& o1 _+ m7 `# r" d
11. 
    + o9 z) k. @+ R: B
12.     expect(withdrawalRequestResult.transactions).toHaveTransaction({
    
13.       from: senderWallet.address,
    3 A- x% e6 n% F1 A1 X
14.       to: myContract.address,
    
15.       success: false,
    3 l; F  j2 i7 n/ q0 k" u: `" W# Q
16.       exitCode: 103,
    
17.     });
    - a( h* H0 ?# l( A* z/ H
18.   });

复制代码

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

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

1. throw_unless(103, equal_slice_bits(sender_address, owner_address));
   # y9 d- k* Q2 C

复制代码

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

1. it("fails to withdraw funds because lack of balance", async () => {
   
2.     const withdrawalRequestResult = await myContract.sendWithdrawalRequest(
   ' V! ]# `0 V" U
3.       ownerWallet.getSender(),
   % Z2 n* H- T  z6 Q5 H# z) Y6 `
4.       toNano("0.5"),
   & B  q; e! V1 i
5.       toNano("1")
   . a- o' d- d; ]9 d+ _
6.     );
   - K% K) f/ T& M9 F# N) A) v+ F
7. 
   
8.     expect(withdrawalRequestResult.transactions).toHaveTransaction({
   + @2 ~: G. n' c9 k* L
9.       from: ownerWallet.address,
   
10.       to: myContract.address,
    
11.       success: false,
    % T6 V) }3 J/ I: e* R, N6 I7 G
12.       exitCode: 104,
    9 z/ }( B- T- R. s) H
13.     });
    
14.   });

复制代码

1. throw_unless(104, balance >= withdraw_amount);
   

复制代码

就是这样

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

- K) E/ b# |+ N; o) `2 N