sygmaprotocol / sygma-sdk Goto Github PK

Implementation details

Make default: 10 blocks
But should be able to configurate per network

Testing details

Acceptance Criteria

Currently it required to approve deposit 3 times.
Check is it possible to do this with one approve

Implementation details

Testing details

Acceptance Criteria

Add support of rollup to build esModules and commonjs from the SDK codebase

Implementation details

Update the build script and use rollup to build correct modules

Testing details

Acceptance Criteria

The main idea is to get rid of hardcoded address in examples and if possible in the docs.
Instead replace it with always working configuration from local setup.

Implementation details

Create support for share configuration for examples.

Testing details

Create E2E test for that, including CI

Acceptance Criteria

All examples should run with the latest configurations of the local setup config.
Update the docs accordingly

Implementation details

Create a frontend app with basic support of substrate

Testing details

Acceptance Criteria

The user should be able to deposit using polkadot.js extension and our local setup

Colors example fails to start and returns errors (probably related to new version of sdk?).
Also, would be nice to be able to set environment variables for it in some .env file to be able to
deploy for devnet.

Our sdk should start accepting substrate addresses as destination address as well as appropriate calldata encoding.

Implementation details

Since Substrate address has different format and validation that might require to make some changes in SDK.
https://docs.substrate.io/fundamentals/accounts-addresses-keys/
Also we calldata encoding for Substrate network as destination should be little bit different since length of address is different from ETH one and we are encoding deposit calldata as amount + addresslen + address and must be sure that everything on SDK side will work fine with Substrate address type.

Testing details

Acceptance Criteria

Implementation details

Add script in package.json to generate docs using typedoc

Testing details

Could be good idea to research the CI part as well

Acceptance Criteria

The user can generate docs extracting jdocs from codebase

SDK will need to send extrinsic to substrate
For Phala sygma pallet, extrinsic includes bridge request, retry

Implementation details

details could be found in the SoW research doc

Testing details

Unit test

Acceptance Criteria

SDK should have ability to send extrinsic to any substrate
SDK should be able to send bridge request extrinsic and retry extrinsic to Phala sygma pallet

root package json missing params packageManager and engines

Substrate chain might have different deposit data, so SDK needs to construct it accordingly

Implementation details

Phala Sygma pallet requires MultiLocation data, and this data should be embedded into the depositData

some useful link:
https://wiki.phala.network/en-us/general/subbridge/technical-details/#multiasset-and-multilocation
The first time it was introduced from XCM protocol: https://github.com/paritytech/xcm-format#7-universal-consensus-location-identifiers
Gavin Wood's explanation: https://medium.com/polkadot-network/xcm-the-cross-consensus-message-format-3b77b1373392#1330
The source code declaration: https://github.com/paritytech/polkadot/blob/master/xcm/src/v1/multilocation.rs#L51

Testing details

Unit test

Acceptance Criteria

SDK consumes necessary params and construct a depositData in bytes that embedded MultiLocation data

Following the functional style from the Substrate section, it's required to add the rest of EVM-related functions from Sygma class to the src/chains/EVM folder.
Preparing to the deprecation of Sygma class.

Implementation details

Create basic jsdoc annotations for every function

Testing details

Cover 100% of lines by jest unit tests

Acceptance Criteria

The developer can use EVM-related functions using EVM namespace import { EVM } from "@buildwithsygma/sygma-sdk-core";

SDK will need to make runtime call to substrate in order to query useful info.
For Phala sygma pallet, account balance, estimate fee are the implementation

Implementation details

details could be found in the SoW research doc

Testing details

Unit test

Acceptance Criteria

SDK should have ability to make runtime call to any substrate
SDK should be able to call Phala sygma pallet to query balance of an account, estimate the fee for a bridging request

Improve the docs by adding the examples

Implementation details

Add examples of usage for functions in Substate and EVM

Testing details

Acceptance Criteria

The user should understand the function better reading our docs

Examples are the secondary document on how to do things with SDK, so readability is pretty important.
To improve it utilize React's Components and other techniques that the reader can focus on flow and usages of SDK.

Implementation details

Testing details

Add unit tests for all involving functions

Acceptance Criteria

Since we are using github packages, we should upate examples to work with this new package and also update with new changes regarding BridgeData structure (tokens array and fee settings)

Update README to target github registry and not npm

Provide scoping options to do this

Implementation details

Testing details

Acceptance Criteria

With latest aditions to the SDK, we need to update the README with instructions on how to use our SDK alongside with the examples and dependencies

Implementation details

• Update root README with latest instructions on how to install and run SDK + examples

Testing details

Acceptance Criteria

Add config and methods to support bridging ERC721 tokens

Implementation details

Testing details

Acceptance Criteria

Could bridge ERC721 tokens with SDK

Implementation details

• Check dependencies in the SDK package to make sure it can be used as standalone lib.
• Remove unused dependencies

Testing details

Acceptance Criteria

The SDK should work fine as standalone lib

Implement annotations over methods of the SDK

Implementation details

• Decide between TSDocs or JSDocs to use
• Provide descriptions for all the methods.
• Update README with most important methods to use for the SDK in common scenarios, frontend or backend

Testing details

Acceptance Criteria

SDK needs to support creating deposit requests toward domains (networks) that are substrate-based for resources that are using dynamic fee handling.

Implementation details

For token bridging requests, the flow remains the same as before. SDK invokes fee oracle for a fee estimate message on endpoint /v1}/rate/from/{fromDomainID}/to/{toDomainID}/resourceid/{resourceID}. The fee oracle will return the appropriate fee estimate message based on the destination domain.

The flow of generic messages is similar to before, but with one difference. Here SDK needs to understand the context of requesting a fee estimate for a request with the substrate-based destination chain, as it will need to calculate the length_fee property of extrinsic before calling fee oracle. Here you can read more on how fees are calculated on substrate-based chains, but effectively length_fee is the bytes length of the concrete extrinsic.

For more context on the fee estimate message format, you can check the technical documentation of the fee oracle (once this PR is merged technical documentation will be inside repo inside /docs)

Testing details

[] Add unit test with mocked fee oracle API

Acceptance Criteria

[] SDK support creating deposit requests for token bridging requests toward substrate-based networks for resources using dynamic fee strategy
[] SDK support creating deposit requests for generic requests toward substrate-based networks for resources using dynamic fee strategy

All of our current examples use sdk as linked dependency and not from npm registry. This add complexity when trying to run examples and its less straightfoward since it need to run TS compiler in the sdk folder.

Implementation details

Remove examples folder from workspaces to use dependency from npm.

Testing details

Acceptance Criteria

Implementation details

Use fee settings for every specific token. So the config should be change accordingly

Testing details

Acceptance Criteria

Every token in every bridge has his own fee logic

Currently we have a folder called integration with e2e test against json rpc and some functional test against some basic methods that our SDK provides. To impove our codebase, we should have those tests separated.

Implementation details

• create folder for e2e and functional or unit tests
• acomodate current test in those folder.
• fix the tests that are not passing due to recent updates in the codebase

Testing details

• all test must pass
• PR pipeline should have test running

Acceptance Criteria

Fix invalid imports at basicFee.ts . Check other files for invalid imports.

Implementation details

Testing details

Acceptance Criteria

All imports should be correct

Implementation details

details could be found in the SoW research doc

Testing details

Unit test

Acceptance Criteria

SDK should be able to call fee oracle api to fetch substrate fee related data

Implementation details

Added special adapter for substrate
New configuration for main sygma class

Testing details

Acceptance Criteria

SDK should be able to deposit on substrate chain

Implementation details

Testing details

Acceptance Criteria

Expected Behavior

To have 0 Error and Warning while running lint

Current Behavior

yarn run sdk:lint
yarn run v1.22.19
$ yarn workspace @buildwithsygma/sygma-sdk-core lint
$ eslint '{src,integration}/**/*.ts'

Oops! Something went wrong! :(

ESLint: 8.28.0

Error: Failed to load plugin '@typescript-eslint' declared in '.eslintrc.js » ../../.eslintrc.js » @chainsafe/eslint-config': Cannot find module 'eslint/use-at-your-own-risk'
Require stack:
- /home/bero/WebstormProjects/sygma-sdk/node_modules/@chainsafe/eslint-config/node_modules/@typescript-eslint/eslint-plugin/dist/util/getESLintCoreRule.js
- /home/bero/WebstormProjects/sygma-sdk/node_modules/@chainsafe/eslint-config/node_modules/@typescript-eslint/eslint-plugin/dist/rules/brace-style.js
- /home/bero/WebstormProjects/sygma-sdk/node_modules/@chainsafe/eslint-config/node_modules/@typescript-eslint/eslint-plugin/dist/rules/index.js
- /home/bero/WebstormProjects/sygma-sdk/node_modules/@chainsafe/eslint-config/node_modules/@typescript-eslint/eslint-plugin/dist/index.js
- /home/bero/WebstormProjects/sygma-sdk/node_modules/@eslint/eslintrc/dist/eslintrc.cjs
Referenced from: /home/bero/WebstormProjects/sygma-sdk/node_modules/@chainsafe/eslint-config/index.js
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:794:15)
    at Function.Module._load (internal/modules/cjs/loader.js:687:27)
    at Module.require (internal/modules/cjs/loader.js:849:19)
    at require (internal/modules/cjs/helpers.js:74:18)
    at /home/bero/WebstormProjects/sygma-sdk/node_modules/@chainsafe/eslint-config/node_modules/@typescript-eslint/eslint-plugin/dist/util/getESLintCoreRule.js:34:5
    at Object.<anonymous> (/home/bero/WebstormProjects/sygma-sdk/node_modules/@chainsafe/eslint-config/node_modules/@typescript-eslint/eslint-plugin/dist/rules/brace-style.js:5:60)
    at Module._compile (internal/modules/cjs/loader.js:956:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:973:10)
    at Module.load (internal/modules/cjs/loader.js:812:32)
    at Function.Module._load (internal/modules/cjs/loader.js:724:14)
error Command failed with exit code 2.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
error Command failed.
Exit code: 2
Command: /home/bero/.nvm/versions/node/v12.13.0/bin/node
Arguments: /home/bero/.nvm/versions/node/v12.13.0/lib/node_modules/yarn/lib/cli.js lint
Directory: /home/bero/WebstormProjects/sygma-sdk/packages/sdk
Output:

info Visit https://yarnpkg.com/en/docs/cli/workspace for documentation about this command.
error Command failed with exit code 2.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Steps to Reproduce (for bugs)

run yarn run sdk:lint

Expected Behavior

When running example following instructions to work

Current Behavior

You can run the example without a problem but is UI is broken

Steps to Reproduce (for bugs)

1. Clone project
2. build SDK
3. run the relayer
4. follow instructions to run an example
5. press connect button on the UI

Versions

main

Implementation details

Configure GitHub actions for linting and running tests

Testing details

Acceptance Criteria

The CI should run after each commit

In order for us to have e2e test we need to setup nodes and relayer to check for events

Implementation details

• setup e2e suite to run test that would require this type of setup
• explore feasibility of setup two hardhat nodes and relayers

Testing details

Acceptance Criteria

We have a frontend example for ERC721, we should provide one for ERC721 on Node.js

Implementation details

• Implement example to run on comand line
• re-use nft mint script from frontend example

Testing details

Acceptance Criteria

Implementation details

Following the expansion of the Fee oracle endpoint that will be implemented with this issue, we need for SDK to reflect this when fetching fee data from oracle here.

This means that we have an additional argument, msgGasLimit that needs to be provided when creating a generic message request using SDK. This should be an optional argument (defaults to 0).

Testing details

• manually test with local setup (this is blocked by changes on fee oracle)

Acceptance Criteria

• fee oracle changes reflected in SDK
• successfully executed permissionless generic request created with SDK, executed on local setup

Expected Behavior

When running example following instructions to work

Current Behavior

You can run the example without a problem but is UI is broken

Steps to Reproduce (for bugs)

1. Clone project
2. build SDK
3. run the relayer
4. follow instructions to run an example
5. press connect button on the UI

Versions

main

https://developer.mozilla.org/en-US/docs/web/javascript/reference/global_objects/string/substr

In examples erc20-react-example and erc721-react-example there is the usage of window.confirm which fulfills the need of an example but for a better impression, it should be a modal

• param for getting msgGasLimit should be a query param

Expected Behavior

• get the response with whathever the number is being passed or defaults to zero

Current Behavior

Possible Solution

Steps to Reproduce (for bugs)

Versions

ChainBridge commit (or docker tag):
chainbridge-solidity version:
chainbridge-substrate version:
Go version:

feeData will be different for substrate chain comparing to evm chain, so SDK will have to construct feeData differently and send to contract for fee calculation

Implementation details

details could be found in the SoW research doc

Testing details

Unit test

Acceptance Criteria

SDK should be able to construct all necessary params that fetched from fee oracle into feeData for substrate chain

          Please use `yarn outdated` to check available package updates.

Found a lot of packages that have patches and did not updated in this PR #138

Originally posted by @BeroBurny in #138 (review)

In order to provide guide for ERC721 usage we need to build small example application and Guide that describes how this works.

Implementation details

Build example with usage of basicFeeHandler but documentation should also mention both (with fees and without)
Example app should be able to run with local setup so there is should be guide to run it locally.
Example application should have drop down for owned NFT tokens from selected collection

Testing details

[] Recheck that everything works locally couple times, ask someone else to run it to make sure that it is working fine

Acceptance Criteria

[] Example application implemented
[] Readme guide for this application written

Create Node.js example for generic contract

Implementation details

• make use of Colors contract already present in local setup
• create example to run over terminal

Testing details

Acceptance Criteria

Update fee oracle logic according to usage of resourceID instead of token address.

Implementation details

Testing details

Acceptance Criteria

The fee oracle will return rates using resourceId as unique identifier

SDK needs to provide Substrate as destination chain to allow other surroundings features such as Substrate fee calculation and resourceID binding, etc. when bridging from EVM to Substrate, SDK also needs to communicate with Substrate in order to send extrinsic and make a runtime call when bridging from Substrate to EVM, so general chain support is necessary.
Phala Sygma pallet will be the actual implementation after general support added

Implementation details

details could be found in the SoW research doc

Testing details

Unit test

Acceptance Criteria

SDK should have general substrate chain support including configuration structure define, communication setup

Implementation details

Generally it is still only one deposit method that needs to be called by SDK but there is also specific format of the calldata that is parsed by Generic.
@MakMuftic should have all the details and documentation

Testing details

Acceptance Criteria

• SDK can be used to call Generic methods across chain and compose calldata

Currently, most parts of the code base are not covered with a linter and eslint-disable should not be used anywhere

Migrate from yarn v1 to the current version of pnpm as primary package manager.

Implementation details

Could be some breaking changes.

Testing details

CI scripts should also be migrated to pnpm

Acceptance Criteria