You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Predko Silvestr 8afeda1259
Merge pull request #88 from Relayz-io/silvestr/exchange-protocol
2 years ago
.github/workflows Implement exchange protocol that is used by key-exchange-server * Split codebase to different source files * Modified integration test 2 years ago
common-api Fix clippy lint issues 2 years ago
example Upgrade example accordingly to the protocol changes 2 years ago
near-primitives-light Fix clippy lint issues 2 years ago
near-rpc Implement exchange protocol that is used by key-exchange-server * Split codebase to different source files * Modified integration test 2 years ago
web-client Implement exchange protocol that is used by key-exchange-server * Split codebase to different source files * Modified integration test 2 years ago
.dockerignore Add /pkg to docker ignore 2 years ago
.gitignore Rename js-client to example 2 years ago
Cargo.toml Add near-primitives-light instead of an near-primitives 2 years ago
Dockerfile Implement exchange protocol that is used by key-exchange-server * Split codebase to different source files * Modified integration test 2 years ago
README.md Add CI badge to README 2 years ago
docker-compose.yml Update a Docker file for new integration tests 2 years ago

README.md

CI

Client

Common-API 🦆

Library that is used among other repositories. Implements Borsh implementation for structures and enums. Also contain Diffie-Hellman and Ed25519 API

Near-Client 🗿

Client library for Near RPC

Web-Client 🦘

Client library for communication from browser and Near blockchain. It’s a high-level API. User doesn’t need to understand how blockchain works.

Build

wasm-pack build web-client --target bundler --out-dir ../pkg

Test

Pre requirements: Clone a key-exchange-server and near-smartcontracts. Deploy their docker instances:

⚠️ Please keep the order(near-smartcontracts depends on the key-exchange-server network)

  1. key-exchange-server: bash docker-compose up -d
  2. near-smartcontracts: bash docker-compose -f docker-compose.yml -f docker-compose.tests.yml up -d

Then:

docker-compose up

Diagrams

sequenceDiagram
    participant Initiator
    participant Alice
    participant Bob

    Initiator->>Blockchain: create meeting with id
    Initiator-->>Internet: share meeting Id
    loop
        Initiator->>Blockchain: wait for pub. key for Alice and Bob
        activate Blockchain
        Blockchain--)Initiator: receive pub key [Alice, Bob]
        deactivate Blockchain
    end
    par
        Bob->>Internet: get meeting id
        activate Internet
        Internet--)Bob: receive meeting id
        deactivate Internet
    and
        Alice->>Internet: get meeting id
        activate Internet
        Internet--)Alice: receive meeting id
        deactivate Internet
    end
    par
        Bob->>Blockchain: put temp public key for Bob
        activate Blockchain
        Blockchain--)Bob: Initiator public key
        deactivate Blockchain
    and
        Alice->>Blockchain: put temp public key for Alice
        activate Blockchain
        Blockchain--)Alice: Initiator public key
        deactivate Blockchain
    end
    Initiator-->>RelayServer: Olm message(symetric key) by Bob pub key
    RelayServer-->>Bob: Olm message(symetric key) by Bob pub key
    Initiator-->>RelayServer: Olm message(symetric key) by Alice pub key
    RelayServer-->>Alice: Olm message(symetric key) by Alice pub key