4.4 存款/提款逻辑测试

riyad

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

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

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

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

更新我们的合约包装器

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

1. // ...library imports
   
2. 
   
3. export type MainContractConfig = {
   2 D! u  i9 \: |1 n$ m9 @
4.   number: number;
   ( ]+ i3 O. [% _/ [6 \1 J: n
5.   address: Address;
   
6.   owner_address: Address;
     l. @# F" N! X* G/ Z% T
7. };
   / |- L0 \0 W. c. r( H" t; p; s0 ?: ]
8. 
   
9. export function mainContractConfigToCell(config: MainContractConfig): Cell {
   
10.   return beginCell()
    + T; X& @2 L; e( M. F
11.     .storeUint(config.number, 32)
    & Y7 O- G! @6 R7 Q, U8 ^
12.     .storeAddress(config.address)
    6 K% ~( J5 k( j) f+ }  o) j
13.     .storeAddress(config.owner_address)
    % N4 x1 F' d! N) C: G
14.     .endCell();
    
15. }
    
16. 
    4 d" a$ n# B0 i/ ?
17. // ...contact wrapper class

复制代码

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

5 `' n% O/ \$ S6 B1 {+ ]

1. async getData(provider: ContractProvider) {
   $ p" Q7 V* K* L$ Y7 j, z8 `: g. ?# n
2.     const { stack } = await provider.get("get_contract_storage_data", []);
   4 p3 @' e! C0 z* f4 z5 Z
3.     return {
   
4.       number: stack.readNumber(),
   
5.       recent_sender: stack.readAddress(),
   . }# }! T/ R# w3 P+ g
6.       owner_address: stack.readAddress(),
   . j5 |0 ^  c4 U/ V0 T' N
7.     };
   / e6 a1 g( X) ^3 J3 [: B/ m  t3 {
8.   }
   - D5 m" k" e* f( F1 T2 L
9.   
   
10. async getBalance(provider: ContractProvider) {
    ( H7 u: y  @( W6 k1 r
11.     const { stack } = await provider.get("balance", []);
    - D! Y1 g7 o/ B% W+ |6 {
12.     return {
    1 r% s4 q) r2 C" W
13.       number: stack.readNumber(),
    
14.     };
    2 a0 A( S# [  W; Z* r  Y9 S
15. }

复制代码

1. // ...library imports
   7 H6 @4 }: g7 g4 \: J5 J
2. 
   
3. describe("main.fc contract tests", () => {
     I4 ]: X/ y- H; Y
4.   it("should get the proper most recent sender address", async () => {
   
5.     const blockchain = await Blockchain.create();
   % ]3 O6 w- F6 d: m3 j
6.     const codeCell = Cell.fromBoc(Buffer.from(hex, "hex"))[0];
   + r: P6 M& R4 A) e& `5 Z8 }, L" Z
7. 
   
8.     const initAddress = await blockchain.treasury("initAddress");
   $ j8 v: ^! K- F  c
9.     const ownerAddress = await blockchain.treasury("ownerAddress");
   
10.    
    
11.     const myContract = blockchain.openContract(
    * L3 f: U2 R; e( z: c" G( Q
12.       await MainContract.createFromConfig(
    
13.         {
    
14.           number: 0,
    
15.           address: initAddress.address,
    * U) H. S, _! I) s: k. ]6 V& r
16.           owner_address: ownerAddress.address, // now we create myContract from 3 parameters
    
17.         },
    
18.         codeCell
    
19.       )
    & B. P- d0 H7 m0 N
20.     );
    
21. 
    / Q2 [& u2 b) w
22. // ...rest of testing code

复制代码

$ U6 d. X' g/ i2 g) @# T% W. @' j

我们引入一个新的金库，它实际上将是合约的所有者，只有这个所有者以后才能提取资金。这些更新在 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 () => {
   
5.     const blockchain = await Blockchain.create();
   
6.     const codeCell = Cell.fromBoc(Buffer.from(hex, "hex"))[0];
   4 j1 C) u! f- o# o6 [( k" z
7. 
     W* L2 \0 K' b( |" H
8.     const initAddress = await blockchain.treasury("initAddress");
   + a2 \+ C- ~1 r; w: e- \
9.     const ownerAddress = await blockchain.treasury("ownerAddress");
   5 B2 `# {2 h4 i5 }5 F% N  G
10.    
    
11.     const myContract = blockchain.openContract(
    ( e. B% @/ q0 _, I
12.       await MainContract.createFromConfig(
    
13.         {
    
14.           number: 0,
    
15.           address: initAddress.address,
      p; d9 S) U. Y
16.           owner_address: ownerAddress.address, // now we create myContract from 3 parameters
    ) q8 H! Q/ L, a" |" h  v. `6 ~
17.         },
    
18.         codeCell
    
19.       )
    , C6 }) [& n9 J. I# W0 I5 ~( P
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";
   2 ?. g( P- B) N# x/ V% i/ M' S
3. // ... other library imports
   
4. describe("main.fc contract tests", () => {
   
5.   let blockchain: Blockchain;
   
6.   let myContract: SandboxContract<MainContract>;
   
7.   let initWallet: SandboxContract<TreasuryContract>;
   
8.   let ownerWallet: SandboxContract<TreasuryContract>;
     ^, \# }* R: Z6 y: g2 j4 f; n6 v
9. 
   
10.   beforeEach(async () => {
    
11.     blockchain = await Blockchain.create();
    : |1 @* R; s: J1 {7 y" ?
12.     initWallet = await blockchain.treasury("initWallet");
    
13.     ownerWallet = await blockchain.treasury("ownerWallet");
    $ ~* S! F* B8 K% {4 x
14. 
    
15.     const codeCell = Cell.fromBoc(Buffer.from(hex, "hex"))[0];
    * ~" L4 H2 z$ h2 v8 q& j# V4 o
16. 
    4 f& T+ c9 {) P6 B
17.     myContract = blockchain.openContract(
    
18.       await MainContract.createFromConfig(
    - E( j, @! A* n, Q; z% l% }8 Z$ d
19.         {
    
20.           number: 0,
    , F0 D% D5 e* V& X1 Z
21.           address: initWallet.address,
    ' R0 p8 B. O! m7 C4 y
22.           owner_address: ownerWallet.address,
    
23.         },
    : G* U8 m9 }/ S! P0 O
24.         codeCell
    1 k5 ^4 E4 V; c; O$ ]9 |' }6 r0 F
25.       )
    7 s, Z& z0 X7 q$ p
26.     );
    
27.   });
    # q4 H: |5 ~0 s; d, T' e( H
28. 
    
29.   it("should get the proper most recent sender address", async () => {
    
30.     const senderWallet = await blockchain.treasury("sender");
    
31. 
    
32.     const sentMessageResult = await myContract.sendIncrement(
    . \0 d% Q6 f. L1 A" r) ~0 b
33.       senderWallet.getSender(),
    
34.       toNano("0.05"),
    + u, H" L0 r7 o4 M# I; s
35.       1
    8 N" V4 m9 {# U. n
36.     );
    2 t) ~- J9 }/ l' q4 t: y
37. 
    
38.     expect(sentMessageResult.transactions).toHaveTransaction({
    " N$ [7 ~9 E  ^3 k1 e
39.       from: senderWallet.address,
    7 S+ o. e% M; t/ {. ]# V, _8 {
40.       to: myContract.address,
    6 M% q/ Q# X1 d6 _- |1 D
41.       success: true,
    
42.     });
    5 Q9 O/ t$ f, r9 Z+ Y, e
43. 
    
44.     const data = await myContract.getData();
    
45. 
    2 l& p2 Z4 Y- v$ R3 l
46.     expect(data.recent_sender.toString()).toBe(senderWallet.address.toString());
    $ T& R0 g5 H% }5 O4 k' H
47.     expect(data.number).toEqual(1);
    
48.   });
    ) y% c1 x# H+ Z; ]; X
49.   it("successfully deposits funds", () => {
    
50.     // test logic is coming
    - e  m) {4 g  N% p: Z
51.   });
    6 u2 B" e0 ^. L5 D# X  G
52.   it("should return deposit funds as no command is sent", () => {
    
53.     // test logic is coming
    ; N& b( C9 ?0 Y& w, D# K
54.   });
    
55.   it("successfully withdraws funds on behalf of owner", () => {
    % G/ T2 k7 E( l( a# r
56.     // test logic is coming
    
57.   });
    
58.   it("fails to withdraw funds on behalf of non-owner", () => {
    
59.     // test logic is coming
    
60.   });
    ) J5 E0 M/ E3 d0 V  `" ], b
61.   it("fails to withdraw funds because lack of balance", () => {
    ( @; Y/ P5 o. K$ {1 h. B* @& s
62.     // test logic is coming
    
63.   });
    
64. });

复制代码

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

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

1. async sendDeposit(provider: ContractProvider, sender: Sender, value: bigint) {
   6 H1 Y& \& T. P  v
2.     const msg_body = beginCell()
   3 D: |8 q/ _; B( D/ \4 D
3.       .storeUint(2, 32) // OP code
   
4.       .endCell();
   
5. 
   
6.     await provider.internal(sender, {
   5 Z/ p/ B* n  [  s; S9 p
7.       value,
   , z' z* n& p. C# w- T
8.       sendMode: SendMode.PAY_GAS_SEPARATELY,
   : J9 t1 ?5 p% C5 f- q
9.       body: msg_body,
   
10.     });
    ; V8 N. N! I; @# S. f1 U
11.   }

复制代码

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

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

1. it("successfully deposits funds", async () => {
   8 [: f1 B: D  I, }! E8 K7 Y
2.     const senderWallet = await blockchain.treasury("sender");
   ( f2 F) i0 g, |3 r" l( t- Q
3. 
   
4.     const depositMessageResult = await myContract.sendDeposit(
   
5.       senderWallet.getSender(),
   0 {  I- J( a! T5 ^3 e$ y
6.       toNano("5")
   
7.     );
   
8. 
   
9.     expect(depositMessageResult.transactions).toHaveTransaction({
   4 F0 b; {, F3 M2 m; q! [* K
10.       from: senderWallet.address,
    
11.       to: myContract.address,
    
12.       success: true,
    3 a" q& q4 `8 M2 {7 F
13.     });
    
14. 
    ; X( [8 v  z3 z
15.     const balanceRequest = await myContract.getBalance();
    5 r5 N4 J5 \9 q7 B" S( ]( ]8 M5 |
16. 
    ; X  P$ N4 |& @4 t$ i$ {7 l4 K
17.     expect(balanceRequest.number).toBeGreaterThan(toNano("4.99"));
    ) a" S/ _# {5 I
18.   });

复制代码

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

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

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

1. async sendNoCodeDeposit(
   
2.     provider: ContractProvider,
   
3.     sender: Sender,
   
4.     value: bigint
   6 q+ y1 ^7 {5 b- g
5.   ) {
   0 D5 v% w) ^, I7 c
6.     const msg_body = beginCell().endCell();
   3 e6 Y7 N3 p3 P) L9 F% L* [
7. 
   * h# c2 i" @. O, ]: ^
8.     await provider.internal(sender, {
   
9.       value,
   
10.       sendMode: SendMode.PAY_GAS_SEPARATELY,
    ( h/ Q3 W7 c5 W6 p" W
11.       body: msg_body,
    
12.     });
    
13.   }

复制代码

下面是测试代码：

1. it("should return funds as no command is sent", async () => {
   
2.     const senderWallet = await blockchain.treasury("sender");
   
3. 
   
4.     const depositMessageResult = await myContract.sendNoCodeDeposit(
   
5.       senderWallet.getSender(),
   
6.       toNano("5")
   
7.     );
   
8. 
   
9.     expect(depositMessageResult.transactions).toHaveTransaction({
   
10.       from: myContract.address,
    
11.       to: senderWallet.address,
    7 @: l% I( V% @  i9 l  A
12.       success: true,
    : F/ n& _2 @+ b9 |  x- Q' Z
13.     });
    
14. 
    4 X4 D3 j5 l; f4 b
15.     const balanceRequest = await myContract.getBalance();
    
16. 
    # J+ U+ x8 H8 d6 Y) w
17.     expect(balanceRequest.number).toBe(0);
    & @8 V# H: Y# l' m# p: V  `# I
18. });

复制代码

提款测试

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

1. async sendWithdrawalRequest(
   $ I$ @8 X) U' z
2.     provider: ContractProvider,
   
3.     sender: Sender,
   ; @" R9 x+ J6 i& B7 r1 \1 [
4.     value: bigint,
   
5.     amount: bigint
   ' }! X- f* P& |; `8 P
6.   ) {
   
7.     const msg_body = beginCell()
   
8.       .storeUint(3, 32) // OP code
   7 }8 S2 W3 ~( P* w6 |
9.       .storeCoins(amount)
   
10.       .endCell();
    
11. 
    
12.     await provider.internal(sender, {
    
13.       value,
    * C) d6 g+ n' d3 S
14.       sendMode: SendMode.PAY_GAS_SEPARATELY,
    # U8 B5 F& z+ _" g, z
15.       body: msg_body,
    / {+ n$ I1 g3 ]- I
16.     });
    9 m, f/ J. @" g1 ~# ?
17.   }

复制代码

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

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

1. it("successfully withdraws funds on behalf of owner", async () => {
   
2.     const senderWallet = await blockchain.treasury("sender");
   
3. 
   $ P  I6 g9 Y- [8 T; N
4.     await myContract.sendDeposit(senderWallet.getSender(), toNano("5"));
   ' k- I2 Q! E+ b3 D0 c
5. 
   5 W, ?: ?6 {* ~/ K: C4 u
6.     const withdrawalRequestResult = await myContract.sendWithdrawalRequest(
   ( D6 [" O% j4 K) z
7.       ownerWallet.getSender(),
   
8.       toNano("0.05"),
   ) V& ^$ K+ p5 x) w
9.       toNano("1")
   
10.     );
    
11. 
    
12.     expect(withdrawalRequestResult.transactions).toHaveTransaction({
    
13.       from: myContract.address,
    ; r/ p7 E; J% u4 e( v
14.       to: ownerWallet.address,
    % K7 a, `$ z# i
15.       success: true,
    $ p' ?4 q  L3 y* d$ p- w0 a) C  k# \, L
16.       value: toNano(1),
      P* L- Q' ]! D
17.     });
    5 J0 d& P) a/ X( P& O- }
18.   });

复制代码

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

1. it("fails to withdraw funds on behalf of not-owner", async () => {
   4 z; L0 S( S# P/ M
2.     const senderWallet = await blockchain.treasury("sender");
   
3. 
   2 n2 ]  }  ?, T& d1 G7 s3 S3 \
4.     await myContract.sendDeposit(senderWallet.getSender(), toNano("5"));
   9 t+ I9 P/ v+ E" M$ ^5 C
5. 
   & a$ c7 X) W" G
6.     const withdrawalRequestResult = await myContract.sendWithdrawalRequest(
   
7.       senderWallet.getSender(),
   ! k6 l  z* d/ w* P9 a/ I3 o- l3 ^/ `- r
8.       toNano("0.5"),
   
9.       toNano("1")
   : \( Z: q4 V9 Q/ u* I& y+ ~
10.     );
    * R* U2 a+ T  d, k5 s" J: |
11. 
    . ^5 W5 T) q/ m8 t- M7 f5 {
12.     expect(withdrawalRequestResult.transactions).toHaveTransaction({
    
13.       from: senderWallet.address,
    7 j% |, S: n" ?
14.       to: myContract.address,
    # I, z$ B0 X5 K* z
15.       success: false,
    
16.       exitCode: 103,
    7 W/ |& k+ p# @- l, J
17.     });
    
18.   });

复制代码

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

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

1. throw_unless(103, equal_slice_bits(sender_address, owner_address));
   ' z* K. k7 y! X8 X

复制代码

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

1. it("fails to withdraw funds because lack of balance", async () => {
   6 c& `8 @8 C5 R/ n& |
2.     const withdrawalRequestResult = await myContract.sendWithdrawalRequest(
   
3.       ownerWallet.getSender(),
   
4.       toNano("0.5"),
   
5.       toNano("1")
   ' [" y, b; z& `% D  v5 l! N8 Y
6.     );
   2 [* o4 H7 ?3 |7 M3 v( x4 r
7. 
   
8.     expect(withdrawalRequestResult.transactions).toHaveTransaction({
   
9.       from: ownerWallet.address,
   
10.       to: myContract.address,
    3 Z+ m! p3 l! ?' \. {! g. }3 ?7 J
11.       success: false,
    % a# C7 q7 V0 r  U0 U
12.       exitCode: 104,
    5 [2 w6 P1 z  B; g
13.     });
    ) Y% p5 B7 D- y
14.   });

复制代码

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

复制代码

就是这样

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

; {5 M& ]1 m  M( j- C7 a2 S2 |% t