@arcadeum/encoder

Encoding tools for Arcadeum Meta-Transaction Relayer

Usage

Token encoder

⚠️ encoding only works for implementations of ERC-1155 that conforms to the multi-token-standard (MTS) specification

Meta-transactions nonces are used to protect users against replay attacks, MTS implementation keeps next available nonce contract side (reference)

import {
  TokenEncoder,
  MetaSafeBatchTransferFrom,
  MetaTxnOpts
} from 'arcadeum.js'

const encoder = new TokenEncoder(
  CONTRACT_ADDRESS, //'0x123...0'
  WALLET_OR_SIGNER //ethers.Signer
)

// see MTS spec for more meta-tx methods and params types
const call: MetaSafeBatchTransferFrom = {
  type: 'metaSafeBatchTransferFrom',
  params: [receiver, ids, amounts]
}

const options: MetaTxnOpts = {
  nonce: 1,
  gasReceipt: null,
  extra: null
}

const input = await encoder.encode(call, options)

// relayers can now use encoded input to execute meta-tx
await relayer.sendMetaTxn({
  call: {
    contract: CONTRACT_ADDRESS,
    input
  }
})

Niftyswap encoder

Niftyswap Specification

⚠️ encoding only works for token pairs that uses implementations of ERC-1155 that conforms to the multi-token-standard (MTS) specification

import { NiftyswapEncoder } from 'arcadeum.js'

const encoder = new NiftyswapEncoder(
  NIFTYSWAP_EXCHANGE_ADDRESS, //'0x123...0'
  BASE_CURRENCY_CONTRACT_ADDRESS, //'0x123...0'
  ASSET_CONTRACT_ADDRESS, //'0x123...0'
  WALLET_OR_SIGNER //ethers.Signer
)

const buyOrderEncoding: NiftyswapBuy = {
  type: 'buy',
  recipient: RECIPIENT_ADDRESS,
  transferIds: BASE_CURRENCY_TOKEN_ID,
  transferAmounts: TOTAL_ORDER_COST,
  tokenIdsToBuy: ASSET_IDS,
  tokensAmountsToBuy: ASSET_AMOUNTS,
  deadline: ORDER_DEADLINE
}

const sellOrderEncoding: NiftyswapSell = {
  type: 'sell',
  recipient: RECIPIENT_ADDRESS,
  transferIds: ASSET_IDS,
  transferAmounts: ASSET_AMOUNTS,
  cost: TOTAL_ORDER_COST,
  deadline: ORDER_DEADLINE
}

const buyOrder = await encoder.encode(buyOrderEncoding, txNonce)
const sellOrder = await encoder.encode(sellOrderEncoding, txNonce)

// relayers can now use encoded input to execute meta-tx
await relayer.sendMetaTxn({
  call: {
    contract: CONTRACT_ADDRESS,
    input: buyOrder
  }
})

Universal encoder

TODO: universal txn-relayer and encoding that works with generic contracts without native meta-tx support

License

Copyright (c) 2018-present Horizon Blockchain Games Inc.