Giter VIP home page Giter VIP logo

actus-spec's Introduction

ACTUS Specification version 2

This is a second version of the ACTUS specification. It is intended to be the new "source of truth". Where previous specifications have been inconsistent and ambiguous, this specification aims to be unambiguous and consistent.

Status of this document

The purpose of this document in its current form is to show what a new version of a specification could look like and how it could be constructed. It is not sound, complete, or authoritative.

If this new way of specifying is adopted, this specification will be completed, corrected, and updated before becoming authoritative.

Consistency

Consistency across multiple media can only be constructed or enforced.

As such we make the parts of the spec that can be machine-readible available in .json files. We construct the specification (pdf) to be consistent with that data by generating the parts of the specification that represent the same information.

Writing

Dependencies

With Nix

  1. Install Nix

That's it, Nix handles the rest.

Without Nix

  1. Install Typst
  2. Ignore the mentions of direnv and feedback below.

Feedback loop

  1. Enter the dev shell

    With direnv:

    direnv allow
    

    Without direnv:

    Nix develop
    
  2. Start the feedback loop:

    Pure typst (faster):

    typst watch spec/main.typ
    open spec/main.pdf
    

    With feedback:

    feedback build
    

actus-spec's People

Contributors

csvdb avatar

Watchers

Matthew Doty avatar Chloe Kever avatar Mark A. Greenslade avatar Pavel Burylichev avatar  avatar Morgan Thomas avatar Avi Dessauer avatar

actus-spec's Issues

Formal Verification

This pathway to be driven internally in collaboration with University of Cambridge.

Serialisation Formats

Minimum viable required implementation independent formats:

  • binary
  • json

Former is relevant within ZKP context. Latter in over the wire contexts.

Serialization strictness is non-negotiable

It should be impossible to serialise/deserialise invalid termsets.

Note: Java implementation currently has many bugs in this respect, i.e. they skip "deserialisation" errors.

Spec must specify handling of more granular time than days

The current spec, and Java implementations use a full ISO 8601 timestamp, but the logic of the shift conventions, day count conventions, and cycles does not handle hours or seconds at all.

Almost all timestamps in ACTUS tests fall at YYYY-MM-DDT00:00:00.
We have no clarity on how the conventions should handle business hours.
What about daylight savings? How would a cycle of hourly interest payments work? Is it unsupported?

Testing framework

Commitment to cross SDK testing framework. Each SDK is tested via the framework in isolation. Furthermore the framework will handle inter-dk testing.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.