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

fix: Update readme to make code example run #75

Merged
merged 2 commits into from
Jul 25, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update readme to make code example run.
cazeth committed Jul 24, 2024
commit 956c1d42d714018096bfc7baa7143b60c86fcc71
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@ Add this to your Cargo.toml

```
[dependencies]
uniswap-sdk-core = "1.0.0-rc";
uniswap-sdk-core = "1.0.0-rc"
```

And this to your code:
@@ -37,6 +37,7 @@ the `token!` macro.
// having to import each dependency individually.
// Import necessary preludes and types
use uniswap_sdk_core::prelude::*;
use uniswap_sdk_core::token;
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
use uniswap_sdk_core::prelude::*;
use uniswap_sdk_core::token;
use crate::{prelude::*, token};


fn main() {
// Define the chain ID, address, decimals, symbol, and name for the token
@@ -58,7 +59,8 @@ fn main() {
println!("Are the tokens equal? {}", dai_token.equals(&another_dai_token));

// Example of sorting tokens
let another_token = token!(CHAIN_ID, "0x0000000000000000000000000000000000000002", DECIMALS, "ETH", "Ethereum");
const ANOTHER_TOKEN_ADDRESS: &str = "0x0000000000000000000000000000000000000002";
let another_token = token!(CHAIN_ID, ANOTHER_TOKEN_ADDRESS, DECIMALS, "ETH", "Ethereum");
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
const ANOTHER_TOKEN_ADDRESS: &str = "0x0000000000000000000000000000000000000002";
let another_token = token!(CHAIN_ID, ANOTHER_TOKEN_ADDRESS, DECIMALS, "ETH", "Ethereum");
let another_token = token!(
CHAIN_ID,
"0000000000000000000000000000000000000002",
DECIMALS,
"ETH",
"Ethereum"
);

token! can take either string literal or &str. If passing string literal to address! macro, "0x" should be stripped.

match dai_token.sorts_before(&another_token) {
Ok(true) => println!("DAI sorts before ETH"),
Ok(false) => println!("DAI does not sort before ETH"),