1.20.14 • Published 5 months ago

@ocap/client v1.20.14

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
5 months ago

graphql-client

styled with prettier docs Gitter

Client library to connect your app with forge powered blockchain node, all requests are sent over http/https, can be used in both Node.js and browser environment.

A GraphQLClient instance mainly supports 5 groups of methods that saves you time when read/write data from/to blockchain.

  • queries: query block/transaction/account/asset/chain/node data form the blockchain
  • mutations: send transaction to the blockchain, sendTx, all transactions should be signed before sending out to the blockchain
  • subscriptions: listen to changes of any data on the blockchain
  • senders: shortcut methods that takes a wallet and a tx object, then do the signing, and sending
  • encoders: shortcut methods that takes a wallet and a tx object, encode the transaction for later signing, used internally by senders

Table of Contents

Install

npm i @ocap/client -S
# OR
pnpm install @ocap/client

Usage

const Mcrypto = require('@ocap/mcrypto');
const GraphQLClient = require('@ocap/client');
const { fromRandom, WalletType } = require('@ocap/wallet');
const { hexToBytes } = require('@ocap/util');

const client = new GraphQLClient('http://localhost:8210/api');
console.log({
  queries: client.getQueries(),
  subscriptions: client.getSubscriptions(),
  mutations: client.getMutations(),
  senders: client.getTxSendMethods(),
  encoders: client.getTxEncodeMethods(),
});

(async () => {
  // Query chain state data
  const chainInfo = await client.getChainInfo();
  const forgeState = await client.getForgeState();
  const block = await client.getBlock({ height: 2 });
  console.log('getChainInfo', chainInfo);
  console.log('getForgeState', forgeState);
  console.log('getBlock', block);

  // Send transaction
  const wallet = fromRandom(
    WalletType({
      role: Mcrypto.types.RoleType.ROLE_ACCOUNT,
      pk: Mcrypto.types.KeyType.SECP256K1,
      hash: Mcrypto.types.HashType.SHA3,
    })
  );
  const hash = await client.declare({
    moniker: 'username',
    wallet,
  });
  console.log(hash);
})();

Examples

Debugging

  • If you are in Node.js: DEBUG=@ocap/client node script.js
  • If you are in browser: localStorage.setItem('DEBUG', '@ocap/client')

Documentation

  • Query arguments and response structure can be found here: QUERIES.md
  • Complete method list can be found here: README.md
1.19.0

10 months ago

1.19.4

9 months ago

1.19.3

9 months ago

1.19.2

10 months ago

1.19.1

10 months ago

1.19.8

9 months ago

1.19.7

9 months ago

1.19.6

9 months ago

1.19.5

9 months ago

1.19.9

9 months ago

1.19.12

8 months ago

1.19.13

8 months ago

1.19.10

8 months ago

1.19.11

8 months ago

1.19.16

7 months ago

1.19.17

7 months ago

1.19.14

8 months ago

1.19.15

8 months ago

1.19.18

7 months ago

1.19.19

7 months ago

1.20.10

5 months ago

1.20.11

5 months ago

1.20.12

5 months ago

1.20.13

5 months ago

1.20.14

5 months ago

1.19.20

6 months ago

1.19.21

6 months ago

1.20.1

6 months ago

1.20.2

6 months ago

1.20.0

6 months ago

1.20.5

6 months ago

1.20.6

6 months ago

1.20.3

6 months ago

1.20.4

6 months ago

1.20.9

5 months ago

1.20.7

6 months ago

1.20.8

6 months ago

1.18.159

11 months ago

1.18.158

11 months ago

1.18.157

11 months ago

1.18.156

11 months ago

1.18.155

11 months ago

1.18.154

11 months ago

1.18.153

11 months ago

1.18.152

11 months ago

1.18.151

11 months ago

1.18.150

11 months ago

1.18.149

11 months ago

1.18.148

11 months ago

1.18.147

11 months ago

1.18.146

11 months ago

1.18.145

11 months ago

1.18.144

11 months ago

1.18.143

11 months ago

1.18.142

11 months ago

1.18.140

11 months ago

1.18.166

10 months ago

1.18.165

10 months ago

1.18.164

10 months ago

1.18.163

10 months ago

1.18.162

10 months ago

1.18.161

10 months ago

1.18.160

11 months ago

1.18.139

12 months ago

1.18.138

12 months ago

1.18.137

12 months ago

1.18.136

12 months ago

1.18.135

1 year ago

1.18.134

1 year ago

1.18.133

1 year ago

1.18.132

1 year ago

1.18.131

1 year ago

1.18.130

1 year ago

1.18.129

1 year ago

1.18.128

1 year ago

1.18.127

1 year ago

1.18.126

1 year ago

1.18.125

1 year ago

1.18.124

1 year ago

1.18.123

1 year ago

1.18.122

1 year ago

1.18.121

1 year ago

1.18.120

1 year ago

1.18.119

1 year ago

1.18.118

1 year ago

1.18.117

1 year ago

1.18.116

1 year ago

1.18.115

2 years ago

1.18.114

2 years ago

1.18.113

2 years ago

1.18.112

2 years ago

1.18.111

2 years ago

1.18.110

2 years ago

1.18.109

2 years ago

1.18.108

2 years ago

1.18.107

2 years ago

1.18.106

2 years ago

1.18.105

2 years ago

1.18.104

2 years ago

1.18.103

2 years ago

1.18.85

2 years ago

1.18.89

2 years ago

1.18.88

2 years ago

1.18.87

2 years ago

1.18.86

2 years ago

1.18.92

2 years ago

1.18.91

2 years ago

1.18.90

2 years ago

1.18.96

2 years ago

1.18.95

2 years ago

1.18.94

2 years ago

1.18.93

2 years ago

1.18.99

2 years ago

1.18.98

2 years ago

1.18.97

2 years ago

1.18.102

2 years ago

1.18.101

2 years ago

1.18.100

2 years ago

1.18.81

2 years ago

1.18.80

2 years ago

1.18.84

2 years ago

1.18.83

2 years ago

1.18.82

2 years ago

1.18.78

2 years ago

1.18.77

2 years ago

1.18.79

2 years ago

1.18.70

3 years ago

1.18.74

3 years ago

1.18.73

3 years ago

1.18.72

3 years ago

1.18.71

3 years ago

1.18.76

2 years ago

1.18.75

2 years ago

1.18.63

3 years ago

1.18.62

3 years ago

1.18.61

3 years ago

1.18.60

3 years ago

1.18.67

3 years ago

1.18.66

3 years ago

1.18.65

3 years ago

1.18.64

3 years ago

1.18.69

3 years ago

1.18.68

3 years ago

1.18.52

3 years ago

1.18.51

3 years ago

1.18.56

3 years ago

1.18.55

3 years ago

1.18.54

3 years ago

1.18.53

3 years ago

1.18.59

3 years ago

1.18.58

3 years ago

1.18.57

3 years ago

1.18.41

3 years ago

1.18.40

3 years ago

1.18.45

3 years ago

1.18.44

3 years ago

1.18.43

3 years ago

1.18.42

3 years ago

1.18.49

3 years ago

1.18.48

3 years ago

1.18.47

3 years ago

1.18.46

3 years ago

1.18.38

3 years ago

1.18.37

3 years ago

1.18.39

3 years ago

1.18.50

3 years ago

1.18.30

3 years ago

1.18.34

3 years ago

1.18.33

3 years ago

1.18.32

3 years ago

1.18.31

3 years ago

1.18.36

3 years ago

1.18.35

3 years ago

1.18.27

3 years ago

1.18.28

3 years ago

1.18.23

3 years ago

1.18.22

3 years ago

1.18.21

3 years ago

1.18.20

3 years ago

1.18.26

3 years ago

1.18.25

3 years ago

1.18.24

3 years ago

1.18.16

3 years ago

1.18.15

3 years ago

1.18.14

3 years ago

1.18.19

3 years ago

1.18.18

3 years ago

1.18.17

3 years ago

1.18.1

3 years ago

1.18.0

3 years ago

1.18.5

3 years ago

1.18.4

3 years ago

1.18.3

3 years ago

1.18.2

3 years ago

1.18.9

3 years ago

1.18.8

3 years ago

1.18.7

3 years ago

1.18.6

3 years ago

1.17.22

3 years ago

1.17.21

3 years ago

1.17.20

3 years ago

1.17.23

3 years ago

1.18.12

3 years ago

1.18.11

3 years ago

1.18.10

3 years ago

1.18.13

3 years ago

1.17.15

3 years ago

1.17.14

3 years ago

1.17.13

3 years ago

1.17.12

3 years ago

1.17.19

3 years ago

1.17.18

3 years ago

1.17.17

3 years ago

1.17.16

3 years ago

1.16.17

3 years ago

1.16.16

3 years ago

1.17.11

3 years ago

1.17.10

3 years ago

1.17.2

3 years ago

1.17.1

3 years ago

1.17.0

3 years ago

1.17.6

3 years ago

1.17.5

3 years ago

1.17.4

3 years ago

1.17.3

3 years ago

1.17.9

3 years ago

1.17.8

3 years ago

1.17.7

3 years ago

1.16.10

3 years ago

1.16.14

3 years ago

1.16.13

3 years ago

1.16.12

3 years ago

1.16.15

3 years ago

1.16.7

3 years ago

1.16.6

3 years ago

1.16.5

3 years ago

1.16.9

3 years ago

1.16.8

3 years ago

1.6.10

3 years ago

1.15.0

4 years ago

1.15.4

4 years ago

1.15.3

4 years ago

1.15.2

4 years ago

1.15.1

4 years ago

1.15.7

4 years ago

1.15.6

4 years ago

1.15.5

4 years ago

1.16.3

4 years ago

1.16.2

4 years ago

1.16.1

4 years ago

1.16.0

4 years ago

1.16.4

4 years ago

1.14.20

4 years ago

1.14.21

4 years ago

1.14.22

4 years ago

1.14.23

4 years ago

1.14.24

4 years ago

1.14.25

4 years ago

1.13.77

4 years ago

1.13.76

4 years ago

1.13.79

4 years ago

1.13.78

4 years ago

1.13.80

4 years ago

1.13.86

4 years ago

1.13.85

4 years ago

1.13.82

4 years ago

1.13.81

4 years ago

1.13.84

4 years ago

1.13.83

4 years ago

1.14.1

4 years ago

1.14.0

4 years ago

1.14.5

4 years ago

1.14.4

4 years ago

1.14.3

4 years ago

1.14.2

4 years ago

1.14.9

4 years ago

1.14.8

4 years ago

1.14.7

4 years ago

1.14.6

4 years ago

1.14.10

4 years ago

1.14.11

4 years ago

1.14.12

4 years ago

1.14.17

4 years ago

1.14.18

4 years ago

1.14.19

4 years ago

1.14.13

4 years ago

1.14.14

4 years ago

1.14.15

4 years ago

1.14.16

4 years ago

1.13.75

4 years ago

1.13.74

4 years ago

1.13.71

4 years ago

1.13.70

4 years ago

1.13.73

4 years ago

1.13.72

4 years ago

1.13.64

4 years ago

1.13.63

4 years ago

1.13.66

4 years ago

1.13.65

4 years ago

1.13.60

4 years ago

1.13.62

4 years ago

1.13.61

4 years ago

1.13.68

4 years ago

1.13.67

4 years ago

1.13.69

4 years ago

1.13.57

4 years ago

1.13.56

4 years ago

1.13.59

4 years ago

1.13.58

4 years ago

1.13.53

4 years ago

1.13.52

4 years ago

1.13.55

4 years ago

1.13.54

4 years ago

1.13.51

4 years ago

1.13.50

4 years ago

1.13.49

4 years ago

1.13.48

4 years ago

1.13.47

4 years ago

1.13.46

4 years ago

1.13.31

4 years ago

1.13.30

4 years ago

1.13.33

4 years ago

1.13.32

4 years ago

1.13.39

4 years ago

1.13.38

4 years ago

1.13.35

4 years ago

1.13.34

4 years ago

1.13.37

4 years ago

1.13.36

4 years ago

1.13.28

4 years ago

1.13.29

4 years ago

1.13.42

4 years ago

1.13.41

4 years ago

1.13.44

4 years ago

1.13.40

4 years ago

1.13.45

4 years ago

1.13.27

4 years ago

1.13.26

4 years ago

1.13.25

4 years ago

1.13.22

4 years ago

1.13.24

4 years ago

1.13.23

4 years ago

1.13.21

4 years ago

1.13.20

4 years ago

1.13.19

4 years ago

1.13.18

4 years ago

1.13.17

4 years ago

1.13.16

4 years ago

1.13.15

4 years ago

1.13.14

4 years ago

1.13.13

4 years ago

1.13.11

4 years ago

1.13.12

4 years ago

1.13.9

4 years ago

1.13.10

4 years ago

1.13.6

4 years ago

1.13.8

4 years ago

1.13.7

4 years ago

1.13.5

4 years ago

1.13.4

4 years ago

1.13.2

4 years ago

1.13.1

4 years ago

1.13.0

4 years ago

1.13.3

4 years ago

1.12.9

4 years ago

1.12.8

4 years ago

1.12.7

4 years ago

1.12.6

4 years ago

1.12.5

4 years ago

1.11.20

4 years ago

1.12.3

4 years ago

1.12.2

4 years ago

1.12.1

4 years ago

1.12.0

4 years ago

1.12.4

4 years ago

1.11.19

4 years ago

1.11.18

4 years ago

1.11.16

4 years ago

1.11.17

4 years ago

1.11.15

4 years ago

1.11.14

4 years ago

1.11.13

4 years ago

1.11.12

4 years ago

1.11.10

4 years ago

1.11.11

4 years ago

1.11.9

4 years ago

1.11.8

4 years ago

1.11.7

4 years ago

1.11.6

4 years ago

1.11.5

4 years ago

1.11.4

4 years ago

1.11.3

4 years ago

1.11.2

4 years ago

1.11.1

4 years ago

1.11.0

4 years ago

1.10.24

4 years ago

1.10.22

4 years ago

1.10.23

4 years ago

1.10.21

4 years ago

1.10.20

4 years ago

1.10.9

4 years ago

1.10.8

4 years ago

1.10.7

4 years ago

1.10.15

4 years ago

1.10.16

4 years ago

1.10.13

4 years ago

1.10.14

4 years ago

1.10.11

4 years ago

1.10.12

4 years ago

1.10.10

4 years ago

1.10.19

4 years ago

1.10.17

4 years ago

1.10.18

4 years ago

1.10.6

4 years ago

1.10.5

4 years ago

1.10.4

4 years ago

1.10.3

4 years ago

1.10.2

4 years ago

1.9.21

4 years ago

1.9.20

4 years ago

1.9.19

4 years ago

1.9.18

4 years ago

1.9.17

4 years ago

1.9.16

4 years ago

1.9.15

4 years ago

1.9.14

4 years ago

1.9.13

4 years ago

1.9.12

4 years ago

1.9.11

4 years ago

1.9.10

4 years ago

1.9.9

4 years ago

1.9.8

4 years ago

1.9.7

4 years ago

1.9.6

4 years ago

1.9.5

4 years ago

1.9.4

4 years ago

1.9.3

5 years ago

1.9.2

5 years ago

1.10.1

4 years ago

1.10.0

4 years ago

1.9.1

5 years ago

1.9.0

5 years ago

1.8.42

5 years ago

1.8.40

5 years ago

1.8.41

5 years ago

1.8.39

5 years ago

1.8.38

5 years ago

1.8.37

5 years ago

1.8.36

5 years ago

1.8.32

5 years ago

1.8.33

5 years ago

1.8.34

5 years ago

1.8.35

5 years ago

1.8.31

5 years ago

1.8.30

5 years ago

1.8.24

5 years ago

1.8.25

5 years ago

1.8.26

5 years ago

1.8.27

5 years ago

1.8.28

5 years ago

1.8.29

5 years ago

1.8.23

5 years ago

1.8.22

5 years ago

1.8.20

5 years ago

1.8.21

5 years ago

1.8.19

5 years ago

1.8.18

5 years ago

1.8.17

5 years ago

1.8.14

5 years ago

1.8.15

5 years ago

1.8.16

5 years ago

1.8.13

5 years ago

1.8.9

5 years ago

1.8.10

5 years ago

1.8.11

5 years ago

1.8.12

5 years ago

1.8.8

5 years ago

1.8.7

5 years ago

1.8.6

5 years ago

1.8.4

5 years ago

1.8.2

5 years ago

1.8.1

5 years ago

1.8.0

5 years ago

1.7.9

5 years ago

1.7.10

5 years ago

1.7.8

5 years ago

1.7.7

5 years ago

1.7.6

5 years ago

1.7.5

5 years ago

1.8.3

5 years ago

1.7.4

5 years ago

1.7.3

5 years ago

1.7.2

5 years ago

1.7.1

5 years ago

1.7.0

5 years ago

1.6.5

5 years ago

1.6.4

5 years ago

1.6.3

5 years ago

1.6.2

5 years ago

1.6.1

5 years ago