Skip to content

Commit 02e9722

Browse files
authored
Merge pull request #202 from dimitrov-d/main
Update smart contract docs
2 parents 706e3e4 + 03c8d7e commit 02e9722

File tree

4 files changed

+63
-44
lines changed

4 files changed

+63
-44
lines changed

build/13-contracts-api.md build/14-smart-contracts-api.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contracts API
1+
# Smart Contracts API
22

33
API for creation and management of smart contracts through Apillon wallets on supported EVM chains.
44

@@ -360,7 +360,7 @@ Array item(s) format depends on value of `solidityJson` passed as query paramete
360360
<CodeGroupItem title="cURL" active>
361361

362362
```sh
363-
curl --location 'https://api.apillon.io/contracts/:uuid/deploy' \
363+
curl --location 'https://api.apillon.io/contracts/:uuid/deploy' \
364364
--header 'Authorization: Basic :credentials'
365365
--data-raw '{
366366
"name": "Test Contract 2",
@@ -641,7 +641,7 @@ All query parameters from [listing request](1-apillon-api.md#listing-requests) p
641641

642642
Response is a list of items (shorter version) described [under Response Fields above](#response-fields).
643643

644-
Item is a shorter version because it is a flat object and it doesn't include nested `contractVersion` (with `abi`,
644+
Item is a shorter version because it is a flat object and it doesn't include nested `contractVersion` (with `abi`,
645645
`methods` and `contract`), instead it exposes some details from this table:
646646

647647
##### Response Fields
@@ -857,7 +857,7 @@ All query parameters from [listing request](1-apillon-api.md#listing-requests),
857857
| 40300000 | Not allowed to access deployed contract. |
858858

859859
#### Response
860-
Endpoint returns ABI methods as an array.
860+
Endpoint returns ABI methods as an array.
861861

862862
Array item(s) format depends on value of `solidityJson` passed as query parameter (human-readable ABI or ABI in Solidity JSON format).
863863

@@ -1020,21 +1020,21 @@ Endpoint returns transactions for deployed contract based on filters.
10201020

10211021
| Name | Type | Description |
10221022
|-------------------------|------------|-------------------------------------|
1023-
| `contractUuid` | `string` | UUID of the contract. |
1024-
| `projectUuid` | `string` | UUID of the associated project. |
1025-
| `name` | `string` | Name of the contract. |
1026-
| `description` | `string` | Description of the contract. |
1027-
| `chainType` | `number` | Type of blockchain chain. |
1028-
| `chain` | `number` | ID of the blockchain. |
1029-
| `versionId` | `number` | Version ID of the contract. |
1030-
| `constructorArguments` | `any[]` | Arguments for the constructor. |
1031-
| `contractStatus` | `number` | Status of the contract deployment. |
1032-
| `contractAddress` | `string` | Deployed contract address. |
1033-
| `deployerAddress` | `string` | Address of the deployer. |
1034-
| `transactionHash` | `string` | Transaction hash of deployment. |
1023+
| `contractUuid` | `string` | UUID of the contract. |
1024+
| `projectUuid` | `string` | UUID of the associated project. |
1025+
| `name` | `string` | Name of the contract. |
1026+
| `description` | `string` | Description of the contract. |
1027+
| `chainType` | `number` | Type of blockchain chain. |
1028+
| `chain` | `number` | ID of the blockchain. |
1029+
| `versionId` | `number` | Version ID of the contract. |
1030+
| `constructorArguments` | `any[]` | Arguments for the constructor. |
1031+
| `contractStatus` | `number` | Status of the contract deployment. |
1032+
| `contractAddress` | `string` | Deployed contract address. |
1033+
| `deployerAddress` | `string` | Address of the deployer. |
1034+
| `transactionHash` | `string` | Transaction hash of deployment. |
10351035
| `contractVersion` | `string` | Version of the contract (nullable). |
1036-
| `createTime` | `Datetime` | Creation time of the contract. |
1037-
| `updateTime` | `Datetime` | Last update time of the contract. |
1036+
| `createTime` | `Datetime` | Creation time of the contract. |
1037+
| `updateTime` | `Datetime` | Last update time of the contract. |
10381038

10391039

10401040
</div>

build/6-apillon-cli.md

-1
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,6 @@ Upload contents of a local folder to specified bucket.
376376
- `-b, --bucket-uuid <string>`: UUID of the bucket to upload files to.
377377
- `-w, --wrap`: Wrap uploaded files to an IPFS directory
378378
- `-p, --path <string>`: Path to upload files to (e.g. main/subdir). Required when --wrap is supplied.
379-
- `--await`: await file CIDs to be resolved
380379

381380
**Example**
382381

web3-services/10-web3-contracts.md

-25
This file was deleted.
+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Smart Contracts
2+
3+
The Apillon Contract Service enables efficient deployment and comprehensive management of smart contracts across multiple
4+
blockchain networks, providing a seamless and scalable solution for developers and enterprises.
5+
6+
This service currently supports deploying smart contracts on various EVM-compatible blockchain networks, including:
7+
- [Astar Network](https://docs.astar.network/docs/build/introduction/astar_family)
8+
- [Moonbeam Network](https://docs.moonbeam.network/builders/get-started/networks/moonbeam/)
9+
- [Moonbase Network](https://docs.moonbeam.network/builders/get-started/networks/moonbase/)
10+
11+
## Smart Contract Deployment
12+
13+
Deploying a smart contract is straightforward with Apillon's streamlined process. To deploy a smart contract, follow these steps:
14+
15+
1. Log in to your [Apillon account](https://app.apillon.io/register).
16+
2. Navigate to the "Contracts" section from the menu on the left and click on "New Smart Contract."
17+
3. Select the desired smart contract for deployment.
18+
4. Customize the contract through the provided configuration form and initiate the deployment.
19+
5. Once deployed, utilize read and write methods to interact directly with the contract.
20+
21+
## Smart Contract Versioning
22+
23+
To ensure ongoing security and feature enhancements, Apillon employs versioned smart contracts. Each deployed contract
24+
maintains a version to guarantee that the appropriate ABI (Application Binary Interface) is used during interactions,
25+
safeguarding compatibility and providing a stable experience for contract users.
26+
27+
## Supported Smart Contract Types
28+
29+
Apillon supports various types of smart contracts to cater to different use cases and requirements. The currently supported smart contract types include ERC-20, ERC-721, and ERC-1155.
30+
31+
### ERC-20
32+
33+
ERC-20 is a widely adopted standard for fungible tokens on the Ethereum blockchain. These tokens are interchangeable and have the same value, making them ideal for use cases such as cryptocurrencies, utility tokens, and other digital assets. Apillon's ERC-20 smart contracts allow for seamless token creation, transfer, and management, ensuring compatibility with a wide range of wallets and exchanges.
34+
35+
### ERC-721
36+
37+
ERC-721 is the standard for non-fungible tokens (NFTs), which are unique and cannot be exchanged on a one-to-one basis like ERC-20 tokens. Each ERC-721 token has distinct properties and metadata, making them perfect for representing ownership of unique items such as digital art, collectibles, and real estate. Apillon's ERC-721 smart contracts provide robust functionality for minting, transferring, and managing NFTs, enabling developers to create and manage unique digital assets with ease.
38+
39+
### ERC-1155
40+
41+
ERC-1155 is a versatile standard that supports both fungible and non-fungible tokens within a single contract. This multi-token standard allows for more efficient transactions and storage, as multiple token types can be managed under one contract. Apillon's ERC-1155 smart contracts are ideal for applications that require a combination of fungible and non-fungible tokens, such as gaming assets, where a single contract can handle in-game currencies, items, and unique collectibles.
42+
43+
## Smart Contract API
44+
45+
To read more about the Smart Contract API, please refer to the [Apillon Smart Contracts API documentation](../build/14-smart-contracts-api.md).

0 commit comments

Comments
 (0)