@kosu/create-portal-helper v0.2.1

Create

Kind: global class

• Create
  • new Create()
  • .init()
  • .createAndSignOrder(options)
  • .signAndPost(signedZeroExOrder)
  • .convertToWei(etherAmount) ⇒ Promise.<string>
  • .convertFromWei(weiAmount) ⇒ Promise.<string>
  • .isValidAddress(address) ⇒ boolean
  • .userHasBond(userAddress) ⇒ Promise.<boolean>
  • .awaitTransactionSuccessOrThrow(txID) ⇒
  • .getUserWethBalance(userAddress) ⇒ Promise.<BigNumber>
  • .getUserWethAllowance(userAddress) ⇒ Promise.<BigNumber>
  • .setProxyAllowanceWeth(userAddress) ⇒ string
  • .getUserZrxBalance(userAddress) ⇒ Promise.<BigNumber>
  • .getUserZrxAllowance(userAddress) ⇒ Promise.<BigNumber>
  • .setProxyAllowanceZrx(userAddress) ⇒ Promise.<string>
  • .getUserDaiBalance(userAddress) ⇒ Promise.<BigNumber>
  • .getUserDaiAllowance(userAddress) ⇒ Promise.<BigNumber>
  • .setProxyAllowanceDai(userAddress) ⇒ Promise.<string>
  • .getUserCustomBalance(tokenAddress, userAddress) ⇒ Promise.<BigNumber>
  • .getUserCustomAllowance(tokenAddress, userAddress) ⇒ Promise.<BigNumber>
  • .setProxyAllowanceCustom(tokenAddress, userAddress) ⇒ Promise.<string>

new Create()

create.init()

Kind: instance method of Create

create.createAndSignOrder(options)

Kind: instance method of Create

Example

// create an order for 0.5 WETH <> 80 custom token, valid for 10 minutes
let order = await create.createAndSignOrder({
    makerAssetAddress: "WETH",
    takerAssetAddress: "0x9f8f72aa9304c8b593d555f12ef6589cc3a579a2",
    makerAssetAmount: create.convertToWei("0.5"),
    takerAssetAmount: create.convertToWei("80"),
    orderDuration: 600,
});

create.signAndPost(signedZeroExOrder)

Kind: instance method of Create
Todo:: - undo split-network ugly-ness

• don't pull makerArguments from subcontract if provided
• ability to use direct kosu.js to sign

create.convertToWei(etherAmount) ⇒ Promise.<string>

Kind: instance method of Create
Returns: Promise.<string> - the same amount in wei

Example

// convert 100 tokens (as entered by user) to wei
create.convertToWei("100"); // > "100000000000000000000" (BigNumber)
create.convertToWei(100); // > "100000000000000000000" (BigNumber)

create.convertFromWei(weiAmount) ⇒ Promise.<string>

Kind: instance method of Create
Returns: Promise.<string> - the same amount in ether

Example

// convert 100 tokens (as received as balance or allowance) to tokens
create.convertToWei("100000000000000000000"); // > "100" (BigNumber)
create.convertToWei(100000000000000000000); // > "100" (BigNumber)

create.isValidAddress(address) ⇒ boolean

Kind: instance method of Create
Returns: boolean - true if valid Ethereum address, otherwise false

Example

create.isValidAddress("0x4f833a24e1f95d70f028921e27040ca56e09ab0b"); // > true
create.isValidAddress("4f833a24e1f95d70f028921e27040ca56e09ab0b"); // > false
create.isValidAddress("0x4f833a24e1f95d70f028921e27040ca56e09ab0"); // > false

create.userHasBond(userAddress) ⇒ Promise.<boolean>

Kind: instance method of Create
Returns: Promise.<boolean> - true if user has active bond, false otherwise

create.awaitTransactionSuccessOrThrow(txID) ⇒

Kind: instance method of Create
Returns: the full decoded transaction receipt (usually will not need)

Example

const txId = await create.setProxyAllowanceWeth();

// wait for the transaction to be mined, show loading icon, etc.
await create.awaitTransactionSuccessOrThrow(txId);

create.getUserWethBalance(userAddress) ⇒ Promise.<BigNumber>

Kind: instance method of Create
Returns: Promise.<BigNumber> - the user's WETH balance in wei

create.getUserWethAllowance(userAddress) ⇒ Promise.<BigNumber>

Kind: instance method of Create
Returns: Promise.<BigNumber> - the user's 0x proxy WETH allowance in wei

create.setProxyAllowanceWeth(userAddress) ⇒ string

Kind: instance method of Create
Returns: string - the transaction hash of the resulting tx

create.getUserZrxBalance(userAddress) ⇒ Promise.<BigNumber>

Kind: instance method of Create
Returns: Promise.<BigNumber> - the user's ZRX balance in wei

create.getUserZrxAllowance(userAddress) ⇒ Promise.<BigNumber>

Kind: instance method of Create
Returns: Promise.<BigNumber> - the user's 0x proxy ZRX allowance in wei

create.setProxyAllowanceZrx(userAddress) ⇒ Promise.<string>

Kind: instance method of Create
Returns: Promise.<string> - the transaction hash of the resulting tx

create.getUserDaiBalance(userAddress) ⇒ Promise.<BigNumber>

Kind: instance method of Create
Returns: Promise.<BigNumber> - the user's DAI balance in wei

create.getUserDaiAllowance(userAddress) ⇒ Promise.<BigNumber>

Kind: instance method of Create
Returns: Promise.<BigNumber> - the user's 0x proxy DAI allowance in wei

create.setProxyAllowanceDai(userAddress) ⇒ Promise.<string>

Kind: instance method of Create
Returns: Promise.<string> - the transaction hash of the resulting tx

create.getUserCustomBalance(tokenAddress, userAddress) ⇒ Promise.<BigNumber>

Kind: instance method of Create
Returns: Promise.<BigNumber> - the user's balance in wei of custom token

Example

const balance = await create.getUserCustomBalance("0x4f833a24e1f95d70f028921e27040ca56e09ab0b");

create.getUserCustomAllowance(tokenAddress, userAddress) ⇒ Promise.<BigNumber>

Kind: instance method of Create
Returns: Promise.<BigNumber> - the user's 0x proxy allowance in wei for custom token

Example

const allowance = await create.getUserCustomAllowance("0x4f833a24e1f95d70f028921e27040ca56e09ab0b");

create.setProxyAllowanceCustom(tokenAddress, userAddress) ⇒ Promise.<string>

Kind: instance method of Create
Returns: Promise.<string> - the transaction hash of the resulting tx

Example

await create.setProxyAllowanceCustom("0x4f833a24e1f95d70f028921e27040ca56e09ab0b");