filecoin 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51d924d8ec129371f94374405e003a802de0b7952fdeb9ae8eec0df93ed4f2f1
-  data.tar.gz: d3f27b9ee0a0a5b252d6523740be7d3fb2302a89ea528503e9081f7cbcb7d328
+  metadata.gz: 7159b291af21ca88add75488b10ac6700be6abbbde528b04aa880efa208ba480
+  data.tar.gz: 21f88799b03a576802cb03bd00b1680615c86b5fb2557b68bbe1fb729c0f8fc2
 SHA512:
-  metadata.gz: a6021bf20aa984240b5839418aa29913007e40889f9dbbae25ec9a1a84a74577ba771fe6b9ad548f9312b7088cf957f3f6ec5d8643168a364e876ef64e6ecad3
-  data.tar.gz: d893ffd092e50be52cd458eb0e277897df5305ce670d0134da287a62cf658afd39e8f6dec200e66920dde56b86e53ec29117ce223b916d26488f8b35957610ad
+  metadata.gz: 5d719cd23a5178285a70ffc2589fa14fe56c39aefed45cef6398faa5a7d7b6271ea7e2d6bac21ed89b1234f48bcdabe293dbce1b7d540f3863e221ccaeefb102
+  data.tar.gz: 5d6d6a5e5c81ce3fab7373edf35c9d2a2e69784f7f512043a8508ea1e3c501fafb5fdff5e8565dc63f43689c8524bb52936af98f85c18c2816c4d71e0599b66f

data/CHANGELOG.md

@@ -10,6 +10,19 @@ The format is based on [Keep a Changelog], and this project adheres to
 Unreleased
 ----------
 
+_Coming soon_
+
+
+v0.4.0 - 2020-09-18
+-------------------
+
+- Add support `Filecoin.StateMinerPower` without any miner information, to
+  obtain the network's aggregate mining power.
+
+
+v0.3.0 - 2020-07-07
+-------------------
+
 - Add optional argument to extract the deal CID automatically from the response
   when submitting a proposal;
 - Make wallet for deal proposals optional, falling back on the configured

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    filecoin (0.3.0)
+    filecoin (0.4.0)
       dry-struct (~> 1.0)
 
 GEM
@@ -25,7 +25,7 @@ GEM
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
-    dry-logic (1.0.6)
+    dry-logic (1.0.7)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)

data/README.md

@@ -12,7 +12,7 @@ Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "filecoin", "~> 0.2.0"
+gem "filecoin", "~> 0.3.0"
 ```
 
 And then execute:
@@ -86,313 +86,8 @@ All methods return the server's JSON parsed response as a plain `Hash`.
 - [x] `Filecoin.ClientStartDeal`
 - [x] `Filecoin.NetPeers`
 
-
-### Filecoin.ChainHead
-
-Returns the current head of the chain.
-
-```ruby
-Filecoin.chain_head
-```
-
-```json
-{
-  "jsonrpc": "2.0",
-  "result": {
-    "Cids": [
-      {
-        "/": "bafy2bzaceabs2fnv5xehoibdik3bp3flze3v3mbxdprsu2yt5urpz3sd4sysk"
-      }
-    ],
-    "Blocks": [
-      {
-        "Miner": "t01100",
-        "Ticket": {
-          "VRFProof": "koRyPdBso5iROYfkkLLS8BbkYkziPmao/DJsVTGWRC7gHz/RPSKG/LCjvcOylI+IEzCghQAHantaG96rUAwc5m08FBhYp9/zx/eZSce42ktfIGfO6lF1ymya3Tlzn2Xd"
-        },
-        "ElectionProof": {
-          "VRFProof": "qMwlLzao8BJn38wJ5/kxcorBNr1IGMpOedLYHV7y7g71vK5suKHIZsC66jtxvCLdFlqWKGsgBifbJkAo38NIPCD4cTiDBz5J3PzDLVAy8f0x3JV7BoaQVmmUr57BCiG+"
-        },
-        "BeaconEntries": [
-          {
-            "Round": 125398,
-            "Data": "hRPhxVhoujTf7wZoZ4zk/bucunZeEpF5Oi7O1Es1gnnYNBzHlesNhZ8GHfjsULTHFvOVngrawT5Y3P5u7sx2f7ysVfuh16jo1CFJu3KSFfilBXCmjRCKG6rC6KRhQVMO"
-          }
-        ],
-        "WinPoStProof": [
-          {
-            "RegisteredProof": 15,
-            "ProofBytes": "srmO6BOqe4lEh4RbVybhkEtH3wDV4QFl/h599QG3K5DZN2yZF77gy0Apaybjr/UgqUVoPPELOkW7HcZLLgSRXwbQ6dmKPnb5rC58ucK4tcab5tKbz6xk3jjoYkHC8tbjEETOmRYlOyvYFSmkkRbdT0aixosSRiecQv94SyiSTWwZ2hNrnDW6tsbqNd8WGTqCjbhvMvHFxFATXv2xu8ndQ+YjYrpuaY/HRz3NfLq0Gj1niqXawkAw2UgKh4aod79A"
-          }
-        ],
-        "Parents": [
-          {
-            "/": "bafy2bzacec6osar3i62fr3u4dlw4bxns3sc4ycipjbo4u6u4tbgh6f7hwhypi"
-          },
-          {
-            "/": "bafy2bzaceblqc4nzzneqg5sd5ik23jnt77fhizm7mqj5ulcyxwlu6p7cftoam"
-          }
-        ],
-        "ParentWeight": "1584010805",
-        "Height": 99565,
-        "ParentStateRoot": {
-          "/": "bafy2bzacecolsvk4s2pn7eeso7eobseqxs2x6vkkcenjyd6ikbk4hanmmr6oe"
-        },
-        "ParentMessageReceipts": {
-          "/": "bafy2bzaced3qvpgmcwl4qyxq2rwgmeduqhtnhdunwdisvyejup7vcqxi5cor2"
-        },
-        "Messages": {
-          "/": "bafy2bzaceavnr75wltzlp5eqi4er7u2f5c4halukuetqk2vmbqd7ltcms5cjs"
-        },
-        "BLSAggregate": {
-          "Type": 2,
-          "Data": "sXWOH7SeDDQeMTKIBewRGdNYlRGPchtj2iJlXNwZrRV/ukmlcl2yLA24fQhNy1lDDlKNZ+juGq6TyhYGimRMLCaAjCc50jfxOGEk1+uTpxb3QzxknpopWoDHEhCpPz59"
-        },
-        "Timestamp": 1591983325,
-        "BlockSig": {
-          "Type": 2,
-          "Data": "krAlrTcpd3QFNETCn2sTsXuqlIHCsmwss+iUziCE/F6mVs6UxZ/f43uyHjKRBojwFZRJKsdZV3JWfg+HrWcj51x5qBAwNwReCCOpJUBwEbLcdrUDyrGIzJ203g6r6YS7"
-        },
-        "ForkSignaling": 0
-      }
-    ],
-    "Height": 99565
-  },
-  "id": 3
-}
-```
-
-
-### Filecoin.ClientGetDealInfo
-
-Get the information on a specific deal.
-
-```ruby
-Filecoin.client_get_deal_info("bafyreigc4b4fqsval4pjmfncaqdezhe5y3anwavjyzpj4mar73e6n7mvj4")
-```
-
-```json
-{
-  "jsonrpc": "2.0",
-  "result": {
-    "ProposalCid": {
-      "/": "bafyreigc4b4fqsval4pjmfncaqdezhe5y3anwavjyzpj4mar73e6n7mvj4"
-    },
-    "State": 5,
-    "Message": "",
-    "Provider": "t0239463",
-    "PieceCID": {
-      "/": "bafk4chzaw4zjxdl3d6vd7shbr23ps4nygl77ywogasvzskvn7jszur3tpetq"
-    },
-    "Size": 2080768,
-    "PricePerEpoch": "500000000",
-    "Duration": 1492,
-    "DealID": 2725
-  },
-  "id": 3
-}
-```
-
-
-#### Understanding Deal State
-
-The state of a deal has a numerical value which links it to a constant in the
-Filecoin Lotus client. At the time of writing, these states are
-([source][states]):
-
-| Value | State                    | Description |
-| :---: | :---                     | :--- |
-| 0     | Unknown                  | Status of the deal is undefined. |
-| 1     | Not found                | Deal can not be located. |
-| 2     | Proposal rejected        | Storage miner chose not to accept this deal proposal. |
-| 3     | Proposal accepted        | Storage miner chose to accept this deal proposal. |
-| 4     | Staged                   | Deal has been published and data is ready to be put into a sector. |
-| 5     | Sealing                  | Deal is in sector that's being sealed. |
-| 6     | Active                   | Deal is in a sealed sector and the miner is providing proofs for this deal. |
-| 7     | Expired                  | Deal has passed its final epoch and is expired. |
-| 8     | Slashed                  | Deal was in a sector that got slashed from failing to produce proofs. |
-| 9     | Failing                  | Something has gone wrong in the deal. Data is being cleaned. |
-| 10    | Funds ensured            | The funds necessary to create the deal have been deposited. |
-| 11    | Waiting for data request | Client is waiting for provider to request the deal data. |
-| 12    | Validating               | Storage provider is validating whether the deal parameters are good for a proposal. |
-| 13    | Waiting for acceptance   | Storage provider is running some custom decision logic to decide whether to accept the deal. |
-| 14    | Transferring             | Data is being sent from the client to the storage provider. |
-| 15    | Waiting for data         | Deal is for a manual data transfer, or the storage provider has not yet received a request to transfer data from the client. |
-| 16    | Verifying data           | Data has been transferred and the storage provider is verifying it against the provided piece CID. |
-| 17    | Ensure provider funds    | Storage provider is making sure it has adequate funds for the deal. |
-| 18    | Ensure client funds      | Client is making sure it has adequate funds for the deal. |
-| 19    | Provider is funding      | Storage provider has deposited funds and is waiting for funds to show up in balance. |
-| 20    | Client is funding        | Client has deposited funds and is waiting for funds to show up in balance. |
-| 21    | Publish                  | Deal is ready to be published on chain. |
-| 22    | Publishing               | Deal has been published, currently waiting for it to appear on chain. |
-| 23    | Error                    | Deal has failed due to an error, no further updates will occur. |
-| 24    | Completed                | Deal is active and information for retrieval is recorded. |
-
-The lifecycle of a deal is slightly different from the point-of-view of the
-client (the node proposing a deal) and the miner. Please refer to [the
-storage market technical documentation] for up-to-date diagrams.
-
-This gem provides an abstraction in `Filecoin::Deals::State` of the **client
-deal lifecycle** reducing them to 4 general states for general deal
-health-checks and tracking.
-
-<table>
-  <thead>
-    <tr>
-      <th>Abstract State</th>
-      <th>Description</th>
-      <th>Positive States</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td>Pending</td>
-      <td>Deal has been proposed and is pending acceptance or rejection.</td>
-      <td>
-        <ul>
-          <li>Ensure client funds</li>
-          <li>Client is funding</li>
-          <li>Funds ensured</li>
-          <li>Waiting for data</li>
-          <li>Transferring</li>
-          <li>Validating</li>
-        </ul>
-      </td>
-    </tr>
-    <tr>
-      <td>Good</td>
-      <td>Deal has been accepted and is active or on its way to become active.</td>
-      <td>
-        <ul>
-          <li>Proposal accepted</li>
-          <li>Sealing</li>
-          <li>Active</li>
-        </ul>
-      </td>
-    </tr>
-    <tr>
-      <td>Bad</td>
-      <td>Something has gone wrong with the deal and it is now invalid.</td>
-      <td>
-        <ul>
-          <li>Failing</li>
-          <li>Error</li>
-        </ul>
-      </td>
-    </tr>
-    <tr>
-      <td>Finished</td>
-      <td>The deal has followed its natural course and is no longer active.</td>
-      <td>
-        <ul>
-          <li>Slashed</li>
-          <li>Expired</li>
-        </ul>
-      </td>
-    </tr>
-  </tbody>
-</table>
-
-To make use of this abstraction, initialize `Filecoin::Deal` with the result
-of `Filecoin.ClientGetDealInfo`.
-
-```ruby
-response = Filecoin.client_get_deal_info("bafyreigc4b4fqsval4pjmfncaqdezhe5y3anwavjyzpj4mar73e6n7mvj4")
-deal = Filecoin::Deal.new(response["result"])
-```
-
-
-### Filecoin.ClientQueryAsk
-
-```ruby
-Filecoin.client_query_ask(
-  # ID of the peer to query
-  "0003KooWBhDJkzmK1QKQqp7hRDAA9cLBNsneaYn2TBGdUSKXzoc8",
-  # ID of the miner to query about
-  "t1234567",
-)
-```
-
-
-### Filecoin.ClientStartDeal
-
-This method requires the aid of some type classes due to the complex structure
-of the payload. Make use of `Filecoin::Types::DataRef` to represent the data to
-transfer for this deal, and then pass it on to
-`Filecoin::Types::StartDealParams` to describe the deal to propose.
-
-If successful, the response contains the CID of the proposed deal. Use
-`Filecoin.ClientGetDealInfo` to query the network about its evolution.
-
-```ruby
-data_ref = Filecoin::Types::DataRef.new(
-  # (Optional) Define how the data will be transferred. Must be "graphsync" or
-  # "manual". Defaults to "graphsync".
-  transfer_type: "manual",
-  # CID of the file to transfer
-  root: "bafkreicomazccnbsql4nvtp6jfrk5qwys63ktakp4hkdt3ncl2hvhemwde",
-  # (Optional) Piece CID. Required for "manual" transfer deals.
-  piece_cid: "bafk4chzak7ieup5a3aup2vzavfzlnmbxxx4bpi3kpykhbkn4cdemdmk3aeaa",
-  # (Optional) Piece size. Required for "manual" transfer deals.
-  piece_size: 532_676_608,ClientGetDealInfo
-)
-
-start_deal_params = Filecoin::Types::StartDealParams.new(
-  # Description of the data the deal refers to
-  data: data_ref,
-  # Address of the wallet in the node to use to pay for the deal
-  # (optional if `Filecoin.config.default_wallet` is set)
-  wallet: "t13nqjc55m3h327646cwcu4lchdx4lkw7ccxnx4ca",
-  # Address ot the miner to whom this deal is to be proposed
-  miner: "t1234567",
-  # Price per block in attoFIL to propose for this deal
-  epoch_price: 500_000_000,
-  # (Optional) Duration of the deal in blocks
-  min_blocks_duration: 1572,
-  # (Optional) Unix timestamp stating the moment the deal starts
-  deal_start_epoch: 1591979600,
-)
-
-Filecoin.client_start_deal(start_deal_params, extract_response: false)
-```
-
-```json
-{
-  "jsonrpc": "2.0",
-  "result": {
-    "/": "bafyreihdss5rlzmft3lzez2n5jyxqo5znhewdvpbcnhbnairkc2yl6zk6e"
-  },
-  "id": 3
-}
-```
-
-This method accepts an optional keyword argument `extract_response`. If truthy,
-the method returns the deal CID directly, or `nil`, instead of the JSON RPC
-full response. Defaults to `false`.
-
-
-### Filecoin.NetPeers
-
-Get the peers the node is connected to.
-
-```ruby
-Filecoin.net_peers
-```
-
-```json
-{
-  "jsonrpc": "2.0",
-  "result": [
-    {
-      "Addrs": [
-        "/ip4/54.212.151.167/tcp/40817"
-      ],
-      "ID": "12D3KooWGBxkba5Havy4wiGvLVmqPBCPjs7xPQPtqNr1HRq6RaVM"
-    }
-  ],
-  "id": 3
-}
-```
+For more information on each supported method, check
+[the wiki](https://github.com/subvisual/filecoin-ruby/wiki/Supported-Methods).
 
 
 Development
@@ -444,8 +139,6 @@ filecoin-ruby was created and is maintained with :heart: by
 
 [Filecoin Node API]: https://github.com/filecoin-project/lotus/blob/master/api/api_full.go
 [permissions]: https://lotu.sh/en+api#what-authorization-level-should-i-use-21853
-[states]: https://github.com/filecoin-project/go-fil-markets/blob/master/storagemarket/dealstatus.go
-[the storage market technical documentation]: https://github.com/filecoin-project/go-fil-markets/tree/master/storagemarket#technical-documentation
 [license]: ./LICENSE.txt
 [rubygems.org]: https://rubygems.org
 [subvisual]: http://subvisual.com

data/lib/filecoin/client/node.rb

@@ -1,4 +1,5 @@
 require "filecoin/types/cid"
+require "filecoin/types/power_claim"
 
 module Filecoin
   class Client
@@ -32,6 +33,16 @@ module Filecoin
       def net_peers
         json_rpc_call "Filecoin.NetPeers"
       end
+
+      def state_power(extract_response: false)
+        response = json_rpc_call "Filecoin.StateMinerPower", nil, nil
+
+        if extract_response
+          Types::PowerClaim.from_as_json(response.dig("result", "TotalPower"))
+        else
+          response
+        end
+      end
     end
   end
 end

data/lib/filecoin/types/power_claim.rb

@@ -0,0 +1,23 @@
+module Filecoin
+  module Types
+    class PowerClaim
+      module ClassMethods
+        def from_as_json(as_json)
+          new(
+            quality_adjusted_power: Integer(as_json["QualityAdjPower"]),
+            raw_byte_power: Integer(as_json["RawBytePower"]),
+          )
+        end
+      end
+
+      extend ClassMethods
+
+      # raw_byte_power: Sum of raw byte power for a miner's (or of all miners') sectors
+      # quality_adjusted_power: Sum of quality adjusted power for a miner's (or of all miners') sectors.
+      def initialize(quality_adjusted_power:, raw_byte_power:)
+        @quality_adjusted_power = quality_adjusted_power
+        @raw_byte_power = raw_byte_power
+      end
+    end
+  end
+end

data/lib/filecoin/version.rb

@@ -1,3 +1,3 @@
 module Filecoin
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filecoin
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Pedro Costa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -68,6 +68,7 @@ files:
 - lib/filecoin/types.rb
 - lib/filecoin/types/cid.rb
 - lib/filecoin/types/data_ref.rb
+- lib/filecoin/types/power_claim.rb
 - lib/filecoin/types/start_deal_params.rb
 - lib/filecoin/version.rb
 homepage: https://github.com/subvisual/filecoin-ruby