@tokeny/servicing-bridge
v0.1.2
Published
Utilities to deploy tokens and send token according to a list of holders.
Downloads
20
Readme
SERVICING BRIDGE
Set of utilities that serve inputs to the servicing platform.
Features
- [ ] From a list of holders and their wallet: deploy their blockchain Identities (investorID) with the wallet as management key.
- [ ] From a token configuration file: deploy the token contractand set up validator rules if any.
- [ ] From a position report of wallets and identities for an existing token: allocate tokens to designated wallets.
- [ ] From a position report of wallets and identities and a token configuration file: deploy the token contract, set up validator rules if any, and allocate tokens to designated wallets.
- [ ] From a list of holders and their wallet (and eventually and existing identity) a position report with these holders and a token configuration file: deploy the token contract, set up validator rules if any, deploy blockchain identities (investorID) for the holders, issue their claims, and allocate tokens to their wallet.
Usage
const ServicingBridge = require('@tokeny/servicing-bridge');
Transactions
Write operations to BlockChain require a signing module capable of signing transactions.
All write operations method of the ServicingBridge will use the default signing module defined in Config:
const provider = Ethers.getDefaultProvider('ropsten');
const defaultSigner = new Ethers.Wallet('PRIVATE KEY', provider);
ServicingBridge.setSigner(defaultSigner);
You can call any write operation method with a custom signing module in the last option parameter of these methods:
const provider = Ethers.getDefaultProvider('ropsten');
const specificSigner = new Ethers.Wallet('PRIVATE KEY', provider);
const token = new ServicingBridge.Token({ name: 'TOKEN', symbol: 'TKN' });
(async () => {
await token.deploy({ signer: specificSigner })
})();
Development
- Install dependencies with
npm install
- Test with
npm run test
- Build with
npm run build
, it will build documentation and the library package.