Skip to content
[BOS:escrow.bos] An escrow contract designed for paying worker proposals.
Assembly C++ WebAssembly Makefile Ruby CMake
Branch: master
Clone or download
Pull request Compare This branch is 50 commits ahead, 1 commit behind eosdac:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
include
permissions
resources
src
tests
.gitignore
Gemfile
Gemfile.lock
LICENSE
README.md
build.sh
escrow.abi
escrow.wasm

README.md

BOS escrow

An escrow contract designed for paying worker proposals. The intention is that the authority for this account would be nulled.

Original source code was gratefully authored by eosDAC.

Quickstart

Init Escrow

Only bet.bos@active can init an escrow. This will initialize the escrow between the sender & receiver.

$ eosc tx create escrow.bos init '{"sender":"bet.bos","receiver":"<RECEIVER>","approver":"eosio","escrow_name":"<NAME>","expires_at":"2019-09-15T00:00:00","memo":"BOS escrow"}' -p bet.bos

Fund/Initialize Escrow

BOS funds must be transfer into the escrow.bos account before starting another escrow

$ eosc transfer bet.bos escrow.bos "100.0000 BOS" -m "Fund BOS escrow" -p bet.bos

Approve Escrow

Only bet.bos@active or eosio@active are allowed to be the approver if approver is bet.bos, no change, allow proposer to claim 100% of the fund if approver is BPs, only keep 90% fund for proposer to claim, and BET.BOS will manually execute transfer ACTION in escrow.bos to send fund to each BPs and each auditors

$ eosc tx create escrow.bos approve '{"escrow_name":"<NAME>","approver":"eosio"}' -p eosio

Claim Escrow

Executing claim will complete the escrow process and transfer the BOS tokens to the receiver. Anyone can execute the claim action.

$ eosc tx create escrow.bos claim '{"escrow_name":"<NAME>"}' -p <ACCOUNT>

Caveats

  • The sender of an escrow will temporarily be whitelisted to BOS executives. In the future anyone may be a sender
  • The sender may only have one unfilled escrow at any given time, however they may have many filled escrows
  • To fill an escrow the sender must transfer the BOS tokens to this contract. An unfilled escrow will be filled
  • The receiver is considered as always approving the escrow. An approval must come from either the sender or the approver
  • The sender may only cancel an escrow that has not been filled
  • The sender may only refund an escrow that has passed it's expiry
  • Unapprove only removes an existing approval, if the action is made before the receiver uses the claim action
  • A sender may extend the expiry but not shorten it
  • The approver may change extend or shorten the expiry
  • The approver may close an escrow. This is essentially the same as refunding it, however without waiting for the expiry to lapse
  • The approver may Lock and Unlock an escrow. This prevents ALL actions except unlock and actions made by the approver.

init

ACTION: init

PARAMETERS:

  • sender is an eosio account name.
  • receiver is an eosio account name.
  • approver is an eosio account name.
  • escrow_name unique escrow name.
  • expires The date/time after which the escrow amount can be refunded by the sender.
  • memo is a memo to send as the eventual transfer memo at the end of the escrow contract.

INTENT: The intent of init is to create an empty escrow payment agreement for safe and secure funds transfer protecting both sender and receiver for a determined amount of time.

Warning: This action will store the content on the chain in the history logs and the data cannot be deleted later so therefore should only store a unidentifiable hash of content rather than human readable content.

transfer

ACTION: transfer

PARAMETERS:

  • from is an eosio account name.
  • to is an eosio account name.
  • quantity is an eosio asset name.
  • memo is a string that provides a memo for the transfer action.

INTENT: The intent of transfer is to listen and react to the eosio.token contract's transfer action and ensure the correct parameters have been included in the transfer action.

Warning: This action will store the content on the chain in the history logs and the data cannot be deleted later.

approve

ACTION: approve

PARAMETERS:

  • escrow_name is a unique identifying name for an escrow entry.
  • approver is an eosio account name. (BET Account)

INTENT: The intent of approve is to approve the release of funds to the intended receiver. Each escrow agreement requires at least 7 BET permissions (excluding sender) to grant fund release.

Warning: This action will store the content on the chain in the history logs and the data cannot be deleted later.

unapprove

ACTION: unapprove

PARAMETERS:

  • escrow_name is a unique identifying name for an escrow entry.
  • disapprover is an eosio account name.

INTENT: The intent of unapprove is to unapprove the release of funds to the intended receiver from a previous approved action.

Warning: This action will store the content on the chain in the history logs and the data cannot be deleted later.

claim

ACTION: claim

PARAMETERS:

  • escrow_name is a unique identifying name for an escrow entry.

INTENT: The intent of claim is to claim the escrowed funds for an intended receiver after an escrow agreement has met the required approvals.

TERM: This action lasts for the duration of the time taken to process the transaction.

refund

ACTION: refund

PARAMETERS:

  • escrow_name is a unique identifying name for an escrow entry.

INTENT: The intent of refund is to return the escrowed funds back to the original sender. This action can only be run after the contract has met the intended expiry time.

TERM: This action lasts for the duration of the time taken to process the transaction.

cancel

ACTION: cancel

PARAMETERS:

  • escrow_name is a unique identifying name for an escrow entry.

INTENT: The intent of cancel is to cancel an escrow agreement. This action can only be performed by the sender as long as no funds have already been transferred for the escrow agreement. Otherwise they would need to wait for the expiry time and then use the refund action.

TERM: This action lasts for the duration of the time taken to process the transaction.

clean

ACTION: clean

INTENT: The intent of clean is remove all existing escrow agreements for developer purposes. This can only be run with _self permission of the contract which would be unavailable on the main net once the contract permissions are removed for the contract account.

TERM: This action lasts for the duration of the time taken to process the transaction.

extend

ACTION: extend

PARAMETERS:

  • escrow_name is a unique identifying name for an escrow entry.
  • expires_at timestamp to set when escrow will expire

INTENT: Allows the sender to extend the expiry

close

ACTION: close

PARAMETERS:

  • escrow_name is a unique identifying name for an escrow entry.

INTENT: Allows the approver to close and refund an unexpired escrow

lock

ACTION: lock

PARAMETERS:

  • escrow_name is a unique identifying name for an escrow entry.
  • lock boolean to set escrow locked attribute as true/false

INTENT: Allows the approver to lock an escrow preventing any actions by sender or receiver.

You can’t perform that action at this time.