Skip to content

link to examples in directory from readme #90

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 12, 2019
Merged

link to examples in directory from readme #90

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a11a7a
link to examples in directory from readme
Nov 11, 2019
21b46ed
use relative paths
Nov 12, 2019
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
148 changes: 2 additions & 146 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,153 +40,9 @@ wasm-pack pack

## Examples

### Create transaction

The following example sets up an example project using Webpack to bundle the library and run the code in the browser.

Try it yourself.

1. Go to that a directory and create the following files.

#### package.json

```json
{
"scripts": {
"build": "webpack",
"serve": "webpack-dev-server"
},
"devDependencies": {
"text-encoding": "^0.7.0",
"html-webpack-plugin": "^3.2.0",
"webpack": "^4.29.4",
"webpack-cli": "^3.1.1",
"webpack-dev-server": "^3.1.0"
},
"dependencies": {
"js-chain-libs": "^0.1"
}
}
```

#### webpack.config.js

```js
const path = require('path');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const webpack = require('webpack');

module.exports = {
entry: './index.js',
output: {
path: path.resolve(__dirname, 'dist'),
filename: 'index.js'
},
plugins: [
new HtmlWebpackPlugin(),
// Have this example work in Edge which doesn't ship `TextEncoder` or
// `TextDecoder` at this time.
new webpack.ProvidePlugin({
TextDecoder: ['text-encoding', 'TextDecoder'],
TextEncoder: ['text-encoding', 'TextEncoder']
})
],
mode: 'development'
};

```

#### index.js

```js
/* eslint-disable promise/always-return */
/* eslint-disable no-console */
/* eslint-disable promise/catch-or-return */
const rust = import('js-chain-libs');

rust.then(mod => {
const {
OutputPolicy,
TransactionBuilder,
Address,
Input,
Value,
Fee,
TransactionFinalizer,
Fragment,
PrivateKey,
Witness,
SpendingCounter,
Hash,
Account,
// eslint-disable-next-line camelcase
uint8array_to_hex
} = mod;

const txbuilder = new TransactionBuilder();

const accountInputAddress = Address.from_string(
'ca1qh9u0nxmnfg7af8ycuygx57p5xgzmnmgtaeer9xun7hly6mlgt3pj2xk344'
);
const account = Account.from_address(accountInputAddress);

const input = Input.from_account(account, Value.from_str('1000'));

txbuilder.add_input(input);

txbuilder.add_output(
Address.from_string(
'ca1q5nr5pvt9e5p009strshxndrsx5etcentslp2rwj6csm8sfk24a2w3swacn'
),
Value.from_str('500')
);

const feeAlgorithm = Fee.linear_fee(
// constant fee
Value.from_str('20'),
// coefficient
Value.from_str('5'),
// certificate cost
Value.from_str('0')
);

const finalizedTx = txbuilder.finalize(
feeAlgorithm,
OutputPolicy.one(accountInputAddress)
);

const finalizer = new TransactionFinalizer(finalizedTx);

// Sign the transaction
// We need the genesis hash, the transaction id and the input account private key
const genesisHash =
'6a702a181151b772ca0acbdc4d2870ed80c09b626b29fffc2e47abf2330ad0cd';
const txid = finalizer.get_txid();
const privateKey = PrivateKey.from_bech32(
'ed25519e_sk1gz0ff4w444nwejap5shxrllypz5euswq6wn04fffzes02atw99xkd4jn838v3vrfg9eqt7f4sxjlsy0tdcmj0d2dqvwc8ztwgyfnwyszvjg32'
);

const witness = Witness.for_account(
Hash.from_hex(genesisHash),
txid,
privateKey,
SpendingCounter.zero()
);

finalizer.set_witness(0, witness);

const signedTx = finalizer.build();

const readyToSendTx = Fragment.from_generated_transaction(signedTx);

console.log(uint8array_to_hex(readyToSendTx.as_bytes()));
});
```

Now, in that directory, run the two following commands
Check the [wallet example](./examples/wallet/app/utils/wasmWrapper.js) to see how to use this bindings in electron

4. run `npm install` and `npm install js-chain-libs-0.1.0.tgz`.
5. run `npm run serve` and open a browser in `http://localhost:8080/`. The generated transaction should be logged in the console. This is the transaction in its binary format, encoded in hexadecimal. It could be posted as it is to the node via the rest api, for example.
Check the [example faucet](./examples/faucet/server.js) to see how to use this bindings in node.

## Testing

Expand Down