https://github.com/67p/kredits-contracts-legacy
[DEPRECATED] Smart contracts for Kosmos Kredits
https://github.com/67p/kredits-contracts-legacy
ethereum kosmos kredits npm-module smart-contracts solidity web3
Last synced: about 1 month ago
JSON representation
[DEPRECATED] Smart contracts for Kosmos Kredits
- Host: GitHub
- URL: https://github.com/67p/kredits-contracts-legacy
- Owner: 67P
- Created: 2017-02-05T08:05:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-03T09:55:19.000Z (about 7 years ago)
- Last Synced: 2025-03-27T15:51:52.993Z (about 2 months ago)
- Topics: ethereum, kosmos, kredits, npm-module, smart-contracts, solidity, web3
- Language: JavaScript
- Homepage:
- Size: 113 KB
- Stars: 5
- Watchers: 8
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DEPRECATION WARNING
This repo has been deprecated in favor of a new one, which is using the Truffle
framework and a new JavaScript API wrapper for clients to integrate:
https://github.com/67P/kredits-contracts
# Kredits Contracts
This repository contains source code and related files for the Ethereum smart
contracts, which are issuing and managing [Kosmos
Kredits](https://wiki.kosmos.org/Kredits).
## Getting started
Add [kredits-contracts](https://www.npmjs.com/package/kredits-contracts) as
dependency to your project:
npm install --save kredits-contracts
```javascript
const kreditsContracts = require('kredits-contracts');
const Web3 = require('web3');
let contracts = kreditsContracts(web3);
let Kredits = contracts['Kredits'];
let Token = contracts['Token'];
// sync contract calls (not supported by all web3 configurations)
console.log(Kredits.contributorsCount());
// async contract calls
Kredits.contributorsCount(c => console.log);
```
This package comes with pre-configured, default contract addresses for dev (our
KreditsChain on parity.kosmos.org), test (kovan) and the main ethereum network.
You can also provide your custom contract addresses:
```javascript
let contracts = kreditsContracts(web3, {
Kredits: {address: 'x0kredits'},
Token: {address: 'x0token'}
});
```
Have a look at the contract documentation and the [contract
sources](https://github.com/67P/kredits-contracts/tree/master/contracts) for
available contract methods.
### Kredits contract
```javascript
let k = kreditsContracts(web3)['Kredits'];
k.contributorsCount();
k.addContributor('<0xContributorAddress>', '', '', isCore?, 'github id');
k.contributors('<0xContributorAddress>') // returns the contributor data as array
k.addProposal('<0xRecipient>', , , );
k.proposalsCount();
k.proposals();
k.vote();
```
### Token contract
The Token follows the [ERC20 Token](https://github.com/ethereum/EIPs/issues/20)
standard and implements all standard methods.
```javascript
let t = kreditsContracts(web3)['Token'];
t.totalSupply();
t.balanceOf('0xAddress');
t.transfer('0xToAddress', );
```
## Developing kredits-contracts
[Solidity](https://solidity.readthedocs.io/) sources are stored in the
`contracts` directory. Besides that we follow the npm directory layout.
It is recommended to run a local ethereum node (e.g. parity) to deploy and test
the contracts locally. The `scripts/parity.sh` script helps starting parity
node configuried with a separated local KreditsChain and a funded account. It
starts the RPC interface and makes the wallet UI available.
Start parity:
npm run parity
Start parity and open the wallet UI:
npm run parity ui
All other parity commands are available:
npm run parity -- --help
### Deploy contracts
`scripts/deploy.js` is a simple deploy script to deploy solidity sources to a
specified Ethereum network.
See --help for all configuration options:
npm run deploy -- --help
Deploy the Kredits contract to the dev network (note the capitalized Kredits -
just as the contract name and filename):
npm run deploy -- --network=dev --contracts=Kredits
Deploy the contracts and write the contracts metadata (address/abi) to
/path/to/my/app:
npm run deploy -- --directory=/path/to/my/app
Deploy the contracts to a specified network (test) through a specified node/RPC provider:
npm run deploy -- --network=test --provider-url=http://localhost:8545
### Contracts REPL
To quickly interact with the contracts, you can use the REPL provided by
`scripts/console.js`
See --help for all configuration options:
npm run console -- --help
### Inspect contracts metadata
To watch contracts from an Ethereum wallet (e.g. parity) you need the contracts
addresses and ABIs.
See --help for all configuration options:
npm run inspect -- --help
Print the ABI for the Kredits contract:
npm run inspect -- --what=abi --contracts=Kredits
### Remix IDE
[Solidity Browser (Remix)](https://ethereum.github.io/browser-solidity/) can be used as
an interactive IDE for contract development in the browser, with no running
node or contract deployment needed.
## To Do
- TESTS
- Generate contract object documentation automatically
## Resources
* [Solidity Docs](https://solidity.readthedocs.io/en/latest/)