README
¶
Principal
Principal are generic identifiers for canisters and users.
Usage
raw, _ := hex.DecodeString("abcd01")
p := principal.Principal(raw)
fmt.Println(p.Encode())
// Output:
// em77e-bvlzu-aq
Special Forms
Opaque Identifiers
These are always generated by the system and have no structure of interest outside the system. Typically, these end with the byte 0x01.
Self-Authenticating Identifiers
An external user can use these ids as the sender of a request if they own the corresponding private key.
sha224(public_key) 0x02
Derived Identifiers
Derived IDs are currently not explicitly used, but they may be used internally or in the future.
sha224(len(registering_principal) registering_principal derivation_nonce) 0x03
Anonymous Identifiers
Used for the anonymous caller. It can be used in call and query requests without a signature.
Documentation
¶
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var AnonymousID = Principal{[]byte{0x04}}
AnonymousID is used for the anonymous caller. It can be used in call and query requests without a signature.
var (
DefaultSubAccount [32]byte
)
Functions ¶
This section is empty.
Types ¶
type AccountIdentifier ¶ added in v0.2.1
type AccountIdentifier [28]byte
func (AccountIdentifier) String ¶ added in v0.2.1
func (id AccountIdentifier) String() string
type Principal ¶
type Principal struct {
Raw []byte
}
Principal are generic identifiers for canisters, users and possibly other concepts in the future.
Example ¶
package main
import (
"encoding/hex"
"fmt"
"github.com/aviate-labs/principal-go"
)
func main() {
raw, _ := hex.DecodeString("abcd01")
p := principal.Principal{raw}
fmt.Println(p.Encode())
}
Output: em77e-bvlzu-aq
func Decode ¶
Decode converts a textual representation into a principal.
Example ¶
package main
import (
"fmt"
"github.com/aviate-labs/principal-go"
)
func main() {
p, _ := principal.Decode("em77e-bvlzu-aq")
fmt.Printf("%x", p.Raw)
}
Output: abcd01
func NewSelfAuthenticating ¶
NewSelfAuthenticating returns a self authenticating principal identifier based on the given public key.
func (Principal) AccountIdentifier ¶ added in v0.2.1
func (p Principal) AccountIdentifier(subAccount [32]byte) AccountIdentifier
Returns the account identifier corresponding with the given sub-account.
type SubAccount ¶ added in v0.2.1
type SubAccount [32]byte
Source Files