-
Notifications
You must be signed in to change notification settings - Fork 34
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: add asset sdk docs #53
Open
pixelplex
wants to merge
1
commit into
ton-org:main
Choose a base branch
from
pixelplex:asset-sdk
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,6 +15,7 @@ The key difference of this package from [ton-contract-executor](https://github.c | |
* [Cross contract tests](#cross-contract-tests) | ||
* [Testing key points](#testing-key-points) | ||
* [Test examples](#test-examples) | ||
* [Using assets in tests](#using-assets-in-tests) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. d There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. R |
||
* [Sandbox pitfalls](#sandbox-pitfalls) | ||
* [Viewing logs](#viewing-logs) | ||
* [Setting smart contract state directly](#setting-smart-contract-state-directly) | ||
|
@@ -282,6 +283,52 @@ In order to make sure that the contract will work as expected, you need to follo | |
More information about testing key points can be found here: | ||
* [Testing key point](docs/testing-key-points.md) | ||
|
||
### Using assets in tests | ||
|
||
It is a common thing to have interactions with jetton or nft in smart contracts. | ||
To replicate jetton behaviour in tests you can use wrappers from `@ton-community/assets-sdk`. | ||
|
||
```typescript | ||
import { Blockchain, SandboxContract, TreasuryContract } from '@ton/sandbox'; | ||
import { beginCell, toNano } from '@ton/core'; | ||
import { JettonMinter, JettonWallet } from '@ton-community/assets-sdk'; | ||
import '@ton/test-utils'; | ||
|
||
describe('Jetton', () => { | ||
let blockchain: Blockchain; | ||
let deployer: SandboxContract<TreasuryContract>; | ||
let jettonMinter: SandboxContract<JettonMinter>; | ||
|
||
beforeAll(async () => { | ||
blockchain = await Blockchain.create(); | ||
deployer = await blockchain.treasury('deployer'); | ||
jettonMinter = blockchain.openContract(JettonMinter.createFromConfig({ | ||
admin: deployer.address, | ||
content: beginCell().storeStringTail('USDT').endCell() | ||
})); | ||
|
||
const deployResult = await jettonMinter.sendDeploy(deployer.getSender(), toNano(0.05)); | ||
expect(deployResult.transactions).toHaveTransaction({ | ||
from: deployer.address, | ||
on: jettonMinter.address, | ||
deploy: true, | ||
success: true, | ||
}) | ||
}); | ||
|
||
it('should mint', async () => { | ||
const jettonWalletAddress = await jettonMinter.getWalletAddress(deployer.address); | ||
const jettonWallet = blockchain.openContract(JettonWallet.createFromAddress(jettonWalletAddress)); | ||
|
||
const jettonAmount = 10n; | ||
await jettonMinter.sendMint(deployer.getSender(), deployer.address, jettonAmount); | ||
|
||
const walletData = await jettonWallet.getData(); | ||
|
||
expect(walletData.balance).toEqual(jettonAmount); | ||
}); | ||
}); | ||
``` | ||
|
||
### Test Examples | ||
You can typically find various tests for Sandbox-based project contracts in the `./tests` directory. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
c