v2.0.0

Changed

• (helpers) BREAKING: getPeriodByBlockHeight API returns a single object instead of array (#171)

Fixed

• (period) BREAKING: wrong name for validator address attribute in period opts (#172)

Breaking Changes

• (helpers) getPeriodByBlockHeight API now returns a single object instead of array (#171)
• (period) validatorOpts argument of Period constructor should include validatorAddress instead of ownerAddress (#172)

v1.0.0

Changed

• (period) BREAKING: include previous period hash into period inclusion proofs. This is default now and thus proofs for older periods will change. If you need to regenerate proof for old (legacy) periods, you can provide { excludePrevHashFromProof: true } object as a third argument to Period constructor (see below) (#166)
• (helpers) third argument of getProof changed from fallbackValidatorData to period options object (see below). Useful for older periods which the nodes has no period data for and for periods you want to regenerate the old proof for (#166)

Fixed

• (tx) allow NFTs and NSTs with "0" value. Needed to solve the bigger issue in the node: leapdao/meta#205 (#169)

Added

• (period) optional third constructor argument with period options (#166):

  type PeriodOptions = {
   validatorData?: {
     slotId: number;
     validatorAddress: string | Buffer | number;
     casBitmap?: string | Buffer | number; 
   };
   excludePrevHashFromProof?: Boolean;
  };

  validatorData — validator data to use for this period in case there is no validator data available on the nodes. If not specified and no data on the node, error will be thrown.
  excludePrevHashFromProof — whether to skip including previous period hash in a period proof. Defaults to false — the prev period hash will be included (breaking change).

Upgrading from 0.37+ to 1.0.0:

• getProof third argument structure should be changed (see above)
• use { excludePrevHashFromProof: true } as a third constructor argument for Period if you need the period to yield the same proof as it was before at some point (see above)

v0.39.0

Changed

• (fast exits): emit signed exit transfer tx details before signing an exit message (#164)

Fixed

• Period.proof throwing incorrect error when tx is not in the period. (#163)

v0.38.0

Added

• allow to specify period data fallback for getProof helper #161

Fixed

• getUnspent(address) returns data only for color 0

v0.37.0

Added

• new transaction type EPOCH_LENGTH_V2 (15). Requires epochLength:number and blockHeight:number. Needed to keep transactions unique. #155

Changed

• Tx.epochLength factory method now requires extra blockHeight:number param. To create a legacy epoch length transaction use Tx.epochLengthV1 (discouraged though) #155

BREAKING CHANGES

• Tx.epochLength factory method now requires extra blockHeight:number param. To create a legacy epoch length transaction use Tx.epochLengthV1 (discouraged though) #155

v0.36.1

Fixed

• add Period.periodBlockRange to typedef (#151)

v0.36.0

Changed

• BREAKING CHANGE: getColors() RPC helper now returns all the colors instead of only erc20 (#145)

Added

• getColors RPC helper now supports ERC721 and ERC1948 (#145):

  // erc20 + erc721 + erc1948
  plasma.getColors()
  
  // erc721
  plasma.getColors('erc20')
  
  // erc721
  plasma.getColors('erc721')
  
  // erc1948
  plasma.getColors('erc1948')
  

v0.35.2

• calcInputs allow to cap number of inputs

v0.35.1

Changed

• getUnspent in five flavours. One-stop shop for all your UTXO needs. You can query utxos by token address instead of color now (should be supported by the network). See docs

v0.35.0

Added

• new RPC helper getPeriodDataByBlockHeight added to both ExtendedWeb3 and LeapEthers #134
  Signature as follows:

  getPeriodByBlockHeight(blockHeight: number): Promise<PeriodData>

Fixed

• correct sighash structure for PeriodVote tx (#132)

Changed

• helpers.getProof fetches CAS data automatically #134
• deprecate helpers.calcInputs. Use Tx.calcInputs instead #135
• deprecate helpers.calcOutputs . Use Tx.calcOutputs instead #135
• deprecate helpers.periodBlockRange . Use Period. periodBlockRange instead #135
• deprecate helpers.consolidateUTXOs. Use Tx.consolidateUTXOs instead #135

Breaking Changes

BREAKING CHANGE: helpers.getProof method signature no longer supports passing in slotId and validatorAddress #134