@superfluid-finance/sdk-core 0.1.1-dev.86e9998.0 → 0.1.1-dev.d7f58c8.0

package/README.md

@@ -37,12 +37,24 @@ yarn install && yarn build
 
 Here is a quick look at initializing the SDK in different environments:
 
-TypeScript / JavaScript (Module):
+TypeScript / JavaScript (Module) vs. JavaScript (CommonJS) - usually a Node.js environment
 
+The primary difference between the two environments is the import/require of the sdk-core package, everything else is the same.
+
+TS/ESModule
 ```ts
 import { Framework } from "@superfluid-finance/sdk-core";
 import { ethers } from "ethers";
+```
 
+CommonJS/Node.js
+```js
+const { Framework } = require("@superfluid-finance/sdk-core");
+const { ethers } = require("ethers");
+```
+
+```ts
+// infura provider initialization
 const provider = new ethers.providers.InfuraProvider(
   "matic",
   "<INFURA_API_KEY>"
@@ -60,31 +72,45 @@ const web3jsSf = await Framework.create({
   networkName: "matic",
   provider: web3jsProvider
 });
-```
 
-JavaScript (CommonJS) - usually a Node.js environment:
-
-```js
-const { Framework } = require("@superfluid-finance/sdk-core");
-const { ethers } = require("ethers");
-
-const provider = new ethers.providers.InfuraProvider(
-  "matic",
-  "<INFURA_API_KEY>"
-);
-const sf = await Framework.create({
+// ethers.js + hardhat provider initialization (in testing environment w/ hardhat-ethers)
+const [deployer] = await ethers.getSigners();
+const ethersProvider = deployer.provider;
+const ethersjsSf = await Framework.create({
   networkName: "matic",
-  provider
+  provider: ethersProvider
 });
 
-// web3.js + Hardhat provider initialization
-const web3jsProvider = new ethers.providers.Web3Provider(
-  global.web3.currentProvider
-);
-const web3jsSf = await Framework.create({
+// metamask
+const mmProvider = new ethers.providers.Web3Provider(window.ethereum);
+const mmSf = await Framework.create({
   networkName: "matic",
-  provider: web3jsProvider
+  provider: mmProvider
 });
+
+// web3modal
+const web3ModalRawProvider = await web3Modal.connect();
+const web3ModalProvider = new ethers.providers.Web3Provider(web3ModalRawProvider);
+const web3ModalSf = await Framework.create({
+  networkName: "matic",
+  provider: web3ModalProvider
+});
+
+//bnc-onboard
+const onboard = Onboard({
+    dappId: "<API_KEY>",
+    networkId: 4,
+    subscriptions: {
+        wallet: wallet => {
+            const web3Provider = new ethers.providers.Web3Provider(wallet.provider);
+            (async () => {
+                const framework = await Framework.create({ networkName: "matic", provider: web3Provider });
+            })();
+        }
+    }
+});
+// this is triggered by:
+await onboard.walletSelect();
 ```
 
 > Note: You specify your project type in `package.json` - `"type": "module"` or `"type": "commonjs"`.
@@ -229,11 +255,11 @@ const sf = await Framework.create({
   provider: web3ModalProvider,
 });
 
-const web3ModalSigner = sf.createSigner(web3ModalProvider);
+const web3ModalSigner = sf.createSigner({ web3Provider: web3ModalProvider });
 
 // MetaMask example
 const metamaskProvider = new Web3Provider(window.ethereum);
-const metaMaskSigner = sf.createSigner(metamaskProvider);
+const metaMaskSigner = sf.createSigner({ web3Provider: metamaskProvider });
 ```
 
 #### Hardhat Signer Example
@@ -278,9 +304,7 @@ const sf = await Framework.create({
   provider,
 });
 
-const signer = sf.createSigner({
-  signer: wallet
-});
+const signer = sf.createSigner({ signer: wallet });
 ```
 
 ### Operation
@@ -786,18 +810,19 @@ const sf = await Framework.create({
   provider
 });
  
- // 0xabc is the signer
+ // 0xabc is the signer on Rinkeby testnet
 const signer = sf.createSigner({ privateKey: "<TEST_ACCOUNT_PRIVATE_KEY>", provider });
-const usdcx = sf.loadToken("0xCAa7349CEA390F89641fe306D93591f87595dc1F");
-const approveOp = usdcx.approve({ receiver: "0xdef", amount: "10000" });
-const transferFromOp = usdcx.transferFrom({
-    sender: "0xabc",
-    receiver: "0xdef",
-    amount: "10000",
-});
-const batchCall = framework.batchCall([approveOp, transferFromOp]);
-const txn = await batchCall.execute(signer);
-
+const daix = await sf.loadSuperToken("0x745861AeD1EEe363b4AaA5F1994Be40b1e05Ff90");
+const fromAddress = "0xabc";
+const paymentAddress = "0xdef";
+const approveOp = daix.approve({ receiver: paymentAddress, amount: "10000" });
+const transferFromOp = daix.transferFrom({
+  sender: fromAddress,
+  receiver: paymentAddress,
+  amount: "10000",
+});
+const batchCall = sf.batchCall([approveOp, transferFromOp]);
+const txn = await batchCall.exec(signer);
 
 // creating an operation from a super app function
 // initialize your super app contract

package/dist/main/BatchCall.d.ts

@@ -1,7 +1,7 @@
 import { ethers } from "ethers";
 import Host from "./Host";
-import { IConfig } from "./interfaces";
 import Operation from "./Operation";
+import { IConfig } from "./interfaces";
 interface IBatchCallOptions {
     config: IConfig;
     operations: ReadonlyArray<Operation>;

package/dist/main/ConstantFlowAgreementV1.d.ts

@@ -1,6 +1,6 @@
-import { IAgreementV1Options, ICreateFlowParams, IDeleteFlowParams, IUpdateFlowParams, IGetFlowParams, IGetAccountFlowInfoParams, IWeb3FlowInfoParams, IWeb3FlowInfo } from "./interfaces";
-import Operation from "./Operation";
 import Host from "./Host";
+import Operation from "./Operation";
+import { IAgreementV1Options, ICreateFlowParams, IDeleteFlowParams, IGetAccountFlowInfoParams, IGetFlowParams, IUpdateFlowParams, IWeb3FlowInfo, IWeb3FlowInfoParams } from "./interfaces";
 /**
  * @dev Constant Flow Agreement V1 Helper Class
  * @description A helper class to interact with the CFAV1 contract.

package/dist/main/Framework.d.ts

@@ -1,14 +1,14 @@
-import { ethers } from "ethers";
 import { Signer } from "@ethersproject/abstract-signer";
-import { IConfig, ISignerConstructorOptions } from "./interfaces";
-import { DataMode } from "./types";
+import { ethers } from "ethers";
 import BatchCall from "./BatchCall";
 import ConstantFlowAgreementV1 from "./ConstantFlowAgreementV1";
 import Host from "./Host";
 import InstantDistributionAgreementV1 from "./InstantDistributionAgreementV1";
-import SuperToken from "./SuperToken";
-import Query from "./Query";
 import Operation from "./Operation";
+import Query from "./Query";
+import SuperToken from "./SuperToken";
+import { IConfig, ISignerConstructorOptions } from "./interfaces";
+import { DataMode } from "./types";
 export interface IFrameworkOptions {
     chainId?: number;
     customSubgraphQueriesEndpoint?: string;

package/dist/main/InstantDistributionAgreementV1.d.ts

@@ -1,6 +1,6 @@
-import { IAgreementV1Options, IBaseIDAParams, IBaseSubscriptionParams, IDistributeParams, IGetIndexParams, IGetSubscriptionParams, IUpdateIndexValueParams, IUpdateSubscriptionUnitsParams, IWeb3Index, IWeb3Subscription } from "./interfaces";
-import Operation from "./Operation";
 import Host from "./Host";
+import Operation from "./Operation";
+import { IAgreementV1Options, IBaseIDAParams, IBaseSubscriptionParams, IDistributeParams, IGetIndexParams, IGetSubscriptionParams, IUpdateIndexValueParams, IUpdateSubscriptionUnitsParams, IWeb3Index, IWeb3Subscription } from "./interfaces";
 /**
  * @dev Instant Distribution Agreement V1 Helper Class
  * @description A helper class to interact with the IDAV1 contract.

package/dist/main/Query.d.ts

@@ -1,9 +1,9 @@
-import { IAccountTokenSnapshotFilter, IIndex, IIndexRequestFilter, IIndexSubscription, IIndexSubscriptionRequestFilter, ILightAccountTokenSnapshot, ILightEntity, IStream, IStreamRequestFilter, ISuperToken, ISuperTokenRequestFilter } from "./interfaces";
-import { DataMode } from "./types";
-import { PagedResult, Paging } from "./pagination";
 import { AllEvents, IEventFilter } from "./events";
+import { IAccountTokenSnapshotFilter, IIndex, IIndexRequestFilter, IIndexSubscription, IIndexSubscriptionRequestFilter, ILightAccountTokenSnapshot, ILightEntity, IStream, IStreamRequestFilter, ISuperToken, ISuperTokenRequestFilter } from "./interfaces";
 import { Ordering } from "./ordering";
+import { PagedResult, Paging } from "./pagination";
 import { AccountTokenSnapshot_OrderBy, Event_OrderBy, Index_OrderBy, IndexSubscription_OrderBy, Stream_OrderBy, Token_OrderBy } from "./subgraph/schema.generated";
+import { DataMode } from "./types";
 export interface IQueryOptions {
     readonly customSubgraphQueriesEndpoint: string;
     readonly dataMode: DataMode;

package/dist/main/SuperToken.d.ts

@@ -1,9 +1,9 @@
 import { ethers } from "ethers";
-import { IConfig, IRealtimeBalanceOfParams, ISuperTokenBaseIDAParams, ISuperTokenCreateFlowParams, ISuperTokenDeleteFlowParams, ISuperTokenDistributeParams, ISuperTokenGetFlowInfoParams, ISuperTokenGetFlowParams, ISuperTokenGetIndexParams, ISuperTokenGetSubscriptionParams, ISuperTokenPublisherOperationParams, ISuperTokenPubSubParams, ISuperTokenUpdateFlowParams, ISuperTokenUpdateIndexValueParams, ISuperTokenUpdateSubscriptionUnitsParams, IWeb3FlowInfo, IWeb3Index, IWeb3RealTimeBalanceOf, IWeb3Subscription } from "./interfaces";
-import Operation from "./Operation";
 import ConstantFlowAgreementV1 from "./ConstantFlowAgreementV1";
 import InstantDistributionAgreementV1 from "./InstantDistributionAgreementV1";
+import Operation from "./Operation";
 import Token from "./Token";
+import { IConfig, IRealtimeBalanceOfParams, ISuperTokenBaseIDAParams, ISuperTokenCreateFlowParams, ISuperTokenDeleteFlowParams, ISuperTokenDistributeParams, ISuperTokenGetFlowInfoParams, ISuperTokenGetFlowParams, ISuperTokenGetIndexParams, ISuperTokenGetSubscriptionParams, ISuperTokenPublisherOperationParams, ISuperTokenPubSubParams, ISuperTokenUpdateFlowParams, ISuperTokenUpdateIndexValueParams, ISuperTokenUpdateSubscriptionUnitsParams, IWeb3FlowInfo, IWeb3Index, IWeb3RealTimeBalanceOf, IWeb3Subscription } from "./interfaces";
 export interface ITokenSettings {
     readonly address: string;
     readonly config: IConfig;

package/dist/main/Token.d.ts

@@ -1,6 +1,6 @@
 import { ethers } from "ethers";
-import { IBaseSuperTokenParams, ITransferFromParams } from "./interfaces";
 import Operation from "./Operation";
+import { IBaseSuperTokenParams, ITransferFromParams } from "./interfaces";
 export default class Token {
     readonly address: string;
     constructor(address: string);

package/dist/main/constants.d.ts

@@ -1,9 +1,16 @@
 import { IResolverData } from "./interfaces";
 export declare const MONTHS_PER_YEAR = 12;
 export declare const DAYS_PER_MONTH = 30;
+export declare const DAYS_PER_WEEK = 7;
 export declare const HOURS_PER_DAY = 24;
 export declare const MINUTES_PER_HOUR = 60;
-export declare const SECONDS_PER_MINUTE = 60;
+export declare const MINUTE_IN_SECONDS = 60;
+export declare const HOUR_IN_SECONDS: number;
+export declare const DAY_IN_SECONDS: number;
+export declare const WEEK_IN_SECONDS: number;
+export declare const MONTH_IN_SECONDS: number;
+export declare const YEAR_IN_SECONDS: number;
+export declare const BASE_18 = 10000000000000000000;
 export declare const chainIds: number[];
 export declare const networkNames: string[];
 export declare const chainIdToDataMap: Map<number, IResolverData>;

package/dist/main/index.d.ts

@@ -1,10 +1,10 @@
-import Framework from "./Framework";
-import SuperToken from "./SuperToken";
-import Query from "./Query";
+import BatchCall from "./BatchCall";
 import ConstantFlowAgreementV1 from "./ConstantFlowAgreementV1";
-import InstantDistributionAgreementV1 from "./InstantDistributionAgreementV1";
+import Framework from "./Framework";
 import Host from "./Host";
-import BatchCall from "./BatchCall";
+import InstantDistributionAgreementV1 from "./InstantDistributionAgreementV1";
+import Query from "./Query";
+import SuperToken from "./SuperToken";
 export * from "./interfaces";
 export * from "./utils";
 export * from "./pagination";