hedgey-sdk v6.0.3

Hedgey SDK

Contains utilities and helpers used by the hedgey frontend apps.

Installation

To install the latest version run:

npm install hedgey-sdk --save

Modules

v2.streamVestingNft

Table of contents

Functions

• createBatch
• createLockedBatch
• createLockedNFT
• delegateAllNFTs
• delegateTokens
• redeemAllNFTs
• redeemNFTs
• revokeNFTs

Functions

createBatch

createBatch(web3, contractAddress, batchVesterContractAddress, sender, recipients, token, amounts, starts, cliffs, rates, vestingAdmin, mintType, safeDetails, timeout?): Promise<TransactionResult>

Create a batch of locked NFTs with a vesting schedule

Parameters

Returns

Promise<TransactionResult>

The transaction result

Defined in

src/v2/stream.vesting.nft.ts:147

createLockedBatch

createLockedBatch(web3, contractAddress, batchVesterContractAddress, sender, recipients, token, amounts, starts, cliffs, rates, vestingAdmin, unlockDates, transferableNFTLocker, mintType, safeDetails, timeout?): Promise<TransactionResult>

Create a batch of locked vesting NFTs

Parameters

Returns

Promise<TransactionResult>

The transaction result

Defined in

src/v2/stream.vesting.nft.ts:258

createLockedNFT

createLockedNFT(web3, contractAddress, sender, recipient, token, amount, start, cliffDate, rate, vestingAdmin, unlockDate, transferableNFTLocker, safeDetails, timeout?): Promise<TransactionResult>

Create a locked NFT with a vesting schedule

Parameters

Returns

Promise<TransactionResult>

The transaction result

Defined in

src/v2/stream.vesting.nft.ts:37

delegateAllNFTs

delegateAllNFTs(web3, accountAddress, delegateAddress, contractAddress, safeDetails, timeout?): Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Parameters

Returns

Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Defined in

src/v2/stream.vesting.nft.ts:392

delegateTokens

delegateTokens(web3, accountAddress, delegateAddress, contractAddress, tokenIds, safeDetails, timeout?): Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Parameters

Returns

Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Defined in

src/v2/stream.vesting.nft.ts:411

redeemAllNFTs

redeemAllNFTs(web3, accountAddress, contractAddress, safeDetails, timeout?): Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Parameters

Returns

Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Defined in

src/v2/stream.vesting.nft.ts:375

redeemNFTs

redeemNFTs(web3, contractAddress, accountAddress, tokenIds, safeDetails, timeout?): Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Parameters

Returns

Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Defined in

src/v2/stream.vesting.nft.ts:432

revokeNFTs

revokeNFTs(web3, accountAddress, contractAddress, tokenIds, safeDetails, timeout?): Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Parameters

Returns

Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Defined in

src/v2/stream.vesting.nft.ts:356

v2.streamBoundNft

Table of contents

Functions

• createNFT
• delegateAllNFTs
• delegateTokens
• redeemAllNFTs
• redeemNFTs

Functions

createNFT

createNFT(web3, contractAddress, sender, recipient, token, amount, start, cliffDate, rate, safeDetails, timeout): Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Parameters

Returns

Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Defined in

src/v2/stream.bound.nft.ts:13

delegateAllNFTs

delegateAllNFTs(web3, accountAddress, delegateAddress, contractAddress, safeDetails, timeout?): Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Parameters

Returns

Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Defined in

src/v2/stream.bound.nft.ts:42

delegateTokens

delegateTokens(web3, accountAddress, delegateAddress, contractAddress, tokenIds, safeDetails, timeout?): Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Parameters

Returns

Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Defined in

src/v2/stream.bound.nft.ts:61

redeemAllNFTs

redeemAllNFTs(web3, accountAddress, contractAddress, safeDetails, timeout?): Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Parameters

Returns

Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Defined in

src/v2/stream.bound.nft.ts:82

redeemNFTs

redeemNFTs(web3, contractAddress, accountAddress, tokenIds, safeDetails, timeout?): Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Parameters

Returns

Promise<{ pending: boolean = false; safeTransaction: undefined = undefined; timeout: boolean = false; transactionHash: any = results.transactionHash } | { pending: boolean = true; safeTransaction: any = results.safeTxHash; timeout: boolean = false; transactionHash: undefined = undefined }>

Defined in

src/v2/stream.bound.nft.ts:99

common

isHedgeyContract

isHedgeyContract(appId, address): Promise<boolean>

Checks the passed address to see if it is a hedgey contract address

Parameters

Returns

Promise<boolean>

A boolean, true if the address matches on of the configured hedgey contracts

Defined in

src/common/index.ts:106

V2

Utils

Functions

• prepareAmounts
• prepareHolders
• prepareUnlockDates

Functions

prepareAmounts

prepareAmounts(amount, periods, frequency, decimals?): string[]

Prepare an array of amounts

Parameters

Returns

string[]

An array of amounts represented as strings

Defined in

src/v2/utils.ts:39

prepareHolders

prepareHolders(periods, frequency, recipientAddress): string[]

Prepare an array of recipients

Parameters

Returns

string[]

An array of holders represented as strings

Defined in

src/v2/utils.ts:63

prepareUnlockDates

prepareUnlockDates(firstUnlockDate, periods, frequency): string[]

Prepare an array of unlock dates

Parameters

Returns

string[]

An array of dates represented as epoch strings

Defined in

src/v2/utils.ts:13

Type Aliases

DistributeResult

DistributeResult: Object

The return type for the Token Distribution

Type declaration

Defined in

src/v2/token.distribution.ts:21

SafeDetails

SafeDetails: Object

Safe details if the Token Distribution is a gnosis safe

Type declaration

Defined in

src/v2/token.distribution.ts:30

Functions

distribute

distribute(web3, batchMintContractAddress, nftContractAddress, tokenAddress, recipientAddress, amount, firstUnlockDate, frequency, sender, periods?, safeDetails?): Promise<DistributeResult>

Creates a Token Distribution

Parameters

Returns

Promise<DistributeResult>

The transaction hash or safe transaction hash

Defined in

src/v2/token.distribution.ts:54

SafeDetails

SafeDetails: Object

Type declaration

Defined in

src/v2/token.distribution.ts:21

Functions

distribute

distribute(web3, batchMintContractAddress, nftContractAddress, tokenAddress, recipientAddress, amount, firstUnlockDate, frequency, sender, periods?, safeDetails?): Promise<DistributeResult>

Parameters

Returns

Promise<DistributeResult>

Defined in

src/v2/token.distribution.ts:29

Safe

ApprovalStatusDetails

ApprovalStatusDetails: Object

Type declaration

Defined in

src/safe/index.ts:16

Functions

approvalStatus

approvalStatus(chainId, safeAddress, contractAddress, token, allowance): Promise<ApprovalStatusDetails>

Returns the approval status from a gnosis safe, if there is an approval transaction queued the details will be returned

Parameters

Returns

Promise<ApprovalStatusDetails>

The approval details if there is an approval transaction queued

Defined in

src/safe/index.ts:33

pendingTransactionSubmitted

pendingTransactionSubmitted(chainId, safeAddress, contractAddress, method): Promise<TransactionDetails[]>

Checks a pending transaction exists in a safe, for a transaction using the method name

Parameters

Returns

Promise<TransactionDetails[]>

A boolean, true if a pending transaction exists

Defined in

src/safe/index.ts:42

OTC

batchMintNFTs

batchMintNFTs(web3, address, contractAddress, nftContractAddress, mintingDetails): Promise<any>

Parameters

Returns

Promise<any>

Defined in

src/otc/index.ts:261

buyDeal

buyDeal(web3, address, deal, positionSize): Promise<Transaction>

Buy a deal

Parameters

Returns

Promise<Transaction>

A promise for the on chain request

Defined in

src/otc/index.ts:67

cancelDeal

cancelDeal(web3, address, contractAddress, dealIndex): Promise<Transaction>

Cancels an open deal

Parameters

Returns

Promise<Transaction>

The resulting transaction

Defined in

src/otc/index.ts:105

createDeal

createDeal(web3, address, deal): Promise<Transaction>

Creates an OTC deal

Parameters

Returns

Promise<Transaction>

The transaction details

Defined in

src/otc/index.ts:20

getLockedTokenDetails

getLockedTokenDetails(web3, contractAddress, walletAddress, contractVersion): Promise<any[]>

Returns the details of the token locked within the NFT

Parameters

Returns

Promise<any[]>

An array of token details

Defined in

src/otc/index.ts:235

getNFTBalance

getNFTBalance(web3, address, contractAddress, contractVersion): Promise<any>

Returns the number of NFTs in the selected network

Parameters

Returns

Promise<any>

The balance value

Defined in

src/otc/index.ts:217

listDeals

listDeals(web3, contractAddress): Promise<any[]>

List all deals in the contract

Parameters

Returns

Promise<any[]>

An array of deals

Defined in

src/otc/index.ts:300

loadNFTs

loadNFTs(web3, ownerAddress, contractAddress, balance, contractVersion): Promise<{ contract: string ; index: number ; metadata: NFTMetaData }[]>

Returns the meta data for NFTs belonging to the owner address

Parameters

Returns

Promise<{ contract: string ; index: number ; metadata: NFTMetaData }[]>

A list of metadata for NFTs belonging to the owner address

Defined in

src/otc/index.ts:174

redeemNFT

redeemNFT(web3, address, contractAddress, index, contractVersion): Promise<any>

Redeem the NFT

Parameters

Returns

Promise<any>

The result of calling the contract

Defined in

src/otc/index.ts:150

transferNFT

transferNFT(web3, address, contractAddress, index, toAddress, contractVersion): Promise<any>

Transfer the NFT

Parameters

Returns

Promise<any>

The result of calling the contract

Defined in

src/otc/index.ts:126

Treasury Pools

approveToken

approveToken(web3, address, hedgeyAddress, erc20Address, approvalAmount?): Promise<string>

Gets approval for hedgey to spend from the selected account on behalf of the user

Parameters

Returns

Promise<string>

• The transaction hash for the approval transaction

Defined in

src/treasurypools/index.ts:81

buyOption

buyOption(web3, address, option, positionSize): Promise<Transaction>

Calls the relevant hedgey smart contract to buy an option

Parameters

Returns

Promise<Transaction>

A promise that resolves to the completed transaction

Defined in

src/treasurypools/index.ts:100

cancelOpenOrder

cancelOpenOrder(web3, address, option): Promise<boolean>

Calls the relevant hedgey cancel smart contract to cancel an open option

Parameters

Returns

Promise<boolean>

A promise that resolves to true if the contract method was successful

Defined in

src/treasurypools/index.ts:197

exerciseOption

exerciseOption(web3, address, option, cashClose?): Promise<Transaction>

Excercises the option

Parameters

Returns

Promise<Transaction>

A promise that resolves to the completed transaction

Defined in

src/treasurypools/index.ts:246

findBestAMM

findBestAMM(web3, type, network, assetAddress, paymentAddress): Promise<MarketMaker>

Returns the best market maker

Parameters

Returns

Promise<MarketMaker>

A promise that resolves to a MarketMaker

Defined in

src/treasurypools/index.ts:358

getAMMExchangeRate

getAMMExchangeRate(web3, option): Promise<BigNumber>

Get automated market maker exchange rate, calls relevant smart contract to return exchange rate

Parameters

Returns

Promise<BigNumber>

Returns the estimated rate

Defined in

src/treasurypools/index.ts:300

getBalance

getBalance(web3, address, decimals?, erc20Address?): Promise<BigNumber>

Gets the balance of the users selected account from the web3 wallet

Parameters

Returns

Promise<BigNumber>

The balance of the users selected account

Defined in

src/treasurypools/index.ts:26

getERC20ContractInfo

getERC20ContractInfo(web3, erc20Address): Promise<TokenInformation>

Returns token information for the ERC20 token

Parameters

Returns

Promise<TokenInformation>

A promise that resolves to the token information object

Defined in

src/treasurypools/index.ts:323

hasApprovals

hasApprovals(web3, address, hedgeyAddress, erc20Address, approvalAmount?): Promise<boolean>

Checks if hedgey is approved to spend from the selected account on behalf of the user

Parameters

Returns

Promise<boolean>

A boolean value, true if the address has approval

Defined in

src/treasurypools/index.ts:51

launchNewPair

launchNewPair(web3, address, factoryAddress, assetAddress, paymentAddress): Promise<Transaction>

Creates a new currency pair

Parameters

Returns

Promise<Transaction>

A promise that resolves to the completed transaction

Defined in

src/treasurypools/index.ts:433

returnExpired

returnExpired(web3, address, option, indices): Promise<Transaction>

Returns the expired tokens to the user wallet

Parameters

Returns

Promise<Transaction>

A promise that resolves to the completed transaction

Defined in

src/treasurypools/index.ts:284

setPrice

setPrice(web3, address, option, newPrice, tradeable?): Promise<any>

Sets the price on an open option

Parameters

Returns

Promise<any>

A promise that resolves to true if the contract method was successful

Defined in

src/treasurypools/index.ts:224

switchChain

switchChain(network): Promise<boolean>

Swtich chain to a new network

Parameters

Returns

Promise<boolean>

A promise that resolves to true on a successful switch

Defined in

src/treasurypools/index.ts:461

writeOption

writeOption(web3, address, pair, option): Promise<Transaction>

Calls the relevant hedgey smart contract to create a new option

Parameters

Returns

Promise<Transaction>

A promise that resolves to the completed transaction

Defined in

src/treasurypools/index.ts:154

Hedgey common

addTokenToWallet

addTokenToWallet(web3, network): Promise<any>

Prompts the user to add the network base token to their wallet

Parameters

Returns

Promise<any>

The transaction promise

Defined in

src/common/index.ts:62

estimateGas

estimateGas(web3, contract, from, method, params, value?): Promise<{ gasEstimation: null | number ; gasPrice: null | string }>

Estimates the cost of gas

Parameters

Returns

Promise<{ gasEstimation: null | number ; gasPrice: null | string }>

The gas price and gas estimation amount

Defined in

src/common/index.ts:15

wrapTokens

wrapTokens(web3, assetAmount, wrappedTokenAddress, address): Promise<TransactionReceipt>

Will wrap the network token

Parameters

Returns

Promise<TransactionReceipt>

The transaction promise

Defined in

src/common/index.ts:45