Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Making examples work out-of-the-box #224

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

caffeinum
Copy link

SDK Examples Quickstart

Running these sdk examples, I have fallen into many small hurdles. I would love these examples to be easy to get up and running in 5 minutes.

I have started with fixing the config to work without any additional modification from the user

Task: ID

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I ran all tests with success and extended them if necessary.
  • I have updated the CHANGELOG.md file in the root folder of the package after the [UPCOMING] title and before the latest version.
  • I have tested my code on the test network.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@sonarcloud
Copy link

sonarcloud bot commented Jun 14, 2023

SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
4.2% 4.2% Duplication

Copy link
Contributor

@mathewmeconry mathewmeconry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @caffeinum
Thanks for this pull request.

I left you some comments and it looks like you introduced dotenv but it is not in the npm dependency list. Please add it as dev dependency for the examples to work.

Additionally, I suggest you either create an .env.example or another way to document the ENV variables you introduce with this pull request

Comment on lines +42 to +43
// Through pinning the metadata in IPFS, we can get the IPFS URI. You can read more about it here: https://docs.ipfs.tech/how-to/pin-files/
// const metadataUri = await client.methods.pinMetadata(metadata);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is the intention with this comment? the code is already on lines 37-38

context.network
);

// console.log('tokenVotingInstallItem', tokenVotingInstallItem);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove or uncomment

});
break;
const createDaoParams: CreateDaoParams = {
metadataUri, // : `https://dao.mydao.com/metadata.json`, // the URI of the metadata file
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the URL is more like ipfs://QmXhxqAneHFWr98Jqv96Pzm8pysfiLMcoyAuf8BQq6DK6m when you use the IPFS upload. Otherwise it can be any kind of URL

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants