4.4 存款/提款逻辑测试

riyad

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

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

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

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

更新我们的合约包装器

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

1. // ...library imports
   9 R5 t8 M" _/ K( Z; W
2. 
   
3. export type MainContractConfig = {
   
4.   number: number;
   
5.   address: Address;
   2 D- ]( [' ^# ^/ W: l
6.   owner_address: Address;
   
7. };
   
8. 
   
9. export function mainContractConfigToCell(config: MainContractConfig): Cell {
   
10.   return beginCell()
    8 k  h8 s" a! i3 _, K
11.     .storeUint(config.number, 32)
    
12.     .storeAddress(config.address)
    
13.     .storeAddress(config.owner_address)
    
14.     .endCell();
    
15. }
    * E: t2 h- G7 l3 B' u
16. 
    5 c! P0 l5 q$ o8 B' I
17. // ...contact wrapper class

复制代码

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

1. async getData(provider: ContractProvider) {
   
2.     const { stack } = await provider.get("get_contract_storage_data", []);
   
3.     return {
   
4.       number: stack.readNumber(),
   
5.       recent_sender: stack.readAddress(),
   
6.       owner_address: stack.readAddress(),
   
7.     };
   
8.   }
   1 f' _6 X% _/ `# n6 e2 ~
9.   
   / r; h- F# @3 Q$ D, E4 p: z2 A' w
10. async getBalance(provider: ContractProvider) {
    ! a# i2 J0 h4 _
11.     const { stack } = await provider.get("balance", []);
    
12.     return {
    
13.       number: stack.readNumber(),
    
14.     };
    $ E; A8 e& }3 c! m9 X! j
15. }

复制代码

1. // ...library imports
   
2. 
   5 e) c) {. B" h" [1 h: ?& q. C
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];
   9 V6 V+ z) @& q* h7 h" ^4 y
7. 
   5 `. }9 `- [, c% b
8.     const initAddress = await blockchain.treasury("initAddress");
   
9.     const ownerAddress = await blockchain.treasury("ownerAddress");
   
10.    
    0 F, M+ w  r+ v
11.     const myContract = blockchain.openContract(
    
12.       await MainContract.createFromConfig(
    
13.         {
    & h) D( F" y3 E2 ]' ^
14.           number: 0,
    % z# p; o2 l# p# k" A# r" Y
15.           address: initAddress.address,
      v( A; A: g) U2 U  E  V7 A% }
16.           owner_address: ownerAddress.address, // now we create myContract from 3 parameters
    - K; t$ a5 ^( i; E% ], b/ f
17.         },
    ! c8 k  g( @. r% v  k+ W
18.         codeCell
    , I. _, o8 z( b# Q% y- a
19.       )
    
20.     );
    
21. 
    8 e" H; t) z% d: x
22. // ...rest of testing code

复制代码

: R3 l8 U, d  {; G% J

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

1. // ...library imports
   
2. 
   
3. describe("main.fc contract tests", () => {
   3 Z2 N0 k, f8 {6 T4 F0 k/ t
4.   it("should get the proper most recent sender address", async () => {
   
5.     const blockchain = await Blockchain.create();
   9 n& o0 a7 |* O7 X5 F: m
6.     const codeCell = Cell.fromBoc(Buffer.from(hex, "hex"))[0];
   3 S8 X3 q. ^5 r# A- l
7. 
   
8.     const initAddress = await blockchain.treasury("initAddress");
   2 P; s- ~5 I" \1 A
9.     const ownerAddress = await blockchain.treasury("ownerAddress");
   ) ]( Y/ j3 k2 M1 S+ u4 O
10.    
    * N7 f+ J+ }) L* G0 I1 ]
11.     const myContract = blockchain.openContract(
    
12.       await MainContract.createFromConfig(
    7 R+ g  k( e/ }1 Y! g
13.         {
    
14.           number: 0,
    
15.           address: initAddress.address,
    
16.           owner_address: ownerAddress.address, // now we create myContract from 3 parameters
    
17.         },
    # W8 V" i/ _2 v& o* u
18.         codeCell
    5 s$ s' r0 O2 O( U; }1 E2 G7 U* _
19.       )
    - j; @+ l$ L1 }; Q" `7 I
20.     );
    
21. 
      I) _% k5 u# ], u5 v
22. // ...rest of testing code

复制代码

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

' e) d8 n9 s' m存款测试

让我们在 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
   % t2 {4 Q5 p$ |6 L' G: z& {
4. describe("main.fc contract tests", () => {
   & Z3 Q% z; G( t- K; ?
5.   let blockchain: Blockchain;
   
6.   let myContract: SandboxContract<MainContract>;
   
7.   let initWallet: SandboxContract<TreasuryContract>;
   
8.   let ownerWallet: SandboxContract<TreasuryContract>;
   8 E2 j* {! x' y- D. B0 R
9. 
   
10.   beforeEach(async () => {
    0 }7 l' B  E6 n5 L
11.     blockchain = await Blockchain.create();
    
12.     initWallet = await blockchain.treasury("initWallet");
    # b& e( T5 e' f* N
13.     ownerWallet = await blockchain.treasury("ownerWallet");
    
14. 
    
15.     const codeCell = Cell.fromBoc(Buffer.from(hex, "hex"))[0];
    6 e/ r1 z( f$ y4 M9 X/ e% g
16. 
    6 V6 A" p# g) K7 @: @8 z8 g
17.     myContract = blockchain.openContract(
    
18.       await MainContract.createFromConfig(
    
19.         {
    " A3 U" `/ \8 k/ d7 e) Q. @
20.           number: 0,
    
21.           address: initWallet.address,
    
22.           owner_address: ownerWallet.address,
    + |1 r/ r. g" l/ d4 Q/ v
23.         },
    ! b3 p/ v& a  U% h
24.         codeCell
    ' z* T! E+ s/ \6 Q# R5 a; C
25.       )
    
26.     );
    8 V5 ^: k4 J1 c8 d$ E  @2 V
27.   });
    
28. 
    
29.   it("should get the proper most recent sender address", async () => {
    
30.     const senderWallet = await blockchain.treasury("sender");
    
31. 
    6 a& M6 m& d" {' k
32.     const sentMessageResult = await myContract.sendIncrement(
    7 }) b% N3 w) _# ]) Z
33.       senderWallet.getSender(),
    . ~/ o/ v$ o' P0 L+ c9 _3 V" D
34.       toNano("0.05"),
    - o/ C0 a  k$ N
35.       1
    
36.     );
    
37. 
    
38.     expect(sentMessageResult.transactions).toHaveTransaction({
    % b3 z* {' l" X7 F  z) e& e
39.       from: senderWallet.address,
    8 r& u8 Y6 }7 `" `
40.       to: myContract.address,
    
41.       success: true,
    
42.     });
    + w* P) r9 R1 N" E, x) [) f; R
43. 
    " G& [3 U- p; c" v0 o" T. _2 i
44.     const data = await myContract.getData();
    
45. 
    " D" \) {' h# N
46.     expect(data.recent_sender.toString()).toBe(senderWallet.address.toString());
    
47.     expect(data.number).toEqual(1);
    : v3 m& `; N- c) f$ a: A2 O" A. T
48.   });
    
49.   it("successfully deposits funds", () => {
    : ^6 _/ y$ `+ |5 H
50.     // test logic is coming
    
51.   });
    1 H! O" d/ w1 N4 `
52.   it("should return deposit funds as no command is sent", () => {
    
53.     // test logic is coming
    
54.   });
    % R* H- A& R- g/ i
55.   it("successfully withdraws funds on behalf of owner", () => {
    , s7 H  g; M* W
56.     // test logic is coming
    $ f7 e4 @: x  k5 ~# G! {' {
57.   });
    ) L, i1 c+ o" A2 a1 d; f  P( L
58.   it("fails to withdraw funds on behalf of non-owner", () => {
    
59.     // test logic is coming
    
60.   });
    ' M/ K7 T$ `. Y- K2 z3 K$ p* }  Q
61.   it("fails to withdraw funds because lack of balance", () => {
      J6 I9 V% E7 w$ J
62.     // test logic is coming
    
63.   });
    6 B9 l% `! T# q2 M5 ?- S) A( D
64. });

复制代码

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

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

1. async sendDeposit(provider: ContractProvider, sender: Sender, value: bigint) {
   : Y  [! D7 q7 F+ p' J9 r
2.     const msg_body = beginCell()
   ) e; F& \8 B+ R0 d. X6 I9 _3 _$ z9 j
3.       .storeUint(2, 32) // OP code
   
4.       .endCell();
   
5. 
   ; G# g. y. w* ]2 x7 x+ A5 ~
6.     await provider.internal(sender, {
   " r7 r) N: V3 L2 L# s( ~6 f
7.       value,
   8 i: n# R, f% t5 R3 W' J# m8 ?
8.       sendMode: SendMode.PAY_GAS_SEPARATELY,
   
9.       body: msg_body,
   8 n0 Z. m4 O2 _! b7 E& H" T
10.     });
    
11.   }

复制代码

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

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

1. it("successfully deposits funds", async () => {
   
2.     const senderWallet = await blockchain.treasury("sender");
   
3. 
   
4.     const depositMessageResult = await myContract.sendDeposit(
   
5.       senderWallet.getSender(),
   1 ?' L5 }. D+ [+ G
6.       toNano("5")
   
7.     );
   ' @+ U1 W; b. `# h$ D5 x% p
8. 
   
9.     expect(depositMessageResult.transactions).toHaveTransaction({
   7 L; @% N( f- t& o0 c' K( t
10.       from: senderWallet.address,
    
11.       to: myContract.address,
    
12.       success: true,
    
13.     });
    
14. 
    ' ^# K/ U' G" f# F7 t- R6 c% O
15.     const balanceRequest = await myContract.getBalance();
    ' j/ D  s- M/ r! g5 l
16. 
    ) i1 }5 {3 I  R8 C& `9 {, u
17.     expect(balanceRequest.number).toBeGreaterThan(toNano("4.99"));
    
18.   });

复制代码

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

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

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

1. async sendNoCodeDeposit(
   
2.     provider: ContractProvider,
   " n) S* H, F! Y% c  ~0 m
3.     sender: Sender,
   6 r, \; Y  g4 E( U
4.     value: bigint
   
5.   ) {
   4 v/ `- L% ~+ R& c' k
6.     const msg_body = beginCell().endCell();
   
7. 
   
8.     await provider.internal(sender, {
   
9.       value,
   3 f4 l/ P6 i8 E/ M0 z. Q
10.       sendMode: SendMode.PAY_GAS_SEPARATELY,
    
11.       body: msg_body,
    
12.     });
    - ^, [( U! x' e0 F
13.   }

复制代码

下面是测试代码：

" \1 e; o/ G$ u$ i& V4 N/ h6 ^, N

1. it("should return funds as no command is sent", async () => {
   3 \$ s, ^: H3 ^( x. e
2.     const senderWallet = await blockchain.treasury("sender");
   ) p  r- E: P7 S. ]
3. 
   ! Y7 w; E  I1 ]/ S
4.     const depositMessageResult = await myContract.sendNoCodeDeposit(
   
5.       senderWallet.getSender(),
   
6.       toNano("5")
   % h/ Q. c1 }4 l6 c$ A
7.     );
   
8. 
   
9.     expect(depositMessageResult.transactions).toHaveTransaction({
   ; m5 t: Z  {  e1 G) B/ E( W
10.       from: myContract.address,
    
11.       to: senderWallet.address,
    2 h+ }* y# |6 s) ?. f
12.       success: true,
    3 p: N8 F5 s/ r% o2 |  `
13.     });
    
14. 
    0 A: O% G) r$ d: |/ |: o
15.     const balanceRequest = await myContract.getBalance();
    " _" R& U& o$ L
16. 
    ( g& I! ^2 C6 O& q# u0 t: C
17.     expect(balanceRequest.number).toBe(0);
    
18. });

复制代码

提款测试

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

1. async sendWithdrawalRequest(
   - p/ J4 K6 _/ J2 U9 r) v( t( [3 d
2.     provider: ContractProvider,
   5 p9 t6 m( J  _& H% [# u! m, ?$ p
3.     sender: Sender,
   
4.     value: bigint,
   5 P9 L0 s* d$ p
5.     amount: bigint
   
6.   ) {
   
7.     const msg_body = beginCell()
   
8.       .storeUint(3, 32) // OP code
   ; o1 I8 x4 g. B: a
9.       .storeCoins(amount)
   
10.       .endCell();
    - G$ m/ }/ {, _8 }# Y) N: \
11. 
    
12.     await provider.internal(sender, {
    7 j6 l8 f6 L. P" A0 k
13.       value,
    $ m, n( P% V( I# h0 _
14.       sendMode: SendMode.PAY_GAS_SEPARATELY,
    1 N4 v8 U6 @$ p
15.       body: msg_body,
    5 f$ C3 g% I1 D' h  v
16.     });
    7 ^4 i8 S5 f! w( @# p  P
17.   }

复制代码

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

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

1. it("successfully withdraws funds on behalf of owner", async () => {
   
2.     const senderWallet = await blockchain.treasury("sender");
   * x( @8 \) J( h  b
3. 
   
4.     await myContract.sendDeposit(senderWallet.getSender(), toNano("5"));
   
5. 
   
6.     const withdrawalRequestResult = await myContract.sendWithdrawalRequest(
   ' L: a& ]) U5 \  v
7.       ownerWallet.getSender(),
   ( P% [+ H6 L, {9 t- A3 k4 _/ J4 s' u
8.       toNano("0.05"),
   
9.       toNano("1")
   
10.     );
    
11. 
    5 l% N' |+ u1 T
12.     expect(withdrawalRequestResult.transactions).toHaveTransaction({
    + B6 t1 e3 @% h3 Y
13.       from: myContract.address,
    4 R; }9 e5 J6 N/ T
14.       to: ownerWallet.address,
    & A* d. {" T4 {4 J* |5 K8 L
15.       success: true,
    . {% r1 ?1 m" [: w9 @
16.       value: toNano(1),
      H: T* Z4 Q/ W* _
17.     });
    3 [/ A. S" P; c) \; X1 J& a
18.   });

复制代码

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

1. it("fails to withdraw funds on behalf of not-owner", async () => {
   $ C4 T9 b% z, I+ }8 H0 _+ l; ?, k
2.     const senderWallet = await blockchain.treasury("sender");
   
3. 
   - D# X; ?2 B/ e/ a' m7 q# R
4.     await myContract.sendDeposit(senderWallet.getSender(), toNano("5"));
   9 S1 i' l% ]8 ~+ v
5. 
   ) V( O% {1 P1 ?4 K. ?  ?; m0 C
6.     const withdrawalRequestResult = await myContract.sendWithdrawalRequest(
   7 C' ~# m) @5 s% T( b5 U' L
7.       senderWallet.getSender(),
   
8.       toNano("0.5"),
   & E6 |# a& K% O9 Q, I+ `$ b
9.       toNano("1")
   
10.     );
    
11. 
    / T) ^5 m) C. _! G+ J! C
12.     expect(withdrawalRequestResult.transactions).toHaveTransaction({
    
13.       from: senderWallet.address,
    
14.       to: myContract.address,
    $ n' S) M8 D7 S% `+ R" D
15.       success: false,
    ) y* _! ^4 }: V# m! ?8 t9 D
16.       exitCode: 103,
    - |' b! X. A0 ?
17.     });
    6 b- n* w, S8 R
18.   });

复制代码

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

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

1. throw_unless(103, equal_slice_bits(sender_address, owner_address));
   

复制代码

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

1. it("fails to withdraw funds because lack of balance", async () => {
   " U  ?% `7 z1 h0 Z4 _  z- O
2.     const withdrawalRequestResult = await myContract.sendWithdrawalRequest(
   
3.       ownerWallet.getSender(),
     d" \6 R* X9 V. q
4.       toNano("0.5"),
     ?4 v* p* k# }6 x
5.       toNano("1")
   
6.     );
   
7. 
   * u  u& S1 |8 m# r6 _/ m
8.     expect(withdrawalRequestResult.transactions).toHaveTransaction({
   5 S- M# |7 C" R9 u2 ^
9.       from: ownerWallet.address,
   $ q/ T0 |" K4 H/ z
10.       to: myContract.address,
    
11.       success: false,
    : e, j1 i- P2 R+ m
12.       exitCode: 104,
    
13.     });
    
14.   });

复制代码

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

复制代码

就是这样

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

* U! q( }8 G9 a/ l$ X4 m2 j( n