From 10c00cb911ca81a42a9a3085138354b2485b15ed Mon Sep 17 00:00:00 2001 From: Rohit Durvasula <88731568+drohit-cb@users.noreply.github.com> Date: Thu, 9 May 2024 11:57:25 -0700 Subject: [PATCH] Updates to README and CONTRIBUTING guide (#29) ## Description Of Change This PR helps: 1. Fix link to official repo within contributing guide 2. Update README to fix some quotes in ts example code and update some verbiage 3. Move contribution section above documentation in README ## Testing Procedure Manually reviewed the README on Github. --- CONTRIBUTING.md | 2 +- README.md | 21 +++++++++------------ 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f516ba..89696d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ Please note that this project is released with a [Contributor Code of Conduct](C ## Official Repository -We use Github to host code, track issues, and accept pull requests. This Github repository is the "official" repository of this project. All changes/fixes/suggestions should be submitted here (i.e. github.com/coinbase/staking-client-library-go) +We use Github to host code, track issues, and accept pull requests. This Github repository is the "official" repository of this project. All changes/fixes/suggestions should be submitted here (i.e. github.com/coinbase/staking-client-library-ts) ## Reporting Bugs diff --git a/README.md b/README.md index fd8ac2b..56e9a97 100644 --- a/README.md +++ b/README.md @@ -39,10 +39,9 @@ Prerequisite: [Node 20+](https://www.npmjs.com/package/node/v/20.11.1) ### Stake Partial ETH :diamond_shape_with_a_dot_inside: -This code sample creates an ETH staking workflow. View the full code sample [here](examples/ethereum/create-workflow.ts) +This code sample helps stake partial ETH (non-multiples of 32 ETH). View the full source [here](examples/ethereum/create-workflow.ts)
- Code Sample ```typescript // examples/ethereum/create-workflow.ts @@ -59,7 +58,7 @@ client.Ethereum.stake('holesky', '0xdb816889F2a7362EF242E5a717dfD5B38Ae849FE', ' console.log(JSON.stringify(workflow, null, 2)); }) .catch(() => { - throw new Error(`Error creating workflow`); + throw new Error('Error running stake action on ethereum'); }); ``` @@ -106,10 +105,9 @@ client.Ethereum.stake('holesky', '0xdb816889F2a7362EF242E5a717dfD5B38Ae849FE', ' ### Stake SOL :diamond_shape_with_a_dot_inside: -This code sample creates a SOL staking workflow. View the full code sample [here](examples/solana/create-workflow.ts) +This code sample helps stake SOL from a given user wallet. View the full source [here](examples/solana/create-workflow.ts)
- Code Sample ```typescript // examples/solana/create-workflow.ts @@ -126,7 +124,7 @@ client.Solana.stake('devnet', '8rMGARtkJY5QygP1mgvBFLsE9JrvXByARJiyNfcSE5Z', '10 console.log(JSON.stringify(workflow, null, 2)); }) .catch(() => { - throw new Error(`Error creating workflow`); + throw new Error('Error running stake action on solana'); }); ``` @@ -177,10 +175,9 @@ client.Solana.stake('devnet', '8rMGARtkJY5QygP1mgvBFLsE9JrvXByARJiyNfcSE5Z', '10 ### View Ethereum Rewards :moneybag: -This code sample returns rewards for an Ethereum validator address. View the full code sample [here](examples/ethereum/list-rewards.ts). +This code sample helps view rewards for an Ethereum validator address. View the full source [here](examples/ethereum/list-rewards.ts).
- Code Sample ```typescript // examples/ethereum/list-rewards.ts @@ -271,10 +268,10 @@ client.Ethereum.listRewards(filter).then((resp) => {
-## Contributing - -Thanks for considering contributing to the project! Please refer to [our contribution guide](./CONTRIBUTING.md). - ## Documentation There are numerous examples in the [`examples directory`](./examples) to help get you started. For even more, refer to our [documentation website](https://docs.cdp.coinbase.com/staking/docs/welcome) for detailed definitions, API specifications, integration guides, and more! + +## Contributing + +Thanks for considering contributing to the project! Please refer to [our contribution guide](./CONTRIBUTING.md).