Skip to content

Commit

Permalink
Removed docs directory, moved all JS into examples directory and edit…
Browse files Browse the repository at this point in the history
…ed README
  • Loading branch information
Watchmaker committed Oct 16, 2024
1 parent 6de223f commit 1e64a5b
Show file tree
Hide file tree
Showing 16 changed files with 17 additions and 408 deletions.
74 changes: 13 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,23 @@
# Subtensor EVM Integration Kit
<div align="center">

# **EVM on Subtensor** <!-- omit in toc -->
[![Discord Chat](https://img.shields.io/discord/308323056592486420.svg)](https://discord.gg/bittensor)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Setting up network
---

The developer setup can be done in two ways. It includes settings up network URLs, account private keys, and initial balances needed for this guide (and further development).
## Internet-scale Neural Networks <!-- omit in toc -->

1. [Using EVM Subtensor TestNet](docs/running-on-testnet.md)
2. [Local setup](docs/running-locally.md) (requires Rust and tools to be installed)
[Discord](https://discord.gg/qasY3HA9F9)[Subtensor](https://github.com/opentensor/subtensor)[Research](https://bittensor.com/whitepaper)

[Testnet Faucet](https://evm-testnet.dev.opentensor.ai/faucet)
</div>

## Balance transfer from Substrate (ss58) to EVM (H160) address
This repo contains tutorials and scripts for working with EVM on subtensor. Using this EVM feature you can:

This step is not required if you're working with Subtensor Testnet. It is only essential for starting development with local setup because it transfers some initial TAO balance from the Substrate side to EVM side.
- Deploy and interact with any Ethereum smart contract, without any need to change it, on the subtensor blockchain.
- Access all the standard Ethereum JSON-RPC methods from this EVM compatibility layer on Bittensor.

Execute:
**NOTE**: The EVM on subtensor allows the subtensor blockchain to execute Ethereum-compatible smart contracts. Note that all operations performed by this new subtensor EVM feature are executed solely on the subtensor blockchain, not on the Ethereum blockchain.

```bash
yarn install
node transfer.js
```
**Full documenatation**: See [EVM Tutorials](http://docs.bittensor.com/evm-tutorials/) section on the Bittensor developer documentation site.

## Balance transfer from EVM address back to Substrate balances - method 1: Using evm::withdraw

1. Copy your ss58 address (Example: 5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty). You need to have the private key for this address setup in Polkadot JS extension.
2. Paste it into `ss58Address` in main function in withdraw-address.js script
3. Execute:

```bash
node withdraw-address.js
```

4. Copy the "Ethereum mirror:" output address
5. Transfer the amount to this address that you wish to transfer using Metamask (make sure to clear activity tab data if you restarted the network previously: Settings - Advanced - Clear activity tab data)
6. Make sure your destination address is funded to run a transaction
7. Open Extrisics tab in Apps UI: https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9946#/extrinsics
8. Select `evm` pallet and `withdraw` extrinsic
9. Paste the "Ethereum mirror" output address into address field
10. Put the amount you are transferring into amount field. Note that Metamask balances are by 10^9 lower than Polkadot Apps UI balances because Metamask will not respect 10^9 decimals for native currency before we have a corresponding PR to https://github.com/ethereum-lists merged.
11. Submit transaction

## Balance transfer from EVM address back to Substrate balances - method 2: Using a SubtensorBalanceTransfer precompile

This step will transfer 1 TAO to your ss58 address configured with seed phrase in config.js as `subSeed`.

Execute:

```bash
node withdraw.js
```

Nonetheless, the destination address can be changed to any ss58 address (the private key/seed is not required for it in this step). Look for these lines in `withdraw.js` file:

```javascript
// Destination address can be replaced with any ss58 address here:
const destinationAddress = account.address;
// const destinationAddress = "5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty";
```

## Further examples

- [Hardhat configuration](docs/hardhat-config.md)
- [Plain vanilla balance transfer (in JS)](docs/plain-vanilla-balance-transfer.md)
- [Deploying and interacting with ERC-20 token](https://github.com/gztensor/subtensor-erc20)
- [Interaction with staking precompile](docs/staking-precompile.md)
- [Verification of Ed25519 signature with a precompile](docs/ed25519verify-precompile.md)

## Q&A

[Q&A](docs/qna.md)
24 changes: 0 additions & 24 deletions docs/ed25519verify-precompile.md

This file was deleted.

28 changes: 0 additions & 28 deletions docs/hardhat-config.md

This file was deleted.

32 changes: 0 additions & 32 deletions docs/plain-vanilla-balance-transfer.md

This file was deleted.

83 changes: 0 additions & 83 deletions docs/qna.md

This file was deleted.

50 changes: 0 additions & 50 deletions docs/running-locally.md

This file was deleted.

39 changes: 0 additions & 39 deletions docs/running-on-testnet.md

This file was deleted.

Loading

0 comments on commit 1e64a5b

Please sign in to comment.