lib-ethers: Clean up connection API

Too much of the internals was exposed before.
liquity · Feb 4, 2021 · a2bae97 · a2bae97
1 parent efab816
commit a2bae97
Show file tree

Hide file tree

Showing 70 changed files with 583 additions and 856 deletions.
diff --git a/docs/sdk/lib-base.redemptiondetails.collateraltaken.md b/docs/sdk/lib-base.redemptiondetails.collateraltaken.md
@@ -4,7 +4,7 @@
 
 ## RedemptionDetails.collateralTaken property
 
-Amount of collateral (e.g. Ether) taken from troves by the transaction.
+Amount of collateral (e.g. Ether) taken from Troves by the transaction.
 
 <b>Signature:</b>
 

diff --git a/docs/sdk/lib-base.redemptiondetails.md b/docs/sdk/lib-base.redemptiondetails.md
@@ -18,6 +18,6 @@ export interface RedemptionDetails
 |  --- | --- | --- |
 |  [actualLUSDAmount](./lib-base.redemptiondetails.actuallusdamount.md) | [Decimal](./decimal.decimal.md) | Amount of LUSD that was actually redeemed by the transaction. |
 |  [attemptedLUSDAmount](./lib-base.redemptiondetails.attemptedlusdamount.md) | [Decimal](./decimal.decimal.md) | Amount of LUSD the redeemer tried to redeem. |
-|  [collateralTaken](./lib-base.redemptiondetails.collateraltaken.md) | [Decimal](./decimal.decimal.md) | Amount of collateral (e.g. Ether) taken from troves by the transaction. |
+|  [collateralTaken](./lib-base.redemptiondetails.collateraltaken.md) | [Decimal](./decimal.decimal.md) | Amount of collateral (e.g. Ether) taken from Troves by the transaction. |
 |  [fee](./lib-base.redemptiondetails.fee.md) | [Decimal](./decimal.decimal.md) | Amount of native currency (e.g. Ether) deducted as fee from collateral taken. |
 
diff --git a/docs/sdk/lib-ethers.addressesof.md b/docs/sdk/lib-ethers.addressesof.md
diff --git a/docs/sdk/lib-ethers.connectedliquitydeployment.addresses.md b/docs/sdk/lib-ethers.connectedliquitydeployment.addresses.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@liquity/lib-ethers](./lib-ethers.md) &gt; [ConnectedLiquityDeployment](./lib-ethers.connectedliquitydeployment.md) &gt; [addresses](./lib-ethers.connectedliquitydeployment.addresses.md)
+
+## ConnectedLiquityDeployment.addresses property
+
+<b>Signature:</b>
+
+```typescript
+readonly addresses: Record<string, string>;
+```
diff --git a/docs/sdk/lib-ethers.connectedliquitydeployment.deploymentdate.md b/docs/sdk/lib-ethers.connectedliquitydeployment.deploymentdate.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@liquity/lib-ethers](./lib-ethers.md) &gt; [ConnectedLiquityDeployment](./lib-ethers.connectedliquitydeployment.md) &gt; [deploymentDate](./lib-ethers.connectedliquitydeployment.deploymentdate.md)
+
+## ConnectedLiquityDeployment.deploymentDate property
+
+<b>Signature:</b>
+
+```typescript
+readonly deploymentDate: number;
+```
diff --git a/docs/sdk/lib-ethers.connectedliquitydeployment.md b/docs/sdk/lib-ethers.connectedliquitydeployment.md
@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@liquity/lib-ethers](./lib-ethers.md) &gt; [ConnectedLiquityDeployment](./lib-ethers.connectedliquitydeployment.md)
+
+## ConnectedLiquityDeployment interface
+
+<b>Signature:</b>
+
+```typescript
+export interface ConnectedLiquityDeployment 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [addresses](./lib-ethers.connectedliquitydeployment.addresses.md) | Record&lt;string, string&gt; |  |
+|  [deploymentDate](./lib-ethers.connectedliquitydeployment.deploymentdate.md) | number |  |
+|  [signerOrProvider](./lib-ethers.connectedliquitydeployment.signerorprovider.md) | Signer \| Provider |  |
+|  [version](./lib-ethers.connectedliquitydeployment.version.md) | string |  |
+
diff --git a/docs/sdk/lib-ethers.connectedliquitydeployment.signerorprovider.md b/docs/sdk/lib-ethers.connectedliquitydeployment.signerorprovider.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@liquity/lib-ethers](./lib-ethers.md) &gt; [ConnectedLiquityDeployment](./lib-ethers.connectedliquitydeployment.md) &gt; [signerOrProvider](./lib-ethers.connectedliquitydeployment.signerorprovider.md)
+
+## ConnectedLiquityDeployment.signerOrProvider property
+
+<b>Signature:</b>
+
+```typescript
+readonly signerOrProvider: Signer | Provider;
+```
diff --git a/docs/sdk/lib-ethers.connectedliquitydeployment.version.md b/docs/sdk/lib-ethers.connectedliquitydeployment.version.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@liquity/lib-ethers](./lib-ethers.md) &gt; [ConnectedLiquityDeployment](./lib-ethers.connectedliquitydeployment.md) &gt; [version](./lib-ethers.connectedliquitydeployment.version.md)
+
+## ConnectedLiquityDeployment.version property
+
+<b>Signature:</b>
+
+```typescript
+readonly version: string;
+```
diff --git a/docs/sdk/lib-ethers.connecttocontracts.md b/docs/sdk/lib-ethers.connecttocontracts.md
diff --git a/docs/sdk/lib-ethers.connecttoliquity.md b/docs/sdk/lib-ethers.connecttoliquity.md
@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@liquity/lib-ethers](./lib-ethers.md) &gt; [connectToLiquity](./lib-ethers.connecttoliquity.md)
+
+## connectToLiquity() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function connectToLiquity(signerOrProvider: Signer | Provider, network?: string | number): ConnectedLiquityDeployment;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  signerOrProvider | Signer \| Provider |  |
+|  network | string \| number |  |
+
+<b>Returns:</b>
+
+[ConnectedLiquityDeployment](./lib-ethers.connectedliquitydeployment.md)
+
diff --git a/docs/sdk/lib-ethers.deploymentonnetwork.md b/docs/sdk/lib-ethers.deploymentonnetwork.md
diff --git a/docs/sdk/lib-ethers.dev_chain_id.md b/docs/sdk/lib-ethers.dev_chain_id.md
diff --git a/docs/sdk/lib-ethers.ethersliquity.connect.md b/docs/sdk/lib-ethers.ethersliquity.connect.md
@@ -7,15 +7,15 @@
 <b>Signature:</b>
 
 ```typescript
-static connect(deployment: LiquityDeployment, signer: Signer): Promise<EthersLiquity>;
+static connect(signer: Signer, network?: string | number): Promise<EthersLiquity>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  deployment | [LiquityDeployment](./lib-ethers.liquitydeployment.md) |  |
 |  signer | Signer |  |
+|  network | string \| number |  |
 
 <b>Returns:</b>
 

diff --git a/docs/sdk/lib-ethers.ethersliquity.from.md b/docs/sdk/lib-ethers.ethersliquity.from.md
diff --git a/docs/sdk/lib-ethers.ethersliquity.md b/docs/sdk/lib-ethers.ethersliquity.md
@@ -30,6 +30,5 @@ export declare class EthersLiquity extends GluedEthersLiquity
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [connect(deployment, signer)](./lib-ethers.ethersliquity.connect.md) | <code>static</code> |  |
-|  [from(contracts, signer, userAddress)](./lib-ethers.ethersliquity.from.md) | <code>static</code> |  |
+|  [connect(signer, network)](./lib-ethers.ethersliquity.connect.md) | <code>static</code> |  |
 
diff --git a/docs/sdk/lib-ethers.liquitycontractabis.md b/docs/sdk/lib-ethers.liquitycontractabis.md
diff --git a/docs/sdk/lib-ethers.liquitycontractaddresses.md b/docs/sdk/lib-ethers.liquitycontractaddresses.md
diff --git a/docs/sdk/lib-ethers.liquitycontracts.activepool.md b/docs/sdk/lib-ethers.liquitycontracts.activepool.md
diff --git a/docs/sdk/lib-ethers.liquitycontracts.borroweroperations.md b/docs/sdk/lib-ethers.liquitycontracts.borroweroperations.md
diff --git a/docs/sdk/lib-ethers.liquitycontracts.collsurpluspool.md b/docs/sdk/lib-ethers.liquitycontracts.collsurpluspool.md
diff --git a/docs/sdk/lib-ethers.liquitycontracts.communityissuance.md b/docs/sdk/lib-ethers.liquitycontracts.communityissuance.md
diff --git a/docs/sdk/lib-ethers.liquitycontracts.defaultpool.md b/docs/sdk/lib-ethers.liquitycontracts.defaultpool.md
diff --git a/docs/sdk/lib-ethers.liquitycontracts.gaspool.md b/docs/sdk/lib-ethers.liquitycontracts.gaspool.md
diff --git a/docs/sdk/lib-ethers.liquitycontracts.hinthelpers.md b/docs/sdk/lib-ethers.liquitycontracts.hinthelpers.md
diff --git a/docs/sdk/lib-ethers.liquitycontracts.lockupcontractfactory.md b/docs/sdk/lib-ethers.liquitycontracts.lockupcontractfactory.md
diff --git a/docs/sdk/lib-ethers.liquitycontracts.lqtystaking.md b/docs/sdk/lib-ethers.liquitycontracts.lqtystaking.md
diff --git a/docs/sdk/lib-ethers.liquitycontracts.lqtytoken.md b/docs/sdk/lib-ethers.liquitycontracts.lqtytoken.md
diff --git a/docs/sdk/lib-ethers.liquitycontracts.lusdtoken.md b/docs/sdk/lib-ethers.liquitycontracts.lusdtoken.md