Coder Social home page Coder Social logo

axelarnetwork / axelar-docs Goto Github PK

View Code? Open in Web Editor NEW
52.0 52.0 113.0 38.64 MB

Resources & Documentation for Axelar Network

Home Page: https://docs.axelar.dev

JavaScript 5.76% Solidity 1.38% MDX 83.75% TypeScript 3.41% Astro 3.54% SCSS 1.69% CSS 0.47%

axelar-docs's People

Contributors

aditya-manit avatar benjamin852 avatar blockchainguyy avatar canhtrinh avatar cgorenflo avatar dependabot[bot] avatar duccas avatar errorist79 avatar ffe9f8 avatar foivos avatar ggutoski avatar haiyizxx avatar ilyalukyanov avatar jp-imx avatar kalidax avatar keefertaylor avatar milapsheth avatar mustermeiszer avatar npty avatar nrsirapop avatar olanetsoft avatar pavelmoneyin avatar pjenviri avatar qubelabsio avatar riceandmeet avatar shivlim avatar stephenfluin avatar talalashraf avatar vladwulf avatar windforcer avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

axelar-docs's Issues

Avalanche

  • Avalanche - to properly run of the Avalanche node we have added manually the following line to the file: /home/avax/.avalanche go/configs/node.json

"network-id": "fuji"

without it the node is not running, so the final version of the file looks like this:
{ "public-ip": "95.217.236.137", "http-host": "", "network-id": "fuji" }

Please update the documentation

bring back some of the styling from the previous docs website

  • for e.g. font style,
  • links
  • crowded copy button,
  • mainnet/testnet switching,
  • syntax highlighting,
  • underline below the sections looks weird,
  • notes/warning symbols are not as prominent anymore).
  • Resources should have a button in the nav bar too (seems out of place compared to developers/node operators etc.)
  • the fully expanded table of contents on the left feels like an info dump

CC @milapsheth

Axelar GMP Account address is incorrect

In Developers > General MEssage Passing > Cosmos GMP > Messages from Native Cosmos: https://docs.axelar.dev/dev/general-message-passing/cosmos-gmp#messages-from-native-cosmos

Axelar GMP Account address is documented as axelar1dv4u5k73pzqrxlzujxg3qp8kvc3pje7jtdvu72npnt5zhq05ejcsn5qme5s

However, the actual address is axelar1dv4u5k73pzqrxlzujxg3qp8kvc3pje7jtdvu72npnt5zhq05ejcsn5qme5 (no s).

see this: https://github.com/axelarnetwork/evm-cosmos-gmp-sample/blob/90f23594c9ed7c027209e0600c6623a81f2d86ac/native-integration/README.md?plain=1#L4

Fix incoming 404 errors

Here are the top 404 errors from April 13 - May 10

/dev/general-message-passing/reference/mainnet-chain-names
/dev/monitor-recover/recovery
/dev/monitor-recover/monitoring
/dev/general-message-passing/axelarjs-sdk/tx-status-query-recovery
/general-message-passing/overview
/axelar-vm
/cli-docs/v0_27_0/axelard_keys_migrate <- we should think about how we want to redirect all old API docs...
/dev/gmp

Broken links in pay-gas page

https://docs.axelar.dev/dev/general-message-passing/gas-services/pay-gas#alternative-gas-payment-methods-for-callcontractwithtoken

In the section:

**payGasForContractCallWithToken**

This method receives any tokens for the relayer fee. 
The paid gas for this method must be in tokens Axelar supports. See the list of supported assets: 
[Mainnet](https://docs.axelar.dev/dev/general-message-passing/reference/mainnet-contract-addresses) | 
[Testnet](https://docs.axelar.dev/dev/general-message-passing/reference/testnet-contract-addresses).

Mainnet and Testnet links are broken

Feedback for “Mainnet | Axelar Network”

How can I get some data that allows to know which tokens cannot be received on which chains. As an example, we cannot send axlWMATIC tokens from the Axeler chain to the Ethereum chain. Is there an API provided by Axelar?

hydrate the search box after lazy loading

If the user entered any input quickly after clicking, but before the real box has loaded, make sure the text is saved and then loaded into the new form.

Also make it lazy load onchange

Get i18n working with redirects in production

There seems to be a bug in next.js that causes redirects to break if i18n is also used, but only in production (not localhost).

Example: this commit fixes redirects, but only on local host: e3d4916
In production deployment https://axelar-docs-rg9732fgz-axelar-network.vercel.app/ we see the following broken redirects:

  • releases/mainnet -> resources/mainnet.en-US
  • resources/mainnet-releases -> 404 error

The only workaround I found is to remove i18n. See different fix attempts in #4 and related next.js issues:
vercel/next.js#28921
vercel/next.js#18795
vercel/next.js#18349

Feedback for “Get a deposit address”

I want to send native asset and get wrapped asset on destination chain, like here https://docs.axelar.dev/dev/axelarjs-sdk/token-transfer-dep-addr#3-send-native-tokens-from-a-evm-chain.
Same exact example like in docs: I want to send AVAX on Avalanche and receive the equivalent ERC-20 version on Polygon. And I'm doing this on testnet.

My question is what should be in asset. When I'm sending some ERC-20 tokens the asset should be denom, e.g. axlUSDC 👉 uausdc .
In the example from your docs when sending native AVAX the asset is avax. Where does it come from? What is this value? What about other chains?

In Constant Address Deployer guide add note about msg.sender

As I mentioned in axelarnetwork/interchain-token-service#100 (comment) , when using a factory (e.g. Constant Address Deployer) to deploy a contract, msg.sender may be the factory's (or a temporary proxy's) address instead of the address of the account doing the deployment.

So there should be an important note about this in the documentation.

The best solution is to pass in the address to the constructor and use that instead of using msg.sender.

So for example this code:

    constructor() ERC20("MyToken", "MTK") {
        _mint(msg.sender, 1000000000 * 10 ** decimals());
        _grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
    }

should be changed to:

    constructor(address adminAddress) ERC20("MyToken", "MTK") {
        _mint(adminAddress, 1000000000 * 10 ** decimals());
        _grantRole(DEFAULT_ADMIN_ROLE, adminAddress);
    }

Styling of link on https://docs.axelar.dev/bug-bounty is wrong

Solve this both individually on this page, and fix it long term globally with code like this:

document.addEventListener("DOMContentLoaded", () => {
  const links = document.links
  for (let i = 0, linksLength = links.length; i < linksLength; i++) {
    if (!links[i].href.startsWith("javascript:")) {
      if (links[i].hostname !== window.location.hostname) {
        links[i].target = "_blank"
        links[i].relList.add("noopener")
      }
    }
  }
})

Golang

  • Golang
    The Golang tool is outdated also:

To install the new version we did the following:
wget https://golang.org/dl/go1.18.linux-amd64.tar.gz
sudo tar -C /usr/local -xzf go1.18.linux-amd64.tar.gz

export GOROOT=/usr/local/go
export GOPATH=$HOME/go
export GO111MODULE=on
export PATH=$PATH:/usr/local/go/bin:$HOME/go/bin
EOF```

source ~/.profile
go version

Polygon

  • Polygon - we have noticed that outdated versions bor and heimdall are used, so we have updated them also

Also we have set the following infura URL in the: ~/.heimdalld/config/heimdall-config.toml file:

eth_rpc_url = wss://goerli.infura.io/ws/v3/fcf0xxxxxxxxxxxxx

Maybe we need to describe this process in the documentation in more detail because it is not obvious to regular users?

Migrate to a new documentation infrastructure

Preview here: https://axelar-documentation.vercel.app/resources/mainnet

Goals:

  • Customizability of template
  • Arbitrary JS Execution
  • Algolia Search
  • Faster / More Reliable builds

Bugs

  • Keplr Add to wallet buttons
  • CSS on resources page
  • Search priority for non-CLI docs
  • CLI docs navigation
  • Remove markdown from search index
  • Add SEO redirects

Steps:

  • Migrate markdown files
  • Migrate React Components
    • could not find react-redux context value; please ensure the component is wrapped in a <Provider>
  • Match Styling
  • Ensure SEO
  • Add Algolia
    • Index auto-generation
    • Index auto-upload
    • Search Results UX
  • Automatically styled code previews with copy button
  • noreferrer noopener
  • Dynamic Algolia Re-ranking

Improve ITS docs page

Current documentation is not easy to read and needs to be structured based on the most common situations.

  • User does not have any tokens registered on any chains -> use ITS off the shelf
  • User has token registered on one chain -> use ITS off the shelf
  • User has a token registered on two more chains -> requires token manager
  • Bespoke customizations, e.g., needing attestation service -> Reach out to the team for tailored advice

Error: panic: runtime error: invalid memory address or nil pointer dereference in logs after quick sync

2023-01-23T05:24:25Z INF adding 5 seeds from seeds.toml
2023-01-23T05:27:08Z INF starting node with ABCI Tendermint in-process
2023-01-23T05:27:09Z INF service start impl=multiAppConn module=proxy msg={}
2023-01-23T05:27:09Z INF service start connection=query impl=localClient module=abci-client msg={}
2023-01-23T05:27:09Z INF service start connection=snapshot impl=localClient module=abci-client msg={}
2023-01-23T05:27:09Z INF service start connection=mempool impl=localClient module=abci-client msg={}
2023-01-23T05:27:09Z INF service start connection=consensus impl=localClient module=abci-client msg={}
2023-01-23T05:27:09Z INF service start impl=EventBus module=events msg={}
2023-01-23T05:27:09Z INF service start impl=PubSub module=pubsub msg={}
2023-01-23T05:27:48Z INF service start impl=IndexerService module=txindex msg={}
2023-01-23T05:27:48Z INF ABCI Handshake App Info hash="\x05v��\uf1ab�I�\x12���(8����\x1a:\n�\x1f\x13��1�L{" height=4739453 module=consensus protocol-version=0 software-version=0.29.1
2023-01-23T05:27:48Z INF ABCI Replay Blocks appHeight=4739453 module=consensus stateHeight=4739453 storeHeight=4739454
2023-01-23T05:27:48Z INF Replay last block using real app module=consensus
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x0 pc=0x1545c8d]

goroutine 1 [running]:
github.com/cosmos/cosmos-sdk/x/upgrade.BeginBlocker({{0x7ffc8dfe5e23, 0x25}, 0xc006fe5a10, {0x2e26728, 0xc0042482c0}, {0x2e4ac58, 0xc0042322e0}, 0xc004247050, {0x2e1fc00, 0xc000f00000}, ...}, ...)
/home/runner/go/pkg/mod/github.com/axelarnetwork/[email protected]/x/upgrade/abci.go:38 +0x100d
github.com/cosmos/cosmos-sdk/x/upgrade.AppModule.BeginBlock(...)
/home/runner/go/pkg/mod/github.com/axelarnetwork/[email protected]/x/upgrade/module.go:130
github.com/cosmos/cosmos-sdk/types/module.(*Manager).BeginBlock(, {{0x2e3d5c0, 0xc0001b6000}, {0x2e4c940, 0xc03da290c0}, {{0xb, 0x0}, {0xc0e262a6c0, 0xd}, 0x48517e, ...}, ...}, ...)
/home/runner/go/pkg/mod/github.com/axelarnetwork/[email protected]/types/module/module.go:491 +0x3bb
github.com/axelarnetwork/axelar-core/app.(*AxelarApp).BeginBlocker(
, {{0x2e3d5c0, 0xc0001b6000}, {0x2e4c940, 0xc03da290c0}, {{0xb, 0x0}, {0xc0e262a6c0, 0xd}, 0x48517e, ...}, ...}, ...)
/home/runner/work/axelar-core/axelar-core/app/app.go:750 +0x85
github.com/cosmos/cosmos-sdk/baseapp.(*BaseApp).BeginBlock(, {{0xc04de91fe0, 0x20, 0x20}, {{0xb, 0x0}, {0xc0e262a6c0, 0xd}, 0x48517e, {0x9cdd9a4, ...}, ...}, ...})
/home/runner/go/pkg/mod/github.com/axelarnetwork/[email protected]/baseapp/abci.go:177 +0x97c
github.com/tendermint/tendermint/abci/client.(*localClient).BeginBlockSync(
, {{0xc04de91fe0, 0x20, 0x20}, {{0xb, 0x0}, {0xc0e262a6c0, 0xd}, 0x48517e, {0x9cdd9a4, ...}, ...}, ...})
/home/runner/go/pkg/mod/github.com/tendermint/[email protected]/abci/client/local_client.go:280 +0x118
github.com/tendermint/tendermint/proxy.(*appConnConsensus).BeginBlockSync(, {{0xc04de91fe0, 0x20, 0x20}, {{0xb, 0x0}, {0xc0e262a6c0, 0xd}, 0x48517e, {0x9cdd9a4, ...}, ...}, ...})
/home/runner/go/pkg/mod/github.com/tendermint/[email protected]/proxy/app_conn.go:81 +0x55
github.com/tendermint/tendermint/state.execBlockOnProxyApp({0x2e3e698?, 0xc08ee90120}, {0x2e445b8, 0xc04dbd9250}, 0xc000eb61e0, {0x2e4bfc8, 0xc01f384498}, 0x48517d?)
/home/runner/go/pkg/mod/github.com/tendermint/[email protected]/state/execution.go:307 +0x3dd
github.com/tendermint/tendermint/state.(*BlockExecutor).ApplyBlock(
, {{{0xb, 0x0}, {0xc04dbd6f18, 0x7}}, {0xc04dbd6f60, 0xd}, 0x1, 0x48517d, {{0xc04d268100, ...}, ...}, ...}, ...)
/home/runner/go/pkg/mod/github.com/tendermint/[email protected]/state/execution.go:140 +0x171
github.com/tendermint/tendermint/consensus.(*Handshaker).replayBlock(, {{{0xb, 0x0}, {0xc04dbd6f18, 0x7}}, {0xc04dbd6f60, 0xd}, 0x1, 0x48517d, {{0xc04d268100, ...}, ...}, ...}, ...)
/home/runner/go/pkg/mod/github.com/tendermint/[email protected]/consensus/replay.go:503 +0x23c
github.com/tendermint/tendermint/consensus.(*Handshaker).ReplayBlocks(
, {{{0xb, 0x0}, {0xc04dbd6f18, 0x7}}, {0xc04dbd6f60, 0xd}, 0x1, 0x48517d, {{0xc04d268100, ...}, ...}, ...}, ...)
/home/runner/go/pkg/mod/github.com/tendermint/[email protected]/consensus/replay.go:416 +0x7ae
github.com/tendermint/tendermint/consensus.(*Handshaker).Handshake(0xc10cecdd48, {0x2e4d438, 0xc02131edd0})
/home/runner/go/pkg/mod/github.com/tendermint/[email protected]/consensus/replay.go:268 +0x3c8
github.com/tendermint/tendermint/node.doHandshake({_, }, {{{0xb, 0x0}, {0xc04dbd6f18, 0x7}}, {0xc04dbd6f60, 0xd}, 0x1, 0x48517d, ...}, ...)
/home/runner/go/pkg/mod/github.com/tendermint/[email protected]/node/node.go:330 +0x1b8
github.com/tendermint/tendermint/node.NewNode(0xc0004de280, {0x2e3a0a0, 0xc000eab400}, 0xc00108a410, {0x2e20d60, 0xc0413703a8}, 0x0?, 0x0?, 0xc00108a620, {0x2e3e698, ...}, ...)
/home/runner/go/pkg/mod/github.com/tendermint/[email protected]/node/node.go:778 +0x597
github.com/cosmos/cosmos-sdk/server.startInProcess(
, {{0x0, 0x0, 0x0}, {0x0, 0x0}, {0x0, 0x0}, {0x2e42160, 0xc00027ab30}, ...}, ...)
/home/runner/go/pkg/mod/github.com/axelarnetwork/[email protected]/server/start.go:281 +0x81b
github.com/cosmos/cosmos-sdk/server.StartCmd.func2(0xc0004dac80?, {0xc000ea83f0?, 0x1?, 0x3?})
/home/runner/go/pkg/mod/github.com/axelarnetwork/[email protected]/server/start.go:129 +0x169
github.com/spf13/cobra.(*Command).execute(0xc0004dac80, {0xc000ea8390, 0x3, 0x3})
/home/runner/go/pkg/mod/github.com/spf13/[email protected]/command.go:872 +0x694
github.com/spf13/cobra.(*Command).ExecuteC(0xc000e92780)
/home/runner/go/pkg/mod/github.com/spf13/[email protected]/command.go:990 +0x3b4
github.com/spf13/cobra.(*Command).Execute(...)
/home/runner/go/pkg/mod/github.com/spf13/[email protected]/command.go:918
github.com/spf13/cobra.(*Command).ExecuteContext(...)
/home/runner/go/pkg/mod/github.com/spf13/[email protected]/command.go:911
github.com/cosmos/cosmos-sdk/server/cmd.Execute(0x1f417b2?, {0xc000610240, 0x1c})
/home/runner/go/pkg/mod/github.com/axelarnetwork/[email protected]/server/cmd/execute.go:36 +0x1eb
main.main()
/home/runner/work/axelar-core/axelar-core/cmd/axelard/main.go:70 +0x4c5

Fantom

  • Fantom - the git version is outdated, so we have to use the following tag "1.1.0-rc.4" instead of "1.0.2-rc.5"

Also, we have decided to create "systemd" file to running Fantom as service and do not use "tmux" or "screen" tool: /etc/systemd/system/fantom.service
# ln -s /root/go-opera/build/opera /usr/local/bin/
# nano /etc/systemd/system/fantom.service

[Unit]
Description="Fantom systemd service"
After=network.target
StartLimitIntervalSec=0

[Service]
Type=simple
Restart=on-failure
RestartSec=10
User=root
SyslogIdentifier=fantom
SyslogFacility=local7
KillSignal=SIGHUP
ExecStart=/usr/local/bin/opera \
     --genesis /root/go-opera/build/testnet.g \
     --http \
     --http.addr=0.0.0.0 \
     --http.vhosts="*" \
     --http.corsdomain="*" \
     --ws \
     --ws.origins="*"
[Install]
WantedBy=multi-user.target

# systemctl daemon-reload
# systemctl enable fantom.service
# systemct start fantom.service

Dropdown Menu Blocks Text

If I shrink my browser size (width) and the hamburger icon is used for the menu, when I open the menu it covers up some of the text in the docs. I am assuming we will want to have that text pushed down rather than being covered up. Leaving two screenshots here for reference.

Screenshot 2023-08-11 at 11 23 41 AM Screenshot 2023-08-11 at 11 23 24 AM

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.