Merge pull request #209 from PolymathNetwork/refactor/rename-sharehol…

…ders-to-tokenholders refactor: rename shareholders to tokenholders
PolymathNetwork · Mar 16, 2020 · 26060df · 26060df
2 parents 550676f + 6ffd416
commit 26060df
Show file tree

Hide file tree

Showing 346 changed files with 3,152 additions and 3,153 deletions.
diff --git a/docs/api/README.md b/docs/api/README.md
@@ -1,4 +1,4 @@
-# @polymathnetwork/sdk - v2.0.1-beta.120
+# @polymathnetwork/sdk - v2.0.1-beta.123
 
 # Getting Started
 

diff --git a/docs/api/SUMMARY.md b/docs/api/SUMMARY.md
diff --git a/docs/api/classes/_context_.context.md b/docs/api/classes/_context_.context.md
@@ -28,7 +28,7 @@ Context in which the SDK is being used
 
 \+ **new Context**(`params`: [ConstructorParams](../interfaces/_context_.constructorparams.md)): *[Context](_context_.context.md)*
 
-*Defined in [src/Context.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/Context.ts#L45)*
+*Defined in [src/Context.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/Context.ts#L45)*
 
 **Parameters:**
 
@@ -44,20 +44,20 @@ Name | Type |
 
 • **contractWrappers**: *[PolymathBase](_polymathbase_.polymathbase.md)*
 
-*Defined in [src/Context.ts:41](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/Context.ts#L41)*
+*Defined in [src/Context.ts:41](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/Context.ts#L41)*
 
 ___
 
 ###  currentWallet
 
 • **currentWallet**: *Wallet*
 
-*Defined in [src/Context.ts:43](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/Context.ts#L43)*
+*Defined in [src/Context.ts:43](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/Context.ts#L43)*
 
 ___
 
 ###  factories
 
 • **factories**: *[Factories](../interfaces/_context_.factories.md)*
 
-*Defined in [src/Context.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/Context.ts#L45)*
+*Defined in [src/Context.ts:45](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/Context.ts#L45)*
diff --git a/docs/api/classes/_entities_checkpoint_.checkpoint.md b/docs/api/classes/_entities_checkpoint_.checkpoint.md
@@ -1,6 +1,6 @@
 # Class: Checkpoint
 
-Represents a snapshot of the Security Token's supply and Shareholder balances at a certain point in time
+Represents a snapshot of the Security Token's supply and Tokenholder balances at a certain point in time
 
 ## Hierarchy
 
@@ -21,7 +21,7 @@ Represents a snapshot of the Security Token's supply and Shareholder balances at
 * [index](_entities_checkpoint_.checkpoint.md#index)
 * [securityTokenId](_entities_checkpoint_.checkpoint.md#securitytokenid)
 * [securityTokenSymbol](_entities_checkpoint_.checkpoint.md#securitytokensymbol)
-* [shareholderBalances](_entities_checkpoint_.checkpoint.md#shareholderbalances)
+* [tokenholderBalances](_entities_checkpoint_.checkpoint.md#tokenholderbalances)
 * [totalSupply](_entities_checkpoint_.checkpoint.md#totalsupply)
 * [uid](_entities_checkpoint_.checkpoint.md#uid)
 
@@ -38,7 +38,7 @@ Represents a snapshot of the Security Token's supply and Shareholder balances at
 
 \+ **new Checkpoint**(`params`: [Params](../interfaces/_entities_checkpoint_.params.md) & [UniqueIdentifiers](../interfaces/_entities_checkpoint_.uniqueidentifiers.md)): *[Checkpoint](_entities_checkpoint_.checkpoint.md)*
 
-*Defined in [src/entities/Checkpoint.ts:106](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/entities/Checkpoint.ts#L106)*
+*Defined in [src/entities/Checkpoint.ts:106](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Checkpoint.ts#L106)*
 
 Create a new Chekpoint instance
 
@@ -56,15 +56,15 @@ Name | Type |
 
 • **createdAt**: *Date*
 
-*Defined in [src/entities/Checkpoint.ts:106](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/entities/Checkpoint.ts#L106)*
+*Defined in [src/entities/Checkpoint.ts:106](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Checkpoint.ts#L106)*
 
 ___
 
 ###  dividendDistributions
 
 • **dividendDistributions**: *[DividendDistribution](_entities_dividenddistribution_.dividenddistribution.md)[]*
 
-*Defined in [src/entities/Checkpoint.ts:88](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/entities/Checkpoint.ts#L88)*
+*Defined in [src/entities/Checkpoint.ts:88](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Checkpoint.ts#L88)*
 
 dividend distributions associated to this snapshot
 
@@ -74,7 +74,7 @@ ___
 
 • **index**: *number*
 
-*Defined in [src/entities/Checkpoint.ts:97](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/entities/Checkpoint.ts#L97)*
+*Defined in [src/entities/Checkpoint.ts:97](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Checkpoint.ts#L97)*
 
 numerical index of the checkpoint associated to this snapshot
 
@@ -84,33 +84,33 @@ ___
 
 • **securityTokenId**: *string*
 
-*Defined in [src/entities/Checkpoint.ts:92](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/entities/Checkpoint.ts#L92)*
+*Defined in [src/entities/Checkpoint.ts:92](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Checkpoint.ts#L92)*
 
 ___
 
 ###  securityTokenSymbol
 
 • **securityTokenSymbol**: *string*
 
-*Defined in [src/entities/Checkpoint.ts:90](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/entities/Checkpoint.ts#L90)*
+*Defined in [src/entities/Checkpoint.ts:90](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Checkpoint.ts#L90)*
 
 ___
 
-###  shareholderBalances
+###  tokenholderBalances
 
-• **shareholderBalances**: *[ShareholderBalance](../interfaces/_types_index_.shareholderbalance.md)[]*
+• **tokenholderBalances**: *[TokenholderBalance](../interfaces/_types_index_.tokenholderbalance.md)[]*
 
-*Defined in [src/entities/Checkpoint.ts:102](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/entities/Checkpoint.ts#L102)*
+*Defined in [src/entities/Checkpoint.ts:102](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Checkpoint.ts#L102)*
 
-shareholder balances at this specific checkpoint
+tokenholder balances at this specific checkpoint
 
 ___
 
 ###  totalSupply
 
 • **totalSupply**: *BigNumber*
 
-*Defined in [src/entities/Checkpoint.ts:104](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/entities/Checkpoint.ts#L104)*
+*Defined in [src/entities/Checkpoint.ts:104](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Checkpoint.ts#L104)*
 
 ___
 
@@ -120,7 +120,7 @@ ___
 
 *Overrides [Entity](_entities_entity_.entity.md).[uid](_entities_entity_.entity.md#abstract-uid)*
 
-*Defined in [src/entities/Checkpoint.ts:83](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/entities/Checkpoint.ts#L83)*
+*Defined in [src/entities/Checkpoint.ts:83](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Checkpoint.ts#L83)*
 
 ## Methods
 
@@ -130,7 +130,7 @@ ___
 
 *Overrides [Entity](_entities_entity_.entity.md).[_refresh](_entities_entity_.entity.md#abstract-_refresh)*
 
-*Defined in [src/entities/Checkpoint.ts:164](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/entities/Checkpoint.ts#L164)*
+*Defined in [src/entities/Checkpoint.ts:164](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Checkpoint.ts#L164)*
 
 Hydrate the entity
 
@@ -150,7 +150,7 @@ ___
 
 *Overrides [Entity](_entities_entity_.entity.md).[toPojo](_entities_entity_.entity.md#abstract-topojo)*
 
-*Defined in [src/entities/Checkpoint.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/entities/Checkpoint.ts#L137)*
+*Defined in [src/entities/Checkpoint.ts:137](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Checkpoint.ts#L137)*
 
 Convert entity to a POJO (Plain Old Javascript Object)
 
@@ -166,7 +166,7 @@ Convert entity to a POJO (Plain Old Javascript Object)
 
 * **securityTokenSymbol**: *string*
 
-* **shareholderBalances**: *[ShareholderBalance](../interfaces/_types_index_.shareholderbalance.md)[]*
+* **tokenholderBalances**: *[TokenholderBalance](../interfaces/_types_index_.tokenholderbalance.md)[]*
 
 * **totalSupply**: *BigNumber*
 
@@ -178,7 +178,7 @@ ___
 
 ▸ **generateId**(`__namedParameters`: object): *string*
 
-*Defined in [src/entities/Checkpoint.ts:58](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/entities/Checkpoint.ts#L58)*
+*Defined in [src/entities/Checkpoint.ts:58](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Checkpoint.ts#L58)*
 
 Generate the Checkpoint's UUID from its identifying properties
 
@@ -199,7 +199,7 @@ ___
 
 ▸ **unserialize**(`serialized`: string): *[UniqueIdentifiers](../interfaces/_entities_checkpoint_.uniqueidentifiers.md)*
 
-*Defined in [src/entities/Checkpoint.ts:70](https://github.com/PolymathNetwork/polymath-sdk/blob/ade5412/src/entities/Checkpoint.ts#L70)*
+*Defined in [src/entities/Checkpoint.ts:70](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/Checkpoint.ts#L70)*
 
 Unserialize string to Checkpoint object