Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PrimLabs/ICSP
InternetComputerStorageProtocol
https://github.com/PrimLabs/ICSP
Last synced: 3 months ago
JSON representation
InternetComputerStorageProtocol
- Host: GitHub
- URL: https://github.com/PrimLabs/ICSP
- Owner: PrimLabs
- License: apache-2.0
- Created: 2022-04-26T15:22:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-13T09:28:26.000Z (over 2 years ago)
- Last Synced: 2024-01-26T10:34:12.468Z (10 months ago)
- Language: Motoko
- Size: 156 KB
- Stars: 19
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-motoko - motoko-ICSP - Internet Computer Storage Protocol. This lib supports many features, such as auto-scale storage, HTTP Redirect, cycle monitor and top up self automatically. (Applications / Storage)
README
# **Internet Computer Storage Protocol**(**ICSP**)
- Autoscaling Storage
- Self Cycle Monitor
- One step store, two steps get
# Description
### Pain Points:
* Currently a Canister only has a limited amount of storage space, and when the storage space is full, the Canister needs to have the ability to automatically create new storage space. There is currently no such infrastructure to help developers do this.
* At present, the memory of Canister is divided into Stable memory and Run-time memory. The use of run-time memory is related to the upgrade ability of Canister. When the Run-time memory of Canister is too large, the canister can not be upgraded, and results in a reduced performance of Canister services or a failure to provide a better quality of service.
* There is currently no best practice for using both Stable memory and Runtime memory, and the ICSP offers a data analysis and real world test case.
### Technical features of ICSP:
1. Infinite Capacity ICSP Canister: read and write to the same Canister without having to worry about storage space.
* Explanation:
* infinite capacity refers to the infinite creation of the Canister contract (in the case of a sufficient Cycle) , which supports the automatic creation of the Canister when the storage Canister is full and does not block the creation of data writes, smooth and smooth switching of storage destination.
2. Support CRUD(only support read and write at current version)
* Explanation:
* in the business, supports the data to add, delete and check four operations, and in the related operations on the memory of the appropriate optimization, to support the reuse of fragmented memory(Next Version).
3. One Step Store Data and Two Steps Get Data
* Explanation:
* One-step storage: support back-end direct: ignore await store the key and value into ICSP Canister. When store (key, value) , do not have to wait for the return value, which creates the convenience of storage.
* Two-step get : first obtain from the ISP which storage unit is stored in, and then obtain metadata from that storage unit(bucket).
4. Cycle automatic monitoring
* Explanation:
* ICSP Heartbeat actively triggers the monitoring of ICSP and storage monomer Cycle balances and automatically Top Up, so the user only needs to monitor the ISP's ICP balances.
### Advantages of ICSP:
* Data acqtion speed, IC storage base for RAM (memory) storage, from the acqtion of data efficiency, will be faster than the ROM (hard disk)-based storage base.
* Support for HTTP and Certificated Data, that is, direct access to consensus and signed Data via HTTP, or direct access to Data on nodes via HTTP (faster, status equivalent to that of a centralized server node)
* Support Programming: you can modify and delete data directly in the contract, and through the contract access restrictions, authorized access, to support more diverse forms of data distribution.
# RoadMap
- ~~Q2 MVP Version Release : 0.01~~
- Q2 :
- Support HTTP Request and Response
- Q3 :
- Support Certified Http Header
- Support Candid Types
# Service Interface
## ICSP Canister
```motoko
// get storage bucket from key
get : query (key : Text) -> async Result.Result;
// get current buckets
getBuckets : query() -> async (LiveBucketExt, [Principal]);
// store key & value into bucket
store : shared(args : StoreArgs) -> async ();
```
## Bucket Canister
```motoko
// get value from key
get : query (key : Text) -> async Result.Result;
// store key and value
store : shared(args : StoreArgs) -> async ();
```
# Usage
1. Deploy the ICSP Canister
2. call iscp init()
```shell
dfx canister call icsp init
```
# Architecture
