Giter VIP home page Giter VIP logo

loom-sdk-documentation's Introduction

Loom SDK Docs site

Files to file generate the new Loom SDK doc site at https://loomx.io/developers

Usage

# first time setup
yarn
# rebuild site after changing docs/*.md
yarn build
# run locally
yarn start

loom-sdk-documentation's People

Contributors

adityagodbole avatar adyromantika avatar andreipope avatar cobject avatar diericx avatar eduardonunesp avatar enlight avatar extrodox avatar gakonst avatar hankxdev avatar hjveronica avatar jwvg0425 avatar ksandom avatar kyteague avatar lukezhangstudio avatar mamim avatar mattkanwisher avatar midnightlightning avatar misha-yu avatar nishantmodak avatar oxyaction avatar phoorichet avatar redben avatar roadagain avatar sonatard avatar sriep avatar tinatang1021 avatar trsmarc avatar tstxni97 avatar zimm-lostpolygon 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

Watchers

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

loom-sdk-documentation's Issues

Fix the PlasmaChain Testnets documentation/TG addresses

We have a previous ticket for this - #184

Not sure if this was fixed but let's take a look at it and if not we should get this in to-do. The previous issue is closed so I created this new one for tracking.

According to a comment from SORARE - still the addresses have issues ->

Preview

Pierre, [19.06.19 16:18]
hello. can you confirm that the ethereum transfer gateway address is 0x223CA78df868367D214b444d561B9123c018963A ?

Pierre, [19.06.19 16:18]
I'm starting the tests on mainnet

Pierre, [19.06.19 16:19]
it is the address I found here: https://loomx.io/developers/docs/en/testnet-plasma.html#contract-addresses-transfer-gateway

Pierre, [19.06.19 16:19]
but looks like the last tx was 90 days ago

Nayeem | Loom Network, [19.06.19 16:21]
[In reply to Pierre]
hey checking sec

Pierre, [19.06.19 16:21]
seems like the right address is 0xE080079Ac12521D57573f39543e1725EA3E16DcC

Pierre, [19.06.19 16:21]
you should update your website

Matthew Campbell, [19.06.19 16:22]
@nayeemsidd can you add a ticket on the docs site and get andrei to fix this

Script to install Loom is a broken link

On the page to install the Loom SDK the first step results in a 404:
curl https://raw.githubusercontent.com/loomnetwork/loom-sdk-documentation/master/scripts/get_loom.sh | sh

sh: 1: 404:: not found

How to deploy to mainnet

The updated dashboard/wallet going out this week has better ui for mainnet key generation. Lets have a walkthrough on how to use it

Error returned with node ./gateway-cli.js map-contracts token

TypeError returned when I issued "node ./gateway-cli.js map-contracts token". I changed rinkeby API key in the gateway-cli.js.

TypeError: callback is not a function at LoomProvider.<anonymous> (/home/ether/work/truffle/truffle-dappchain-example/node_modules/loom-js/dist/loom-provider.js:257:25) at step (/home/ether/work/truffle/truffle-dappchain-example/node_modules/tslib/tslib.js:133:27) at Object.next (/home/ether/work/truffle/truffle-dappchain-example/node_modules/tslib/tslib.js:114:57) at /home/ether/work/truffle/truffle-dappchain-example/node_modules/tslib/tslib.js:107:75 at new Promise (<anonymous>) at Object.__awaiter (/home/ether/work/truffle/truffle-dappchain-example/node_modules/tslib/tslib.js:103:16) at LoomProvider.send (/home/ether/work/truffle/truffle-dappchain-example/node_modules/loom-js/dist/loom-provider.js:227:24) at VersionMethod._callee$ (/home/ether/work/truffle/truffle-dappchain-example/node_modules/web3/node_modules/web3-core-method/dist/web3-core-method.cjs.js:454:55) at tryCatch (/home/ether/work/truffle/truffle-dappchain-example/node_modules/@babel/runtime/node_modules/regenerator-runtime/runtime.js:62:40) at Generator.invoke [as _invoke] (/home/ether/work/truffle/truffle-dappchain-example/node_modules/@babel/runtime/node_modules/regenerator-runtime/runtime.js:288:22) at Generator.prototype.(anonymous function) [as next] (/home/ether/work/truffle/truffle-dappchain-example/node_modules/@babel/runtime/node_modules/regenerator-runtime/runtime.js:114:21) at asyncGeneratorStep (/home/ether/work/truffle/truffle-dappchain-example/node_modules/@babel/runtime/helpers/asyncToGenerator.js:3:24) at _next (/home/ether/work/truffle/truffle-dappchain-example/node_modules/@babel/runtime/helpers/asyncToGenerator.js:25:9) at /home/ether/work/truffle/truffle-dappchain-example/node_modules/@babel/runtime/helpers/asyncToGenerator.js:32:7 at new Promise (<anonymous>) at VersionMethod.<anonymous> (/home/ether/work/truffle/truffle-dappchain-example/node_modules/@babel/runtime/helpers/asyncToGenerator.js:21:12) at VersionMethod.execute (/home/ether/work/truffle/truffle-dappchain-example/node_modules/web3/node_modules/web3-core-method/dist/web3-core-method.cjs.js:477:25) at Proxy.anonymousFunction (/home/ether/work/truffle/truffle-dappchain-example/node_modules/web3/node_modules/web3-core-method/dist/web3-core-method.cjs.js:228:25) at Command.<anonymous> (/home/ether/work/truffle/truffle-dappchain-example/gateway-cli.js:899:59) at process._tickCallback (internal/process/next_tick.js:68:7)

Here's npm package versions.
@babel/[email protected]
@babel/[email protected]
@babel/[email protected]
@babel/[email protected]
@babel/[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]

Multi-node peer setup docs are incorrect

The docs from the Multi-node deployment section from the SDK documentation says that you need to let your node learn about other peers on the network by running

loom run <peer-list>

However the CLI help command for loom run --help says that it should be

loom run -p <peers>

I have tested both ways of setting things up and can confirm the sdk-docs are incorrect. It only works with the -p option.

Need to fix in cocos-sdk-quickstart.md.

Refer to the #129.
And also, Word in diagrams is needed to fix like below.
I can not modify that.

In Loom global structure diagram,

  • CocosProtingLayer => CocosPortingLayer (O)

In Loom Cocos SDK structure diagram

  • Cocos Proting Layer => Cocos Porting Layer (O)

Add documentation for writing smart contracts in Go

On the "Building DAppChain clients in Golang" page (go-loom-clients), the documentation currently indicates:

In this section you'll be introduced to the go-loom API that you will use to write Go code that interacts with a Loom DAppChain, writing smart contracts in Go will be covered in a later section.

That "writing smart contracts in Go" bit I can't find in the existing documentation. Does it exist or need to be created yet? The helloworld sample contract written in Go has some examples of needed syntax, but the deployment and other nuances of a Go contract don't seem to be covered.

FAQ entry for Ethers.js

Should have some basic docs on how to bootstrap ethers on loom
Also how to use Eth signing

Bep2<-->Loom Mainnet<-->ERC20

We need a doc that does the following.

  1. Has a single git repo, with an erc20 token.
  2. Truffle deploy steps
    a) Mainnet Ethereum
    b) Mainnet Loom Chain

Lets try and reuse this https://github.com/loomnetwork/truffle-dappchain-example

  1. Has directions on how to mint a new token on Binance Testnet ( Talk to deeprom on steps for this)
  2. Has how to link to transfer gateways, to evm contract on loom
    a) on Eth
    b) on Binance
  3. Walks user how they can move tokens through all three chains
  4. Lets update the token to also have mintable/burnable functions on mainnet, for tokens that have inflationationary supply

Typo in "Javascript WebSockets and Web3 Demo"

In docs/phaser-sdk-demo-websocket-web3.md and website/translated_docs/zh-CN/phaser-sdk-demo-websocket-web3.md

to create seamlessly experience

should be

to create seamless experiences

or

to create a seamless experience

[Request] Loom release version management

Dear @mattkanwisher,

Every new release, you need to change download url for loom binary in all repository’s readme file and dev page.

It is not comfortable to maintain, so I suggest that you’d better get a url always pointing to latest version of loom like below.

(example)
https://private.delegatecall.com/loom/osx/build-latest/loom

is now exactly same as

https://private.delegatecall.com/loom/osx/build-404/loom.

This make it easier to download latest version of loom any time and reduce useless commits to change version of loom, less conflicts for developer.

Thanks

Doc site opens without left navigation pane

There's a small bug in the developer documentation site. Once I click on the Docs under Loom SDK product page, the docs page opens without the side navigation bar. I have to click on "Docs" at the top to see the navigation bar.

Dev deploy instructions

Draft:
We go here, https://dev-dashboard.dappchains.com/add-key. first, you will click on generate a new public address. then, you will copy and paste the mnemonic and the public address. put the mnemonic somewhere safe. paste the address and click add key. you will be asked to stake (or pay?) some amount of loom (10?). lastly, you’ll use the mnemonic to deploy with truffle. i’m going to show them how to add the mnemonic to truffle-config.js.

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.