ArdorDocs - User contributions [en]

Asset to ERC1155 Bridge

2022-03-10T14:25:47Z

Stefan:

<languages />
<translate>
{{#seo:
|title=Ardor Asset to ERC-1155 Bridge
|titlemode=replace
|keywords=asset, erc1155, erc, nft, blockchain, proof of stake, ardor, ignis, jelurida, development, ardor wiki, wiki, tutorials, advanced tutorials
|description=Detailed explanation step by step for connecting Ardor Asset with ERC1155 tokens on the Ethereum network
}}
[[Category:Advanced_guides]]
__TOC__
== Introduction ==
This is a tutorial for developers, who want to run a peg between Ardor assets and Ethereum tokens. It will introduce you to a new feature on Ardor platform - Asset to ''ERC-1155'' Bridge - a contract for maintaining peg of [https://eips.ethereum.org/EIPS/eip-1155 ''ERC-1155''] tokens to [https://ardordocs.jelurida.com/Asset_exchange Assets on Ardor]. The ''ERC-1155'' tokens are considered a "wrapped" version of the Ardor assets, which exists on the Ethereum or some other EVM-compatible network. Please note that TestNet was used for the tutorial, but the steps remain the same for MainNet, where the only difference is using real currency/tokens.

== Peg Initialization ==

=== 1. Get an Ethereum full node ===
Install and sync an Ethereum full node, register with [https://infura.io Infura] or similar provider.
Other EVM-compatible networks are also supported.

=== 2. ERC-1155 tokens minting ===
Skip this step if [[#6.13._Auto-minting|auto-minting ('''autoMintErc1155''')]] is going to be enabled.

For each asset which is going to be wrapped, mint a token with some ''ERC1155''-compatible
Ethereum contract. Remember that the amount of the minted ''ERC-1155'' tokens must not exceed the asset quantity in circulation on the Ardor platform.

=== 3. Install Ardor ===
Go to [https://ardordocs.jelurida.com/Getting_started Ardordocs] or [https://www.jelurida.com/ardor/downloads Jelurida] website do download the latest version of Ardor.

=== 4. Handle the missing dependencies ===
* Run the '''''exportLibsMissingInArdor''''' task in this project:

./gradlew exportLibsMissingInArdor

* Copy the libraries from '''''contract/libs-exported'''''

[[File:LibsExportCopy.jpg|class=img-responsive|]]

to the '''''lib''''' directory inside the Ardor installation directory.

[[File:LibsExportPaste.jpg|class=img-responsive]]

=== 5. Configure the Ardor node for running the contract ===
Add the following configuration to the [https://ardordocs.jelurida.com/Faq#Node_configuration_using_the_nxt.properties '''nxt.properties''']file of the Ardor installation.

nxt.addOns=nxt.addons.ContractRunner
nxt.disableSecurityPolicy=true

'''Warning!'''
Allowing connections to the Ardor node from outside its local machine is a bad idea. The '''triggerContractByRequest''' API, which is used to execute [[#Commands_reference|commands to the peg contract]], is [https://ardordocs.jelurida.com/API#Admin_Password password protected]. So executing any command requires the caller to have the [https://ardordocs.jelurida.com/API#Admin_Password Ardor node '''adminPassword'''], which means that he can modify the Ardor node in many ways including getting DB access to it.

The recommended approach is to develop a small proxy backed which to run on the same server as the Ardor node and which
to expose only the [[#getUnwrapDepositAddress|getUnwrapDepositAddress]] and [[#processUnwrapsForAccount|processUnwrapsForAccount]] commands.

Additionally, with Infura all requests to the Ethereum API are counted against a quota. The [[#processUnwrapsForAccount|processUnwrapsForAccount]] command calls the Ethereum API even if there is no unwrap transfer to execute. So if using Infura, the backend must also implement some restriction on the calls to [[#processUnwrapsForAccount|processUnwrapsForAccount]].

=== 6. Create Contract Runner configuration ===
The configuration is a JSON file, located in '''contract/src/test/resources/test_contract_config.json'''. Rename it to '''AssetsErc1155Peg.json''' and open it.

===== 6.1. Secrets =====
Generate strong secrets for '''ethereumDepositAccountsSecret''', '''ethereumBlockedAccountSecret''' and the contract account, which will act as Ardor Blocked Account and will own all locked tokens which are in circulation on Ethereum side. Set '''ethereumDepositAccountsSecret''' and '''ethereumBlockedAccountSecret''' to the generated values.

===== 6.2. '''accountRS''' =====
Set in '''accountRS''' the [https://ardordocs.jelurida.com/RS_Address_Format address] of the Ardor Blocked Account. To get the address login with the generated Ardor passphrase.

===== 6.3. '''apiUrl''' =====
Set in '''apiUrl''' the URL of the HTTP API of your Ethereum full node. Other EVM-compatible networks like Polygon are also supported.

===== 6.4. '''chainId''' =====
Set in '''chainId''' the chain ID of the Ethereum network as required by [https://eips.ethereum.org/EIPS/eip-1155 ''ERC-1155'']. A list of the chain IDs of the popular EVN-compatible networks is available [https://chainlist.org here].

===== 6.5. '''ethLogsBlockRange''' =====
Set in '''ethLogsBlockRange''' the max size of the block range allowed by the Ethereum full node when calling ''eth_getLogs''. Value of 0 makes all ''eth_getLogs'' requests to be executed from the first to the latest block in the blockchain.

===== 6.6. '''ethLogsIterations''' =====
Set '''ethLogsIterations''' to more than 1 to execute the calls to eth_getLogs in a loop. Each call will cover a subsequent block range of '''ethLogsBlockRange'''. Use this in case the full node has an unacceptable limit on the block range. The downside is that ethLogsIterations requests will be made when getting the logs in order to check for pending unwrapping or already processed wrappings. Make sure that '''ethLogsBlockRange''' * '''ethLogsIterations''' * '''average_block_time''' is at least 5-6 hours to allow users to process their unwrapping deposits.

===== 6.7. Confirmations =====
Adjust '''ardorConfirmations''' and '''ethereumConfirmations''' - these are the number of blocks that the peg contract will wait before considering a transaction confirmed.

===== 6.8. Fast Wrapping =====
Fast wrapping is enabled if '''fastWrappingConfirmations''' is set to less than ardorConfirmations.

===== 6.8.1. '''fastWrappingMinDeadline''' =====
If Fast wrapping is enabled, set in '''fastWrappingMinDeadline''' the minimal transaction deadline required for the transaction to be eligible for fast wrapping.

===== 6.9. Ardor Fees =====
'''ardorInitialFeeOverpayPercent''' and '''ardorRetryFeeOverpayPercent''' are percentage with which to increase the Ardor transaction fee initially and each time a transaction expires, without being accepted in a block. The default transactions deadline is 15 min. '''ardorInitialFeeOverpayPercent''' is a string and may be negative, in which case the initial fee is below the automatically calculated by the node fee.

===== 6.10. '''ethereumRetryTimeout''' =====
Time in seconds to wait for Ethereum transaction to be accepted in a block before retrying with higher fee.

===== 6.11. Ethereum Fees =====
'''ethereumGasPriceInitialOverpay''' and '''ethereumGasPriceRetryOverpay''' are percentage with which to increase the Ethereum transaction fee initially and each time a transaction is not accepted before '''ethereumRetryTimeout'''. ethereumGasPriceInitialOverpay is string and may be negative in which case the starting gas price is below the one calculated by the Ethereum node

===== 6.12. '''contractAddress''' =====
Set in '''contractAddress''' the address of the contract which will manage the wrapped assets on Ethereum side. For example the contract address of OpenSea on Polygon Mumbai testnet is '''0x2953399124F0cBB46d2CbACD8A89cF0599974963'''

===== 6.13. Auto-minting =====
To enable the auto-minting of wrapping ''ERC-1155'' tokens, set '''autoMintErc1155''' to true. When auto-minting is enabled, the tokens on ethereum side are automatically minted when a wrapping is complete and burned when un-wrapping is complete. For this, the contract specified in '''contractAddress''' must implement the [https://gitlab.com/petko/asset-to-erc1155-bridge/-/blob/master/erc1155/src/main/solidity/IERC1155MintBurn.sol ''ERC1155MintBurn''] interface. Use the [[#deployEthContract|deployEthContract]] command before contractAddress is set to deploy a basic implementation of such auto-mintable contract provided in [https://gitlab.com/petko/asset-to-erc1155-bridge/-/blob/master/erc1155/src/main/solidity/ERC1155MintBurn.sol ''ERC1155MintBurn'']. Then set the ID of the deployed contract in contractAddress

===== 6.13.1 '''autoMintWhitelistedIssuers''' =====
If auto-minting is enabled, set in '''autoMintWhitelistedIssuers''' an array of Ardor account IDs specifying the asset issuers whose assets will be processed by '''AssetsErc1155Peg'''.

===== 6.14. '''assetIdToErc1155IdMap''' =====
If auto-minting is disabled, set in '''assetIdToErc1155IdMap''' a JSON object mapping between the known asset IDs on Ardor and the ''ERC-1155'' tokens IDs. The JSON keys must contain asset IDs as unsigned integer strings. The values must contain the corresponding ''ERC-1155'' token IDs as unsigned integer string, or a string with format '0x' followed by up to 64 hex chars (32 bytes in hex format).

''Example'':

[[File:JsonExample.jpg|class=img-responsive]]

=== 7. Start and configure the Contract Runner ===
Start Ardor, create or use an existing [https://ardordocs.jelurida.com/Asset_exchange Asset], but make sure that the asset decimals are 0 and the asset quantity does not exceed the amount of the minted ''ERC-1155'' tokens in circulation. Set the configuration built on [[#6._Create_Contract_Runner_configuration|step 6]]. See [https://ardordocs.jelurida.com/Lightweight_Contracts#How_to_configure_the_Contract_Runner How to configure the Contract Runner] and use the Node Processes UI in order to utilize the encryption supported by it.

If [[#6.13._Auto-minting|auto-minting]] is enabled, start Ardor with empty [[#6.12._contractAddress|contractAddress]], execute the [[#deployEthContract|deployEthContract]] command, set the result in [[#6.12._contractAddress|contractAddress]] and restart Ardor.

=== 8. Deploy the AssetsErc1155Peg contract ===
Before deploying, navigate to '''''contract/conf''''' and create '''nxt-deployContract.properties''' file, since the task reads the [https://ardordocs.jelurida.com/Lightweight_Contracts#Contract_Manager Contract Manager configuration] from it. Set at least '''contract.manager.secretPhrase''' property to the previously generated secret of the Ardor Blocked Account. The deployment can be executed remotely by setting the '''contract.manager.serverAddress''' property.

'''Warning!'''
Make sure the Ardor Blocked Account secret is secured - delete it from '''nxt-deployContract.properties''' or delete the
whole file. This file is used only by the deployContract task.

Deploy the contract by executing the deployContract gradle task:

./gradlew deployContract

=== 9. Get the peg addresses ===
This step can be skipped if [[#6.13._Auto-minting|auto-minting ('''autoMintErc1155''')]] is enabled.

With the Contract Runner started on the Ardor node, call the ''triggerContractByRequest'' API with command ''getPegAddresses'' and you'll get response like:

{
"ardorBlockedAccount": "ARDOR-J24K-QWD8-XHEX-36P7X",
"ethereumBlockedAccount": "0xd1a49a09d7d1be11108f2629859695aec32f3e2b",
"requestProcessingTime": 0
}

[[File:PegAddress.jpg|class=img-responsive]]

See the [[#Commands_reference|Commands Reference]] section for more details about the available commands.

=== 10. Transfer all minted ERC-1155 tokens to the Ethereum Blocked Account ===
This step can be skipped if [[#6.13._Auto-minting|auto-minting]] is enabled.

The Ethereum Blocked Account address is returned in [[#9._Get_the_peg_addresses|ethereumBlockedAccount]].

This way the peg contract is initialized in fully unwrapped state - all tokens are in circulation on Ardor side and can be wrapped into ''ERC-1155'' tokens. Alternatively if all Ardor assets are transferred to the [[#6.2._accountRS|ardorBlockedAccount]], and the ''ERC-1155'' tokens are released in circulation on Ethereum side, the contract will be in "fully wrapped" state.

=== 11. Token Metadata ===
If you are deploying your own contract (which is likely the case when [[#6.13._Auto-minting|auto-mint]] is enabled), it is a good idea to allow clients to get metadata about the wrapping tokens on Ethereum side. This must be done according to the [https://eips.ethereum.org/EIPS/eip-1155#metadata ''ERC-1155'' metadata] specification.

===== URI tutorial =====
The '''uri''' is specified when executing [[#deployEthContract|''deployEthContract'']].

For the purposes of the current document, IPFS will be used to host the metadata. Our goal is to be able to dynamically add new assets, without re-deploying the Ethereum contract. Therefore ''"ipfs://<CID>/"'' url scheme cannot be used here, since the CID of the folder/file changes with each edit. We need to use [https://docs.ipfs.io/concepts/ipns/ IPNS]. Unfortunately, by experimenting, we discovered that currently URLs with ''"ipns://"'' schemes are not supported by OpenSea, so our final solution is to use an IPFS gateway and set an URL with "https" schema as contract URI.

We aim that our URI looks like this (we'll use the ipfs.io gateway, this could be changed with other gateways):

https://ipfs.io/ipns/<ipfs_public_key>/{id}/metadata.json

To obtain the ''ipfs_public_key'', execute '''ipfs name publish <CID_of_the_root_directory>''' (nft folder in this example). Do this every time a change has happened in that directory, so the data can be published.

ipfs name publish QmabN9zQoLtYWCUMuGpJ9qUTc4yCSu1RmsxgqvLqDH44Xc

[[File:Uri tutorial1.jpg|class=img-responsive]]

[[File:Uri tutorial2.jpg|class=img-responsive]]

You will get a response:

Published to k51qzi5uqu5dgjvdga00na9szdfos2asdqzm0uz2452rq1l4462fkz8t5um3rz: /ipfs/QmabN9zQoLtYWCUMuGpJ9qUTc4yCSu1RmsxgqvLqDH44Xc

This is the public key - '''k51qzi5uqu5dgjvdga00na9szdfos2asdqzm0uz2452rq1l4462fkz8t5um3rz'''. So the final uri should look like this:

https://ipfs.io/ipns/k51qzi5uqu5dgjvdga00na9szdfos2asdqzm0uz2452rq1l4462fkz8t5um3rz/{id}/metadata.json

==== Metadata configuration example, when auto-mint is enabled ====

IPFS will be used to store the metadata.

Create a json file (''metadata.json'' for example) and populate it according to the [https://eips.ethereum.org/EIPS/eip-1155#metadata ''ERC-1155''] specification.

{
"name": "test mint",
"description": "test text test text test text",
"image": "ipfs://QmXRxXD3FUeXfd24x4LUZXjZ9rEdLSg2UCa2KHYoMdg4rp/mint.jpg",
"properties": {
"simple_property": "test value",
"rich_property": {
"name": "test-mint",
"value": "100",
"display_value": "100",
"class": "emphasis",
"css": {
"color": "#ffffff",
"font-weight": "bold",
"text-decoration": "underline"
}
},
"array_property": {
"name": "Name",
"value": [1,2,3,4],
"class": "emphasis"
}
}
}

Deploy [https://ardordocs.jelurida.com/How_to_deploy_IPFS_node IPFS node] and create a folder - ''nft'' for example. Create another folder inside and name it to the ID of the Ardor Asset in hexadecimal format - use [[#autoMintIdConvert|''autoMintIdConvert'']] command to convert the decimal asset id to hex. Put the ''metadata.json'' file in the hex-named directory.

[[File:Metadata-tutorial-new.jpg|class=img-responsive]]

Remove the [[#6.12._contractAddress|'''contractAddress''']] and enable the [[#6.13._Auto-minting|'''auto-minting''']] feature.

[[File:Auto-mint-tutorial1.jpg|class=img-responsive]]

Upload the contract in Ardor and execute the [[#deployEthContract|''deployEthContract'']] command.

[[File:DeployEthContract example.jpg|class=img-responsive]]

The uri from the [[#URI_tutorial|URI tutorial]] will be used in this example:
{"command":"deployEthContract","uri":"https://ipfs.io/ipns/k51qzi5uqu5dgjvdga00na9szdfos2asdqzm0uz2452rq1l4462fkz8t5um3rz/{id}/metadata.json"}

You will get ''ethContractAddress'':

{
"requestProcessingTime": 18846,
"ethContractAddress": "0xf32f1b4bf84dfa4a1d17722c7b502353bbc14eab"
}

Use it in the [[#6.12._contractAddress|contractAddress]] and don't forget to add [[#6.13.1_autoMintWhitelistedIssuers|autoMintWhitelistedIssuers]] Ardor accounts:

[[File:Auto-mint-tutorial2.jpg|class=img-responsive]]

Re-upload the contract to Ardor again and deploy it by executing:

./gradlew deployContract

Finally, transfer some Ardor assets to the [#6.2._accountRS|Ardor Blocked Account] and add the Ethereum address as message, where to receive the freshly minted tokens.

=== 12. Wrapping test ===
If [[#6.13._Auto-minting|auto-minting]] is '''enabled''', wrapping happens when any asset, issued by some of the accounts in the [[#6.13.1_autoMintWhitelistedIssuers|autoMintWhitelistedIssuers]] list is transferred to the [[#6.2._accountRS|Ardor Blocked Account]]. The result is a freshly minted ''ERC-1155'' token on Ethereum side with ID equal to the asset ID.

If [[#6.13._Auto-minting|auto-minting]] is '''disabled''', wrapping happens when an asset, which is supported according to the [[#6.14._assetIdToErc1155IdMap|'''assetIdToErc1155IdMap''']] configuration, is transferred to the [[#6.2._accountRS|Ardor Blocked Account].

The transaction must contain in its message the [https://en.wikipedia.org/wiki/Ethereum#Addresses Ethereum address] which to receive the wrapped tokens. It is recommended to use the [https://ardordocs.jelurida.com/Arbitrary_messages/en#Sending_an_encrypted_message Encrypted Message] functionality in Ardor in order to preserve privacy.

''Test Example:''

''Note: if [[#6.13._Auto-minting|auto-mint]] is '''disabled''', make sure that all minted ''ERC-1155'' tokens are transferred to the Ethereum Blocked Account.''

Issue an asset with some account. The asset must be with 0 decimals. Depending on whether auto-minting is enabled or not, add the issuer account to '''autoMintWhitelistedIssuers''' or map the asset id to an ERC-1155 token id in '''assetIdToErc1155IdMap'''. Then transfer some (or all) of the asset quantity to the [[#6.2._accountRS|Ardor Blocked Account]], adding a Message (encrypted is advised for privacy), containing the Ethereum account address, which to receive the wrapped tokens.

[[File:TransferAssetToABA.jpg|class=img-responsive]]

After the configured [[#6.7._Confirmations|'''ardorConfirmations''']] and [[#6.7._Confirmations|'''ethereumConfirmations''']] had passed, the Ethereum tokens should be transferred to the recipient Ethereum account.

==== Fast Wrapping ====
A [[#6.8._Fast_Wrapping|fast wrapping]] option is available in case the pegged tokens don't have significant economic value. If enabled, the wrapping transactions are confirmed after fewer blocks (configurable via [[#6.8._Fast_Wrapping|'''fastWrappingConfirmations''']]) if the following conditions are met:

* The transaction deadline is greater than [[#6.8.1._fastWrappingMinDeadline|'''fastWrappingMinDeadline''']]
* The transaction Economic Clustering (EC) block is more than [[#6.7._Confirmations|'''ardorConfirmations''']] blocks before the transaction height
* The transaction is not [https://ardordocs.jelurida.com/Phasing phased]
* The transaction is not referencing other transaction

These restrictions are meant to reduce the chances for a transaction to become invalid in case of spontaneous blockchain reorganization. An attacker with enough forging power can still invalidate such transaction and do a double spend. So the fast confirmation mode must be used only for low-value assets.

=== 13. Unwrapping test ===
Unwrapping is triggered by a call to [[#processUnwrapsForAccount|''processUnwrapsForAccount'']], but before this call the tokens to unwrap must be transferred to an UnwrapDepositAccount - an Ethereum account dedicated to and generated for the Ardor account which will receive the unwrapped assets.

To get the UnwrapDepositAccount address use the [[#getUnwrapDepositAddress|''getUnwrapDepositAddress'']] command.

''Example:''
Use [[#getUnwrapDepositAddress|''getUnwrapDepositAddress'']] command to get the '''depositAccount''' address of the account, where the wrapped ''ERC-1155'' tokens to be received.

{"command":"getUnwrapDepositAddress","ardorRecipientPublicKey":"85e2097c2365d5a33a872d465dfc8425dcc394147ab69988fb937be668266f59"}

{
"depositAddress": "0x13ebd674b0001dd8f6cfeaba94131034524fd03f",
"requestProcessingTime": 1
}

Transfer the wrapped ''ERC-1155'' tokens to the '''depositAccount''' address and make sure they are received.

Call [[#processUnwrapsForAccount|''processUnwrapsForAccount'']] for the Ardor account, where the wrapped tokens are transferred.

{"command":"processUnwrapsForAccount","ardorRecipientPublicKey":"85e2097c2365d5a33a872d465dfc8425dcc394147ab69988fb937be668266f59"}

{
"requestProcessingTime": 1397
"starts": 1
}

If started successfully, you will observe '''''"starts": 1''''' in the Response.

Navigate to Ardor Dashboard where you should see an ongoing Asset transfer transaction. Then open the Ethereum Blocked Account, where the unwrapped ERC-1155 tokens are received.

The ''ERC-1155'' tokens will be burned, if [[#6.13._Auto-minting|auto-mint]] is enabled.

== Commands reference ==
The '''AssetsErc1155Peg''' supports several commands through the '''triggerContractByRequest''' Ardor API.

In all cases the '''contractName''' parameter of that API must be set to '''AssetsErc1155Peg'''.

The rest of the parameters can be provided either as JSON object in the '''setupParams''' parameter, or as separate parameters.

A mandatory '''command''' parameter is used to distinguish the different operations supported by '''AssetsErc1155Peg'''. Each command has its own set of additional parameters.

''Example'':

[[File:ArdorAPI.jpg|class=img-responsive]]

==== The following sub-sections contain a reference of the supported commands: ====
<br>
==== ''getPegAddresses'' ====

Returns the addresses of Ardor Blocked Account and Ethereum Blocked Account.

===== No parameters required =====
<br>

===== Response =====
{
"ardorBlockedAccount": "ARDOR-...", // The address of the Ardor Blocked Account
"ethereumBlockedAccount": "0x..."// The address of the Ethereum Blocked Account
}

==== ''getUnwrapDepositAddress'' ====

Returns the address for depositing ''ERC-1155'' tokens in order to unwrap them back to Ardor. This address is specific for
each Ardor account.

===== Parameters =====

* '''ardorRecipientPublicKey''' The public key of the Ardor account for which an address for unwrapping is generated

===== Response =====
{
"depositAddress": "0x..." //An Ethereum address
}

==== ''processUnwrapsForAccount'' ====

# Calculate the UnwrapDepositAccount similarly to getUnwrapDepositAddress
# Gets all transfers to the UnwrapDepositAccount in the last 100000 blocks
# Filter out any transfers for which the unwrapping is currently being processed or is completed
# Start a background unwrap task for any transfers left

===== Parameters =====

* '''ardorRecipientPublicKey''' The public key of the Ardor account to which to send the unwrapped tokens

===== Response =====
A JSON object with the number of tasks started or filtered out transfers by filter category. Fields with value 0 are
not returned
{
"starts": 0123456789, //Number of tasks started by the current request
"skippedAlreadyPending": 0123456789, //Transfers skipped during the request because there is already a background task processing them
"skippedCompleted": 0123456789, //Transfers which were already completed and there is an outgoing Ardor transaction for them
"unknownTokens": 0123456789 // Transfers of tokens not in the assetIdToErc1155IdMap configuration
}

==== ''processWrapsAtHeight'' ====

Utility command to manually process the wrapping at some height. There is no check about whether the transactions at this height were already processed, so special care must be taken to not process same asset transfers twice.

This command returns before the transaction was confirmed on Ethereum side. Use the getWrappingLog command to poll the final result of the wrapping.

===== Parameters =====

* '''height''' Height of the ardor blockchain for which to process the wrappings

===== Response =====
{
"transactionsLog": [ //An array of objects
{
"fullHash": "...", //fullHash of the Ardor transaction which transfers assets to the Ardor Blocked Account and triggered the wrapping
"error": "...", //Error message in case of error before the transfer was initiated on Ethereum side
}
],
"requestProcessingTime": 4
}

==== ''getWrappingLog'' ====

Returns a log of all wrappings processed during the current execution of the contract.

===== No parameters required =====
<br>

===== Response =====
{
"log": [
{
"fullHash": "...", //fullHash of the Ardor transaction which transfers assets to the Ardor Blocked Account and triggered the wrapping
"error": "...", //In case the wrap failed
"success": "0x..." //Transaction ID on Ethereum side
}
],
"requestProcessingTime": 2
}

==== ''secretToEthPrivateKey'' ====

Utility for computing the ethereum private key from secret string. The private key can then be imported in e.g. Metamask.

To get the private key of an unwrapping deposit account, concatenate '''ethereumDepositAccountsSecret''' from the peg configuration and the ardor public key of the account.

For example if '''ethereumDepositAccountsSecret''' is

harmony repeat ourselves woman empty outside liquid truth journey shiver mention curl

and the public key of the account is

0507916d19b81d9f714c4f9eaf7ad4742b013c106c34cb9d2fb663d5e101df75

Then the '''secret''' parameter should be

harmony repeat ourselves woman empty outside liquid truth journey shiver mention curl0507916d19b81d9f714c4f9eaf7ad4742b013c106c34cb9d2fb663d5e101df75

===== Parameters =====

* secret A string

===== Response =====
{
"privateKeyHex": "0x...", //Private key in hex format. This can be used with Metamask
"privateKeyNumeric": "..." //Same private key as decimal string
}

==== ''autoMintIdConvert'' ====
Utility for converting between the decimal asset IDs used in Ardor to hexadecimal format, primarily used in Ethereum. Even though the IDs of the [[#6._Create_Contract_Runner_configuration|auto-minted]] Ethereum tokens which wrap the Ardor assets are equal to the Ardor asset ID, in some cases, for example when [https://eips.ethereum.org/EIPS/eip-1155#metadata ''ERC-1155'' metadata] is handled, the ID is needed in hexadecimal format. This command simply converts from decimal to hexadecimal or vice versa.

===== Parameters =====

* '''assetId''' ID in decimal format as used in Ardor
OR
* '''tokenId''' ID in hexadecimal format as appearing in Ethereum. The "0x" prefix is optional

===== Response =====
If '''assetId''' is provided:

{

"tokenIdHex": "0x...", //hex string
"erc1155MetadataId": "0000000000000000000000000000000000000000000000000123456789abcdef...", //0-padded hex string as expected by the
metadata specification
"requestProcessingTime": 1
}

Or if '''tokenId''' is provided:

{
"assetId": "...", //Ardor asset ID as unsigned decimal string
"requestProcessingTime": 1
}

==== ''deployEthContract'' ====
Deploys a contract specifically developed to support auto-minting of ''ERC-1155'' tokens for wrapping Ardor assets.

To prevent abuse or errors, this API is available only if the [[#6._Create_Contract_Runner_configuration|contractAddress]] is empty.

===== Parameters =====

*'''uri''' The URI which will be returned by the contract to clients for getting tokens metadata. See the [https://eips.ethereum.org/EIPS/eip-1155#metadata ''ERC-1155'' metadata] specification.

Note that the parameter is '''uri''', not '''url''', please make sure it is typed correctly.

===== Response =====

{
"ethContractAddress":"0x54c8d419a5b9d2d6ff68ff826258456ee37e214b",
"requestProcessingTime":16743
}

</translate>

File:Metadata-tutorial-new.jpg

2022-03-10T14:25:12Z

Stefan:

Metadata-tutorial-new

File:Metadata-tutorial1 new.jpg

2022-03-10T14:22:51Z

Stefan:

Metadata-tutorial1_new

File:Auto-mint-tutorial2.jpg

2022-03-07T19:52:46Z

Stefan:

Auto-mint-tutorial2

File:DeployEthContract example1.jpg

2022-03-07T19:50:17Z

Stefan:

DeployEthContract example1

File:DeployEthContract example.jpg

2022-03-07T19:38:45Z

Stefan:

DeployEthContract example

File:Uri tutorial2.jpg

2022-03-07T19:21:54Z

Stefan:

Uri tutorial2

File:Uri tutorial1.jpg

2022-03-07T19:21:15Z

Stefan:

Uri tutorial1

File:Token-metadata-tutorial2.jpg

2022-03-02T12:15:58Z

Stefan:

Token-metadata-tutorial2

File:Metadata-tutorial1.jpg

2022-03-02T12:07:15Z

Stefan:

Metadata-tutorial1

File:Auto-mint-tutorial1.jpg

2022-03-02T09:40:46Z

Stefan:

Auto-mint-tutorial1

File:ProcessUnwrapsForAccount.jpg

2021-10-20T20:32:59Z

Stefan:

ProcessUnwrapsForAccount

File:GetUnwrapDepositAddress.jpg

2021-10-20T20:25:10Z

Stefan:

GetUnwrapDepositAddress

File:TransferAssetToABA.jpg

2021-10-20T18:45:38Z

Stefan:

TransferAssetToABA

File:MetamaskImportAccount.jpg

2021-10-20T18:32:24Z

Stefan:

MetamaskImportAccount

File:SecretToEthPrivateKey.jpg

2021-10-20T18:28:08Z

Stefan:

SecretToEthPrivateKey

File:ArdorAPI.jpg

2021-10-20T18:23:20Z

Stefan:

ArdorAPI

File:PegAddress.jpg

2021-10-20T13:19:04Z

Stefan:

PegAddress

File:JsonExample.jpg

2021-10-20T12:40:09Z

Stefan:

JsonExample

File:NxtPropertiesConf.jpg

2021-10-20T12:21:20Z

Stefan:

NxtPropertiesConf

File:LibsExportPaste.jpg

2021-10-20T12:15:06Z

Stefan:

LibsExportPaste

File:LibsExportCopy.jpg

2021-10-20T12:14:51Z

Stefan:

LibsExportCopy

File:ExportLibs.jpg

2021-10-20T12:08:35Z

Stefan:

ExportLibs

File:IntelliJ Plugin Installation2 2.jpg

2021-05-14T14:08:44Z

Stefan:

IntelliJ Plugin Installation

File:IntelliJ Plugin Installation2 1.jpg

2021-05-14T08:06:25Z

Stefan:

IntelliJ Plugin Installation

File:IntelliJ Plugin Installation2.jpg

2021-05-13T08:10:25Z

Stefan:

IntelliJ Plugin Installation

File:IntelliJ Plugin Installation1.jpg

2021-05-13T08:09:33Z

Stefan:

IntelliJ Plugin Installation

How to deploy IPFS node

2021-04-20T08:47:57Z

Stefan:

<languages />
<translate>
{{#seo:
|title=How to install and deploy IPFS node
|titlemode=replace
|keywords=IPFS, IPFS node, IPFS documentation, blockchain, proof of stake, ardor, ignis, jelurida, development, ardor wiki, wiki, tutorials, advanced tutorials
|description=Detailed explanation step by step for deploying an IPFS node
}}
[[Category:Advanced_guides]]
__TOC__
== Introduction ==
The InterPlanetary File System (IPFS) is a protocol and peer-to-peer network for storing and sharing data in a distributed file system. IPFS uses content-addressing to uniquely identify each file in a global namespace connecting all computing devices.

IPFS allows users to not only receive but host content, in a similar manner to BitTorrent. As opposed to a centrally located server, IPFS is built around a decentralized system of user-operators who hold a portion of the overall data, creating a resilient system of file storage and sharing. Any user in the network can serve a file by its content address, and other peers in the network can find and request that content from any node who has it using a distributed hash table (DHT).

For more detailed info, you can visit the IPFS [https://docs.ipfs.io/concepts/what-is-ipfs/ webpage].

== Installation ==
IPFS can be installed and deployed via several methods:

1. IPFS [https://docs.ipfs.io/install/ipfs-desktop/ Desktop]

2. IPFS [https://docs.ipfs.io/install/ipfs-companion/#install Companion], a browser extension that simplifies access to IPFS resources and adds support for the IPFS protocol.

3. IPFS [https://docs.ipfs.io/install/command-line/ Command-line]

The installations are explained in details in the IPFS webpage, please refer to the links above.

== Deployment ==
If you decided to use IPFS Desktop or Companion, then the deployment is done automatically for you, however, the command-line method requires a bit more. Please visit the [https://docs.ipfs.io/how-to/command-line-quick-start/ docs.ipfs.io page] for detailed instructions.

===Deploying more nodes===
You don't need a second machine/ip in order to deploy another IPFS node. Yes, that's right, you can deploy as many nodes as you like on one machine, but there are some configurations, which have to be modified.

Let's say that you already deployed a node, it is running and visible to other nodes on the IPFS network. Now if we open another terminal window and try to start another '''''ipfs daemon''''', we will get this error:

[[File:More nodes4.jpg|class=img-responsive|]]

This basically means that we cannot run more than one node from the ''ipfs'' folder, but if we want, we should initialize new node in another folder. Let's open open another terminal window and run the command '''''IPFS_PATH=~/.ipfs2 ipfs init'''''. As you can see, we changed the ''default path'' of the ipfs and now we created a new node at ~/.ipfs2:

[[File:More nodes5.jpg|class=img-responsive|]]

[[File:More nodes1.jpg|class=img-responsive|]]

The name ''ipfs2'' can be whatever you like, not necessary to be that specific one, it's just the directory of the second node.

Now let's open the ''ipfs2'' folder, inside there should be a config file:

[[File:More nodes2.jpg|class=img-responsive|]]

Open the file, it's the configuration of the node - ''Peer ID, Api, Adresses, Swarm, etc.''. We are looking for the ''Adresses'' config, should be on line 39:

[[File:More nodes3 1.jpg|class=img-responsive|]]

The modifications, which have to be made, in order for the second node to run, are to change the Ports of the '''''Swarm, API and Gateway''''' configs, so they can be different from the default ones (4001, 5001, 8080):

[[File:More nodes6.jpg|class=img-responsive|]]

As you can see, we changed the default Ports - 4001 to 4002, 5001 to 5002 and 8080 to 8081. Of course, you can choose other numbers, as long as they are different from de defaults and not interfere with other Ports.

Now let's open another terminal window and try to take the node online. The important thing to be remembered here is that the PATH to the second node should always be specified, when trying to run commands on it -
'''''IPFS_PATH=~/.ipfs2 [command]''''':

[[File:More nodes7.jpg|class=img-responsive|]]

And there we go, our second node is online, now open another terminal window and run '''''ipfs swarm peers''''' command (remember to specify the PATH):

[[File:More nodes8.jpg|class=img-responsive|]]

===File transfer between nodes===
With our two nodes up and running, let's do a simple test and try to transfer a file between them. Of course we can use the command-line commands, but let's see how the Web UI can handle this. Open your browser and make two tabs, the first with '''''localhost:5001/webui''''' URL, and the second with '''''localhost:5002/webui''''' (or your port, if it's different from 5002).

Choose the node, where you want to upload a file, open the '''''FILES''''' menu on the left and on the right there should be '''''Import''''' button. Click on it, choose '''''File''''' from the dropdown menu and then select the file, which you want to upload. In the image below, we chose ''nxt_db.txt'' file.

[[File:Test nodes1 2.jpg|class=img-responsive|center|]]

Now we have to copy the CID of the uploaded file, simply right-click on it and select '''''Copy CID'''''.

[[File:Test nodes2.jpg|class=img-responsive|]]

Switch to the other tab, where the Web UI of the other node is running. Again, open '''''FILES''''' menu on the right and click the '''''Import''''' button. Now choose '''''From IPFS''''' option, a pop-up menu will appear, where you should paste the copied CID and click '''''Import'''''.

[[File:Test nodes3.jpg|class=img-responsive|center|]]

Et voilà, the file was transferred successfully. If you don't see it immediately, just refresh the browser page.

[[File:Test nodes4.jpg|class=img-responsive|center|]]

== Troubleshooting ==

=== NAT Configuration ===
A common issue for new users running IPFS, especially on home networks, is that their IPFS node is sitting behind a NAT (network address translation). It's common for people who run an IPFS node on their home network to have very long wait times or a high rate of request failure. This is because the rest of the nodes on the IPFS network have difficulty connecting to them through their NAT.

Please refer to the tutorial in [https://docs.ipfs.io/how-to/nat-configuration/ https://docs.ipfs.io] about how to configure NAT.

=== Virtual Machine ===
If you are running your node/s through a virtual machine and you experience problems with your node/s connection, you might need to change the '''Network''' of the Virtual machine to '''''Bridged''''' (example on Oracle VirtualBox below:

[[File:Vm network.jpg|class=img-responsive|]]

</translate>

File:Api address.jpg

2021-04-16T08:44:38Z

Stefan:

Configuring default IPFS API address

File:Max pin size.jpg

2021-04-16T08:19:15Z

Stefan:

Configuring IPFS contract parameters

File:Ipfs pin1.jpg

2021-04-15T16:45:12Z

Stefan:

ipfs pin1

File:Ipfs pin.jpg

2021-04-15T16:44:54Z

Stefan:

ipfs pin

File:Send message CID.jpg

2021-04-15T16:26:17Z

Stefan:

Connecting Ardor node to IPFS node

File:Uploaded ipfs contract1.jpg

2021-04-15T16:21:26Z

Stefan:

Connecting Ardor node to IPFS node

File:Ipfs uploaded file.jpg

2021-04-15T13:58:27Z

Stefan:

Connecting Ardor node to IPFS node

File:Uploaded ipfs contract.jpg

2021-04-15T13:50:40Z

Stefan:

Uploading ipfs contract

File:Vm network.jpg

2021-04-14T13:22:15Z

Stefan:

IPFS network with VM

File:Test nodes4.jpg

2021-04-14T10:30:00Z

Stefan:

Clarification images testing IPFS nodes

File:Test nodes3.jpg

2021-04-14T10:27:04Z

Stefan:

Clarification images testing IPFS nodes

File:Test nodes1 2.jpg

2021-04-14T10:19:28Z

Stefan:

Clarification images testing IPFS nodes

File:Test nodes1 1.jpg

2021-04-14T10:16:00Z

Stefan:

Clarification images testing IPFS nodes

File:Test nodes2.jpg

2021-04-14T10:13:17Z

Stefan:

Clarification images testing IPFS nodes

File:Test nodes1.jpg

2021-04-14T10:10:27Z

Stefan:

Clarification images testing IPFS nodes

File:More nodes8.jpg

2021-04-14T09:59:10Z

Stefan: