From 860612aa2828d44e1def331085614fbc4ad127c4 Mon Sep 17 00:00:00 2001 From: Pavel Ivanov Date: Tue, 13 Aug 2024 14:37:06 +0300 Subject: [PATCH] test --- examples/README.md | 37 ++++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/examples/README.md b/examples/README.md index 268237ea..9e3778a3 100644 --- a/examples/README.md +++ b/examples/README.md @@ -18,7 +18,7 @@ To build all the smart contracts, run the following command in the root of the p pnpm build ``` -### Test +### Test To run the tests for the example smart contracts, use the following command: @@ -30,18 +30,33 @@ This command will execute the test suites associated with each smart contract, e ## List of Example Smart Contracts -Below is a list of the smart contracts included in this directory +The following smart contracts demonstrate various capabilities of the NEAR blockchain, using JavaScript/TypeScript. +Each example highlights specific features and serves as a practical guide for developers. -- `basic-updates` - A simple smart contract that can make basic state updates. -- `counter` - A simple smart contract that demonstrates state management by implementing a basic counter with increment and decrement functionalities. -- `cross-contract` - A smart contract that demonstrates how to perform cross-contract calls on the NEAR blockchain. This contract manages the assignment of a person on call by querying an external status message contract to check the availability of a given account. -- `fungible-token` - Example implementation of a Fungible Token contract which uses [near-contract-standards](https://github.com/near/near-sdk-js/tree/develop/packages/near-contract-standards) including `storage_management`. -- `non-fungible-token` - Example implementation of a NFT(Non-Fungible Token) contract which uses [near-contract-standards](https://github.com/near/near-sdk-js/tree/develop/packages/near-contract-standards). -- `programmatic-updates` - The `programmatic-update-after.js` contract is the updated version that follows `programmatic-update-before.js`. Contracts showcasing how contracts can evolve while maintaining certain logic from previous versions. -- `state-migration` - A smart contract that demonstrates how to handle state migration in a NEAR smart contract. This contract shows how to upgrade the structure of stored data while preserving the integrity of existing data. -- `status-message` - Smart Contracts that record the status messages of the accounts that call the contracts. +**[basic-updates](https://github.com/near/near-sdk-js/tree/documentation-improvements/examples/src/basic-updates)** + A simple smart contract that can make basic state updates. + +**[counter](https://github.com/near/near-sdk-js/tree/documentation-improvements/examples/src/counter)** + A simple smart contract that demonstrates state management by implementing a basic counter with increment and decrement functionalities. + +**[cross-contract](https://github.com/near/near-sdk-js/tree/documentation-improvements/examples/src/cross-contract)** + A smart contract that demonstrates how to perform cross-contract calls on the NEAR blockchain, including querying external contracts to manage on-chain interactions. + +**[fungible-token](https://github.com/near/near-sdk-js/tree/documentation-improvements/examples/src/fungible-token)** + Example implementation of a Fungible Token (FT) contract using the [near-contract-standards](https://github.com/near/near-sdk-js/tree/develop/packages/near-contract-standards), including `storage_management`. + +**[non-fungible-token](https://github.com/near/near-sdk-js/tree/documentation-improvements/examples/src/non-fungible-token)** + Example implementation of a Non-Fungible Token (NFT) contract using the [near-contract-standards](https://github.com/near/near-sdk-js/tree/develop/packages/near-contract-standards). + +**[programmatic-updates](https://github.com/near/near-sdk-js/tree/documentation-improvements/examples/src/programmatic-updates)** + Contracts showcasing how contracts can evolve while maintaining certain logic from previous versions. + +**[state-migration](https://github.com/near/near-sdk-js/tree/documentation-improvements/examples/src/state-migration)** + A smart contract that demonstrates how to handle state migration in a NEAR smart contract. + +**[status-message](https://github.com/near/near-sdk-js/tree/documentation-improvements/examples/src/status-message)** + Smart contracts that record the status messages of the accounts that call the contracts. ## Contributing If you find any issues or have suggestions for improvement, feel free to open an issue or submit a pull request. Contributions are welcome! -