Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/klaytn/truffle-hdwallet-provider-klaytn


https://github.com/klaytn/truffle-hdwallet-provider-klaytn

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README 

        
# truffle-hdwallet-provider-klaytn

Forked [email protected] and applied patches for Klaytn network.

It's primary usage is deploying contracts and interacting with them in Klaytn network when using Truffle framework.



## Install



```

$ npm install truffle-hdwallet-provider-klaytn

```



## Requirements

```

Node v12.20 or later

caver-js v1.6.3 or later

```



## General Usage



You can use this provider wherever a Web3 provider is needed, not just in Truffle. For Truffle-specific usage, see next section.



```javascript

const HDWalletProvider = require("truffle-hdwallet-provider-klaytn");

const Caver = require("caver-js");

const mnemonic = "mountains supernatural bird..."; // 12 word mnemonic

let provider = new HDWalletProvider({

  mnemonic: {

    phrase: mnemonicPhrase

  },

  providerOrUrl: "http://localhost:8545"

});



// Or, alternatively pass in a zero-based address index.

provider = new HDWalletProvider({

  mnemonic: mnemonicPhrase,

  providerOrUrl: "http://localhost:8545",

  addressIndex: 5

});



// Or, use your own hierarchical derivation path

provider = new HDWalletProvider({

  mnemonic: mnemonicPhrase,

  providerOrUrl: "http://localhost:8545",

  numberOfAddresses: 1,

  shareNonce: true,

  derivationPath: "m/44'/137'/0'/0/"

});



// To make HDWallet less "chatty" over JSON-RPC,

// configure a higher value for the polling interval.

provider = new HDWalletProvider({

  mnemonic: {

    phrase: mnemonicPhrase

  },

  providerOrUrl: "http://localhost:8545",

  pollingInterval: 8000

});



// HDWalletProvider is compatible with Caver.

const caver = new Caver(provider);



// ...

// Write your code here.

// ...



// At termination, `provider.engine.stop()' should be called to finish the process elegantly.

provider.engine.stop();

```



By default, the `HDWalletProvider` will use the address of the first address that's generated from the mnemonic. If you pass in a specific index, it'll use that address instead.



Parameters:



| Parameter | Type | Default | Required | Description |

| ------ | ---- | ------- | ----------- | ----------- |

| `mnemonic` | `object\|string` | `null` | [ ] | Object containing `phrase` and `password` (optional) properties. `phrase` is a 12 word mnemonic string which addresses are created from. Alternately the value for mnemonic can be a string with your mnemonic phrase. |

| `privateKeys` | `string[]` | `null` | [ ] | Array containing 1 or more private keys. |

| `providerOrUrl` | `string\|object` | `null` | [x] | URI or Ethereum client to send all other non-transaction-related Web3 requests |

| `addressIndex` | `number` | `0` | [ ] | If specified, will tell the provider to manage the address at the index specified |

| `numberOfAddresses` | `number` | `1` | [ ] | If specified, will create `numberOfAddresses` addresses when instantiated |

| `shareNonce` | `boolean` | `true` | [ ] | If `false`, a new WalletProvider will track its own nonce-state |

| `derivationPath` | `string` | `"m/44'/60'/0'/0/"` | [ ] | If specified, will tell the wallet engine what derivation path should use to derive addresses. |

| `pollingInterval` | `number` | `4000` | [ ] | If specified, will tell the wallet engine to use a custom interval when polling to track blocks. Specified in milliseconds. |

| `chainId` | `number/|string` | `undefined` | [ ] | Specify to enable signed transactions that are EIP-155 compliant for major chains. |



### Private Keys



Instead of a mnemonic, you can alternatively provide a private key or array of private keys as the first parameter. When providing an array, `address_index` and `num_addresses` are fully supported.



```javascript

const HDWalletProvider = require("truffle-hdwallet-provider-klaytn");

//load single private key as string

let provider = new HDWalletProvider("3f841bf589fdf83a521e55d51afddc34fa65351161eead24f064855fc29c9580", "http://localhost:8551");



// Or, pass an array of private keys, and optionally use a certain subset of addresses

const privateKeys = [

  "3f841bf589fdf83a521e55d51afddc34fa65351161eead24f064855fc29c9580",

  "9549f39decea7b7504e15572b2c6a72766df0281cea22bd1a3bc87166b1ca290",

];

provider = new HDWalletProvider(privateKeys, "http://localhost:8551", 0, 2); //start at address_index 0 and load both addresses

```

**NOTE: This is just an example. NEVER hard code production/mainnet private keys in your code or commit them to git. They should always be loaded from environment variables or a secure secret management system.**



## Truffle Usage



You can easily use this within a Truffle configuration. For instance:



truffle-config.js

```javascript

const HDWalletProvider = require("truffle-hdwallet-provider-klaytn");



const mnemonic = "mountains supernatural bird ...";



module.exports = {

  networks: {

    development: {

      host: "localhost",

      port: 8551,

      network_id: "*" // Match any network id

    },

    klaytn: {

      provider: () => {

        const pks = JSON.parse(fs.readFileSync(path.resolve(__dirname)+'/privateKeys.js'))



        return new HDWalletProvider(pks, "http://localhost:8551", 0, pks.length)

      },

      network_id: '1001', //Klaytn baobab testnet's network id

      gas: '8500000',

      gasPrice: null

    },

    kasBaobab: {

      provider: () => {

        const option = {

          headers: [

            { name: 'Authorization', value: 'Basic ' + Buffer.from(accessKeyId + ':' + secretAccessKey).toString('base64') },

            { name: 'x-chain-id', value: '1001' }

          ],

          keepAlive: false,

        }

        return new HDWalletProvider(privateKey, new Caver.providers.HttpProvider("https://node-api.klaytnapi.com/v1/klaytn", option))

      },

      network_id: '1001', //Klaytn baobab testnet's network id

      gas: '8500000',

      gasPrice:'25000000000'

    },

    kasCypress: {

      provider: () => {

        const option = {

          headers: [

            { name: 'Authorization', value: 'Basic ' + Buffer.from(accessKeyId + ':' + secretAccessKey).toString('base64') },

            { name: 'x-chain-id', value: '8217' }

          ],

          keepAlive: false,

        }

        return new HDWalletProvider(cypressPrivateKey, new Caver.providers.HttpProvider("https://node-api.klaytnapi.com/v1/klaytn", option))

      },

      network_id: '8217', //Klaytn baobab testnet's network id

      gas: '8500000',

      gasPrice:'25000000000'

    },

    baobab: {

      provider: () => { return new HDWalletProvider(privateKey, "http://your.baobab.en:8551") },

      network_id: '1001', //Klaytn baobab testnet's network id

      gas: '8500000',

      gasPrice: null

    },

    cypress: {

      provider: () => { return new HDWalletProvider(privateKey, "http://your.cypress.en:8551") },

      network_id: '8217', //Klaytn mainnet's network id

      gas: '8500000',

      gasPrice: null

    }

  }

};

```