Skip to content
This repository has been archived by the owner on Jul 6, 2022. It is now read-only.

Commit

Permalink
fix: 🐛 manual merge from develop into it this branch
Browse files Browse the repository at this point in the history
  • Loading branch information
shuffledex committed Oct 11, 2019
2 parents bf740a4 + 6d78d7b commit 05b9b96
Show file tree
Hide file tree
Showing 75 changed files with 4,635 additions and 4,931 deletions.
3 changes: 1 addition & 2 deletions .travis.yml
Expand Up @@ -16,6 +16,5 @@ jobs:
node_js: lts/*
script:
- yarn run build:ci
- 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then yarn coveralls; fi'
- 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then yarn jest; fi'
- yarn coveralls
- npm run semantic-release
39 changes: 39 additions & 0 deletions CHANGELOG.md
@@ -1,3 +1,42 @@
# [3.0.0-beta.51](https://github.com/PolymathNetwork/polymath-contract-wrappers/compare/v3.0.0-beta.50@beta...v3.0.0-beta.51@beta) (2019-10-09)


### Bug Fixes

* 🐛 Multi-version support for transactionParams ([0fb4ae7](https://github.com/PolymathNetwork/polymath-contract-wrappers/commit/0fb4ae7))


### chore

* 🤖 Merge master updates ([1025dca](https://github.com/PolymathNetwork/polymath-contract-wrappers/commit/1025dca))


### BREAKING CHANGES

* N
* N

# [3.0.0-beta.50](https://github.com/PolymathNetwork/polymath-contract-wrappers/compare/v3.0.0-beta.49@beta...v3.0.0-beta.50@beta) (2019-10-09)


### Bug Fixes

* 🐛 Decode events at getLogsAsync and SubscribeAsync ([77ab063](https://github.com/PolymathNetwork/polymath-contract-wrappers/commit/77ab063))
* 🐛 Improve multi-version events handling ([8961a73](https://github.com/PolymathNetwork/polymath-contract-wrappers/commit/8961a73))
* 🐛 Move getLogs y subscribe methods to common files ([166800d](https://github.com/PolymathNetwork/polymath-contract-wrappers/commit/166800d))
* 🐛 Restore deleted SecurityTokenRegistry events ([c56a46a](https://github.com/PolymathNetwork/polymath-contract-wrappers/commit/c56a46a))
* 🐛 Typo ([3ac83e9](https://github.com/PolymathNetwork/polymath-contract-wrappers/commit/3ac83e9))
* 🐛 Typo at GTM eventArgs ([7df1437](https://github.com/PolymathNetwork/polymath-contract-wrappers/commit/7df1437))
* 🐛 Typo at USDTieredSTO eventArgs ([1d67d60](https://github.com/PolymathNetwork/polymath-contract-wrappers/commit/1d67d60))


### BREAKING CHANGES

* N
* N
* N
* Y

# [3.0.0-beta.49](https://github.com/PolymathNetwork/polymath-contract-wrappers/compare/v3.0.0-beta.48@beta...v3.0.0-beta.49@beta) (2019-10-03)


Expand Down
Binary file added Polymath.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 15 additions & 5 deletions README.md
@@ -1,3 +1,10 @@
[![Build Status](https://travis-ci.org/PolymathNetwork/polymath-contract-wrappers.svg?branch=master)](https://travis-ci.org/PolymathNetwork/contract-wrappers)
[![Coverage Status](https://coveralls.io/repos/github/PolymathNetwork/polymath-contract-wrappers/badge.svg?branch=master)](https://coveralls.io/github/PolymathNetwork/polymath-contract-wrappers?branch=master)
[![Gitter](https://img.shields.io/badge/chat-gitter-green.svg)](https://gitter.im/PolymathNetwork/Lobby)
[![Telegram](https://img.shields.io/badge/50k+-telegram-blue.svg)](https://gitter.im/PolymathNetwork/Lobby)

![Polymath logo](Polymath.png)

## @polymathnetwork/contract-wrappers

Version 3.0.0 of the Polymath-Core Ethereum Smart Contracts
Expand Down Expand Up @@ -27,6 +34,7 @@ If your project is in [TypeScript](https://www.typescriptlang.org/), add the fol
```

## Documentation

This project uses typedoc documentation style.

You can access these docs by cloning this repo and opening `docs/index.html` in the browser.
Expand All @@ -39,14 +47,14 @@ Commits should follow the [conventional commits](https://www.conventionalcommits

### A note on breaking changes

*Anything* that forcefully changes the way the client interacts with the package is considered a breaking change and should be described in the `BREAKING CHANGE` section of the corresponding commit. This includes (but is not limited to):
_Anything_ that forcefully changes the way the client interacts with the package is considered a breaking change and should be described in the `BREAKING CHANGE` section of the corresponding commit. This includes (but is not limited to):

- Renaming a public function/class/interface/type
- Deleting a public function/class/interface/type
- Changing a public function's argument list in a way that the user needs to rewrite existing calls to it
- Changing a public function's return type

Whatever is written under `BREAKING CHANGES` is literally what will go into the changelog, so please be clear on the messages. For example, if I change the return type of a function called `foo` in class `Bar`, the `BREAKING CHANGE` section of my commit should say something like
Whatever is written under `BREAKING CHANGES` is literally what will go into the changelog, so please be clear on the messages. For example, if I change the return type of a function called `foo` in class `Bar`, the `BREAKING CHANGE` section of my commit should say something like

```
change return type of the `Bar` class's `foo` function from `string` to `number`
Expand Down Expand Up @@ -102,7 +110,7 @@ yarn jest

## Deployment

This package has automatic publishing and versioning via [semantic-release](https://github.com/semantic-release/semantic-release) and forceful use of [conventional commits](https://www.conventionalcommits.org)
This package has automatic publishing and versioning via [semantic-release](https://github.com/semantic-release/semantic-release) and forceful use of [conventional commits](https://www.conventionalcommits.org)

## Sandbox

Expand Down Expand Up @@ -153,7 +161,8 @@ async function getInjectedProviderIfExists(): Promise<Provider> {
return injectedProviderIfExists;
}
```
*Setting up Polymath API for 4 different cases*

_Setting up Polymath API for 4 different cases_

(1) Using Injected Provider (Metamask) to read from the blockchain and publish transactions on the blockchain.

Expand Down Expand Up @@ -222,10 +231,11 @@ const polymathAPI = new PolymathAPI(params);
```

### Module code examples

In the `/examples` directory there are several examples to help developers understand how to use the API within the sandbox.

These examples demonstrate the use of the project's PolymathAPI to get data and publish transactions with Polymath's smart contracts. Register a ticker, generate a new security token and then you can add a module.

When a security token has a module successfully attached, the examples demonstrate how one can work with sto creation, transfer restrictions, permissioning, and directly with the security token.
When a security token has a module successfully attached, the examples demonstrate how one can work with sto creation, transfer restrictions, permissioning, and directly with the security token.

The sandbox code included in the examples demonstrates how to subscribe to events fired from the smart contracts. It also demonstrates how to better catch issues when they happen, during token transfers for instance.
2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "@polymathnetwork/contract-wrappers",
"version": "3.0.0-beta.49",
"version": "3.0.0-beta.51",
"description": "Smart TS wrappers for Polymath smart contracts",
"keywords": [
"polymath",
Expand Down
Expand Up @@ -14,19 +14,6 @@ import {

const EXCLUDED_ADDRESS_LIMIT = 150;

export namespace DividendCheckpointTransactionParams {
export interface ChangeWallet extends ChangeWalletParams {}
export interface SetDefaultExcluded extends SetDefaultExcludedParams {}
export interface SetWithholding extends SetWithholdingParams {}
export interface SetWithholdingFixed extends SetWithholdingFixedParams {}
export interface PushDividendPaymentToAddresses extends PushDividendPaymentToAddressesParams {}
export interface PushDividendPayment extends PushDividendPaymentParams {}
export interface PullDividendPayment extends DividendIndexTxParams {}
export interface ReclaimDividend extends DividendIndexTxParams {}
export interface WithdrawWithholding extends DividendIndexTxParams {}
export interface UpdateDividendDates extends UpdateDividendDatesParams {}
}

/**
* @param dividendIndex Index of the dividend
*/
Expand Down Expand Up @@ -69,22 +56,22 @@ interface InvestorStatus {
/**
* @param wallet Ethereum account address to receive reclaimed dividends and tax
*/
interface ChangeWalletParams extends TxParams {
export interface ChangeWalletParams extends TxParams {
wallet: string;
}

/**
* @param excluded Addresses of investors
*/
interface SetDefaultExcludedParams extends TxParams {
export interface SetDefaultExcludedParams extends TxParams {
excluded: string[];
}

/**
* @param investors Addresses of investors
* @param withholding Withholding tax array for individual investors
*/
interface SetWithholdingParams extends TxParams {
export interface SetWithholdingParams extends TxParams {
investors: string[];
withholding: BigNumber[];
}
Expand All @@ -93,7 +80,7 @@ interface SetWithholdingParams extends TxParams {
* @param investors Addresses of investor
* @param withholding Single withholding tax for all investors
*/
interface SetWithholdingFixedParams extends TxParams {
export interface SetWithholdingFixedParams extends TxParams {
investors: string[];
withholding: BigNumber;
}
Expand All @@ -102,7 +89,7 @@ interface SetWithholdingFixedParams extends TxParams {
* @param dividendIndex Dividend index to push
* @param payees Addresses to which to push the dividend
*/
interface PushDividendPaymentToAddressesParams extends TxParams {
export interface PushDividendPaymentToAddressesParams extends TxParams {
dividendIndex: number;
payees: string[];
}
Expand All @@ -112,7 +99,7 @@ interface PushDividendPaymentToAddressesParams extends TxParams {
* @param start Index in investor list at which to start pushing dividends
* @param end Index in investor list at which to stop pushing dividends
*/
interface PushDividendPaymentParams extends TxParams {
export interface PushDividendPaymentParams extends TxParams {
dividendIndex: number;
start: number;
end: number;
Expand All @@ -121,7 +108,7 @@ interface PushDividendPaymentParams extends TxParams {
/**
* @param dividendIndex Dividend index to use
*/
interface DividendIndexTxParams extends TxParams {
export interface DividendIndexTxParams extends TxParams {
dividendIndex: number;
}

Expand All @@ -130,7 +117,7 @@ interface DividendIndexTxParams extends TxParams {
* @param maturity Updated maturity date
* @param expiry Updated expiry date
*/
interface UpdateDividendDatesParams extends TxParams {
export interface UpdateDividendDatesParams extends TxParams {
dividendIndex: number;
maturity: Date;
expiry: Date;
Expand Down
@@ -1,3 +1,27 @@
import {
ChangeWalletParams,
SetDefaultExcludedParams,
SetWithholdingParams,
SetWithholdingFixedParams,
PushDividendPaymentToAddressesParams,
PushDividendPaymentParams,
DividendIndexTxParams,
UpdateDividendDatesParams,
} from './common';

/* istanbul ignore file */
export { WithDividendCheckpoint_3_0_0 } from './3.0.0';
export { default as DividendCheckpointCommon } from './common';
export { default as DividendCheckpointCommon } from './common';

export namespace DividendCheckpointTransactionParams {
export interface ChangeWallet extends ChangeWalletParams {}
export interface SetDefaultExcluded extends SetDefaultExcludedParams {}
export interface SetWithholding extends SetWithholdingParams {}
export interface SetWithholdingFixed extends SetWithholdingFixedParams {}
export interface PushDividendPaymentToAddresses extends PushDividendPaymentToAddressesParams {}
export interface PushDividendPayment extends PushDividendPaymentParams {}
export interface PullDividendPayment extends DividendIndexTxParams {}
export interface ReclaimDividend extends DividendIndexTxParams {}
export interface WithdrawWithholding extends DividendIndexTxParams {}
export interface UpdateDividendDates extends UpdateDividendDatesParams {}
}

0 comments on commit 05b9b96

Please sign in to comment.