From dc8c7e918c086b902c7687bb601bf1eb82202df1 Mon Sep 17 00:00:00 2001 From: emmdim Date: Fri, 10 Nov 2023 18:31:38 +0100 Subject: [PATCH] *Updates sdk contracts dependency with published version * Updates readmes Signed-off-by: emmdim --- packages/contracts-ethers/README.md | 12 ++-- packages/js-client/README.md | 104 +--------------------------- packages/js-client/package.json | 2 +- 3 files changed, 9 insertions(+), 109 deletions(-) diff --git a/packages/contracts-ethers/README.md b/packages/contracts-ethers/README.md index 8f4612b1..567c7177 100644 --- a/packages/contracts-ethers/README.md +++ b/packages/contracts-ethers/README.md @@ -1,9 +1,9 @@ -# Aragon OSx Contracts for ethers.js +# Vocdoni Gasless Voting Contracts for for ethers.js -NPM package that provides ethers.js wrappers to use the Aragon DAO framework smart contracts. +NPM package that provides ethers.js wrappers to use the Vocdoni Gasless plugin on top of the Aragon DAO framework smart contracts. ```sh -yarn add @aragon/osx-ethers +yarn add @vocdoni/gasless-voting-ethers ``` ## Usage @@ -13,16 +13,16 @@ yarn add @aragon/osx-ethers ```ts import { DAOFactory__factory -} from "@aragon/osx-ethers"; +} from "@vocdoni/gasless-voting-ethers"; // Use it -const daoFactoryInstance = DAOFactory__factory.connect(...); +const daoFactoryInstance = Vocdoni_Vot.connect(...); ``` ### Getting the list of global contract addresses ```ts -import {activeContractsList} from '@aragon/osx-ethers'; +import {activeContractsList} from '@vocdoni/gasless-voting-ethers'; console.log(activeContractsList.rinkeby.DAOFactory); // '0x2290E6dF695C5272cE942015c90aAe24bFB94960' diff --git a/packages/js-client/README.md b/packages/js-client/README.md index 93eb55df..b8478d5c 100644 --- a/packages/js-client/README.md +++ b/packages/js-client/README.md @@ -1,103 +1,3 @@ -# TSDX User Guide +# Vocdoni Gasless Voting SDK for Aragon DAO -Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it. - -> This TSDX setup is meant for developing libraries (not apps!) that can be published to NPM. If you’re looking to build a Node app, you could use `ts-node-dev`, plain `ts-node`, or simple `tsc`. - -> If you’re new to TypeScript, checkout [this handy cheatsheet](https://devhints.io/typescript) - -## Commands - -TSDX scaffolds your new library inside `/src`. - -To run TSDX, use: - -```bash -npm start # or yarn start -``` - -This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`. - -To do a one-off build, use `npm run build` or `yarn build`. - -To run tests, use `npm test` or `yarn test`. - -## Configuration - -Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly. - -### Jest - -Jest tests are set up to run with `npm test` or `yarn test`. - -### Bundle Analysis - -[`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of your library with `npm run size` and visualize the bundle with `npm run analyze`. - -#### Setup Files - -This is the folder structure we set up for you: - -```txt -/src - index.tsx # EDIT THIS -/test - blah.test.tsx # EDIT THIS -.gitignore -package.json -README.md # EDIT THIS -tsconfig.json -``` - -### Rollup - -TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details. - -### TypeScript - -`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs. - -## Continuous Integration - -### GitHub Actions - -Two actions are added by default: - -- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix -- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit) - -## Optimizations - -Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations: - -```js -// ./types/index.d.ts -declare var __DEV__: boolean; - -// inside your code... -if (__DEV__) { - console.log('foo'); -} -``` - -You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions. - -## Module Formats - -CJS, ESModules, and UMD module formats are supported. - -The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found. - -## Named Exports - -Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library. - -## Including Styles - -There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like. - -For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader. - -## Publishing to NPM - -We recommend using [np](https://github.com/sindresorhus/np). +The Aragon App integrates a plugin built by Vocdoni, which uses VoChain. VoChain is a Proof of Authority blockchain. Though block production is restricted to select trusted authorities, anyone can join the network and operate their own node for synchronization and confirmation; ensuring end-to-end verifiability. Vocdoni is censorship resistant because it uses distributed ledger technology. A transaction can only be blocked if 2/3 of the Vochain authorities concur, but all actions are transparent and auditable by the community diff --git a/packages/js-client/package.json b/packages/js-client/package.json index 8ba2dab7..4f2122e2 100644 --- a/packages/js-client/package.json +++ b/packages/js-client/package.json @@ -88,7 +88,7 @@ "@ethersproject/wallet": "^5.7.0", "graphql": "^16.6.0", "graphql-request": "4.3.0", - "@vocdoni/gasless-voting-ethers": "./vocdoni-gasless-voting-ethers-v0.0.1-rc6.tgz", + "@vocdoni/gasless-voting-ethers": "0.0.1-rc1", "@vocdoni/sdk": "0.4.2", "axios": "0.27.2", "@types/big.js": "^6.1.5"